Method: documents.annotateText

Eine praktische Methode, die alle Funktionen in einem einzigen Aufruf zur Verfügung stellt: analyzeSentiment, analyzeEntities und analyzeSyntax.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "document": {
    object (Document)
  },
  "features": {
    object (Features)
  },
  "encodingType": enum (EncodingType)
}
Felder
document

object (Document)

Pflichtangabe. Das Eingabedokument.
features

object (Features)

Pflichtangabe. Die aktivierten Funktionen.
encodingType

enum (EncodingType)

Der von der API verwendete Codierungstyp zum Berechnen von Offsets.

Antworttext

Die Antwortnachricht für Textanmerkungen.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "sentences": [
    {
      object (Sentence)
    }
  ],
  "tokens": [
    {
      object (Token)
    }
  ],
  "entities": [
    {
      object (Entity)
    }
  ],
  "documentSentiment": {
    object (Sentiment)
  },
  "language": string,
  "categories": [
    {
      object (ClassificationCategory)
    }
  ],
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ]
}
Felder
sentences[]

object (Sentence)

Die Sätze im Eingabedokument. Wird ausgefüllt, wenn der Nutzer AnnotateTextRequest.Features.extract_syntax aktiviert.
tokens[]

object (Token)

Die Tokens mit ihren syntaktischen Informationen im Eingabedokument. Wird ausgefüllt, wenn der Nutzer AnnotateTextRequest.Features.extract_syntax aktiviert.
entities[]

object (Entity)

Die Entitäten mit ihren semantischen Informationen im Eingabedokument. Wird ausgefüllt, wenn der Nutzer AnnotateTextRequest.Features.extract_entities aktiviert.
documentSentiment

object (Sentiment)

Die allgemeine Stimmung für das Dokument. Wird ausgefüllt, wenn der Nutzer AnnotateTextRequest.Features.extract_document_sentiment aktiviert.
language

string

Die Sprache des Textes, die entweder mit der in der Anfrage angegebenen Sprache identisch ist oder automatisch erkannt wird, falls in der Anfrage keine Sprache angegeben ist. Weitere Informationen finden Sie im Feld Document.language.
categories[]

object (ClassificationCategory)

Die im Eingabedokument identifizierten Kategorien.
moderationCategories[]

object (ClassificationCategory)

Schädliche und sensible Kategorien, die im Eingabedokument erkannt wurden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.

Features

Alle verfügbaren Funktionen für Sentimentanalyse, Syntaxanalyse und semantische Analyse. Wenn Sie die einzelnen Werte auf "true" setzen, wird die entsprechende Analyse für die Eingabe aktiviert.

JSON-Darstellung 
{
  "extractSyntax": boolean,
  "extractEntities": boolean,
  "extractDocumentSentiment": boolean,
  "extractEntitySentiment": boolean,
  "classifyText": boolean,
  "moderateText": boolean,
  "classificationModelOptions": {
    object (ClassificationModelOptions)
  }
}
Felder
extractSyntax

boolean

Extrahiert Syntaxinformationen.
extractEntities

boolean

Extrahiert Entitäten.
extractDocumentSentiment

boolean

Extrahiert die Stimmung auf Dokumentebene.
extractEntitySentiment

boolean

Extrahiert Entitäten und die assoziierte Stimmung.
classifyText

boolean

Klassifiziert das gesamte Dokument in Kategorien.
moderateText

boolean

Moderieren Sie das Dokument auf schädliche und sensible Kategorien.
classificationModelOptions

object (ClassificationModelOptions)

Optional. Die Modelloptionen, die für die Klassifizierung verwendet werden sollen. Wenn keine Angabe gemacht wird, werden die Optionen für Version 1 verwendet. Wird nur verwendet, wenn classifyText auf „wahr“ gesetzt ist.