Method: documents.annotateText

Metode praktis yang menyediakan semua fitur dalam satu panggilan.

Permintaan HTTP

POST https://language.googleapis.com/v2/documents:annotateText

URL menggunakan sintaks gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "document": {
    object (Document)
  },
  "features": {
    object (Features)
  },
  "encodingType": enum (EncodingType)
}
Kolom
document

object (Document)

Wajib. Dokumen input.
features

object (Features)

Wajib. Fitur yang diaktifkan.
encodingType

enum (EncodingType)

Jenis encoding yang digunakan oleh API untuk menghitung offset.

Isi respons

Pesan respons anotasi teks.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "sentences": [
    {
      object (Sentence)
    }
  ],
  "entities": [
    {
      object (Entity)
    }
  ],
  "documentSentiment": {
    object (Sentiment)
  },
  "languageCode": string,
  "categories": [
    {
      object (ClassificationCategory)
    }
  ],
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ],
  "languageSupported": boolean
}
Kolom
sentences[]

object (Sentence)

Kalimat dalam dokumen input. Diisi jika pengguna mengaktifkan AnnotateTextRequest.Features.extract_document_sentiment.
entities[]

object (Entity)

Entitas, beserta informasi semantiknya, dalam dokumen input. Diisi jika pengguna mengaktifkan AnnotateTextRequest.Features.extract_entities atau AnnotateTextRequest.Features.extract_entity_sentiment.
documentSentiment

object (Sentiment)

Keseluruhan sentimen untuk dokumen. Diisi jika pengguna mengaktifkan AnnotateTextRequest.Features.extract_document_sentiment.
languageCode

string

Bahasa teks, yang akan sama dengan bahasa yang ditentukan dalam permintaan atau, jika tidak ditentukan, bahasa yang terdeteksi secara otomatis. Lihat kolom [Document.language][] untuk mengetahui detail selengkapnya.
categories[]

object (ClassificationCategory)

Kategori yang diidentifikasi dalam dokumen input.
moderationCategories[]

object (ClassificationCategory)

Kategori berbahaya dan sensitif yang diidentifikasi dalam dokumen input.
languageSupported

boolean

Apakah bahasa tersebut secara resmi didukung oleh semua fitur yang diminta. API mungkin masih menampilkan respons jika bahasa tidak didukung, tetapi berdasarkan upaya terbaik.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-language
  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

Fitur

Semua fitur yang tersedia. Menetapkan setiap setelan ke benar akan mengaktifkan analisis spesifik tersebut untuk input.

Representasi JSON 
{
  "extractEntities": boolean,
  "extractDocumentSentiment": boolean,
  "classifyText": boolean,
  "moderateText": boolean
}
Kolom
extractEntities

boolean

Opsional. mengekstrak entity,
extractDocumentSentiment

boolean

Opsional. Mengekstrak sentimen tingkat dokumen.
classifyText

boolean

Opsional. Klasifikasikan dokumen lengkap ke dalam kategori.
moderateText

boolean

Opsional. Moderasi dokumen untuk kategori berbahaya dan sensitif.