Method: documents.annotateText

Metode praktis yang menyediakan semua fitur sintaksis, sentimen, entity, dan klasifikasi dalam satu panggilan.

Permintaan HTTP

POST https://language.googleapis.com/v1beta2/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. Masukkan dokumen.

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)
    }
  ],
  "tokens": [
    {
      object (Token)
    }
  ],
  "entities": [
    {
      object (Entity)
    }
  ],
  "documentSentiment": {
    object (Sentiment)
  },
  "language": string,
  "categories": [
    {
      object (ClassificationCategory)
    }
  ],
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ]
}
Kolom
sentences[]

object (Sentence)

Kalimat dalam dokumen input. Diisi jika pengguna mengaktifkan AnnotateTextRequest.Features.extract_syntax.

tokens[]

object (Token)

Token, beserta informasi sintaksisnya, dalam dokumen input. Diisi jika pengguna mengaktifkan AnnotateTextRequest.Features.extract_syntax.

entities[]

object (Entity)

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

documentSentiment

object (Sentiment)

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

language

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.

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 untuk analisis sentimen, sintaksis, dan semantik. Menetapkan setiap setelan ke benar akan mengaktifkan analisis spesifik tersebut untuk input.

Representasi JSON
{
  "extractSyntax": boolean,
  "extractEntities": boolean,
  "extractDocumentSentiment": boolean,
  "extractEntitySentiment": boolean,
  "classifyText": boolean,
  "moderateText": boolean,
  "classificationModelOptions": {
    object (ClassificationModelOptions)
  }
}
Kolom
extractSyntax

boolean

Mengekstrak informasi sintaksis.

extractEntities

boolean

mengekstrak entity,

extractDocumentSentiment

boolean

Mengekstrak sentimen tingkat dokumen.

extractEntitySentiment

boolean

Mengekstrak entity dan sentimen terkaitnya.

classifyText

boolean

Klasifikasikan dokumen lengkap ke dalam kategori. Jika ini benar, API akan menggunakan model default yang diklasifikasikan ke dalam taksonomi standar.

moderateText

boolean

Moderasi dokumen untuk kategori berbahaya dan sensitif.

classificationModelOptions

object (ClassificationModelOptions)

Opsional. Opsi model yang akan digunakan untuk klasifikasi. Jika tidak ditentukan, setelan defaultnya adalah opsi v1. Hanya digunakan jika classifyText ditetapkan ke benar.