Method: documents.annotateText

Eine praktische Methode, die alle Funktionen in einem Aufruf bietet.

HTTP-Anfrage

POST https://language.googleapis.com/v2/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)
    }
  ],
  "entities": [
    {
      object (Entity)
    }
  ],
  "documentSentiment": {
    object (Sentiment)
  },
  "languageCode": string,
  "categories": [
    {
      object (ClassificationCategory)
    }
  ],
  "moderationCategories": [
    {
      object (ClassificationCategory)
    }
  ],
  "languageSupported": boolean
}
Felder
sentences[]

object (Sentence)

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

object (Entity)

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

object (Sentiment)

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

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.
languageSupported

boolean

Ob die Sprache offiziell von allen angeforderten Funktionen unterstützt wird. Die API kann auch dann eine Antwort zurückgeben, wenn die Sprache nicht unterstützt wird. Dies geschieht jedoch nur auf Best-Effort-Basis.

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. Wenn Sie die einzelnen Werte auf "true" setzen, wird die entsprechende Analyse für die Eingabe aktiviert.

JSON-Darstellung 
{
  "extractEntities": boolean,
  "extractDocumentSentiment": boolean,
  "classifyText": boolean,
  "moderateText": boolean
}
Felder
extractEntities

boolean

Optional. Entitäten extrahieren.
extractDocumentSentiment

boolean

Optional. Extrahiert die Stimmung auf Dokumentebene.
classifyText

boolean

Optional. Klassifiziert das gesamte Dokument in Kategorien.
moderateText

boolean

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