REST Resource: documents

Ressource: Document

Stellt die Eingabe für API-Methoden dar.

JSON-Darstellung 
{
  "type": enum (Type),
  "language": string,
  "referenceWebUri": string,
  "boilerplateHandling": enum (BoilerplateHandling),

  // Union field source can be only one of the following:
  "content": string,
  "gcsContentUri": string
  // End of list of possible types for union field source.
}
Felder
type

enum (Type)

Pflichtangabe. Wenn der Typ nicht festgelegt wurde oder TYPE_UNSPECIFIED ist, wird der Fehler INVALID_ARGUMENT zurückgegeben.
language

string

Die Sprache des Dokuments (falls nicht angegeben, wird die Sprache automatisch erkannt). Sowohl ISO- als auch BCP-47-Sprachcodes sind zulässig.
Unter Sprachunterstützung finden Sie eine Liste der aktuell unterstützten Sprachen für jede API-Methode. Wenn die Sprache (entweder vom Aufrufer angegeben oder automatisch erkannt) von der aufgerufenen API-Methode nicht unterstützt wird, wird der Fehler INVALID_ARGUMENT zurückgegeben.
referenceWebUri

string

Die Web-URI, von der das Dokument stammt. Dieser URI wird nicht zum Abrufen des Inhalts, sondern als Hinweis für die Analyse des Dokuments verwendet.
boilerplateHandling

enum (BoilerplateHandling)

Gibt an, wie erkannte Textbausteine(z.B. Werbung, Urheberrechtserklärungen, Banner) für dieses Dokument behandelt werden sollen. Wenn nichts angegeben ist, wird der Text wie der Inhalt behandelt.
Union-Feld source. Die Quelle des Dokuments: ein String mit dem Inhalt oder ein Google Cloud Storage-URI. Für source ist nur einer der folgenden Werte zulässig:
content

string

Der Inhalt der Eingabe im Stringformat. Cloud-Audit-Logs sind ausgenommen, da sie auf Nutzerdaten basieren.
gcsContentUri

string

Der Google Cloud Storage-URI, in dem sich der Dateiinhalt befindet. Dieser URI muss das Format gs://bucketName/object_name haben. Weitere Informationen finden Sie unter https://cloud.google.com/storage/docs/reference-uris. HINWEIS: Cloud Storage-Objektversionierung wird nicht unterstützt.

Typ

Die Enum der Dokumententypen.

Enums
TYPE_UNSPECIFIED Der Inhaltstyp ist nicht angegeben.
PLAIN_TEXT Nur Text
HTML HTML

BoilerplateHandling

Möglichkeiten zum Umgang mit im Dokument erkanntem Boilerplate

Enums
BOILERPLATE_HANDLING_UNSPECIFIED Die Standardtext-Verarbeitung ist nicht angegeben.
SKIP_BOILERPLATE Gefundene Textbausteine werden nicht analysiert. Der Referenz-Web-URI ist zum Erkennen von Textbausteinen erforderlich.
KEEP_BOILERPLATE Textbausteine wie Inhalte behandeln

Methoden

analyzeEntities

 Sucht benannte Entitäten (derzeit Eigennamen und Gattungsnamen) im Text zusammen mit Entitätstypen, Auffälligkeiten, Erwähnungen für jede Entität und anderen Eigenschaften.

analyzeEntitySentiment

 Hiermit werden Entitäten gefunden, die dem Begriff AnalyzeEntities im Text ähneln. Anschließend wird das Sentiment analysiert, das mit den einzelnen Entitäten und ihren Erwähnungen verknüpft ist.

analyzeSentiment

 Analysiert die Stimmung des jeweiligen Textes.

analyzeSyntax

 Analysiert die Syntax des Textes, liefert Satzgrenzen und ermöglicht die Vergabe eines Tokens zusammen mit Wortart-Tags, Abhängigkeitsstrukturen und anderen Eigenschaften.

annotateText

 Eine praktische Methode, die alle Syntax-, Stimmungs-, Entitäts- und Klassifizierungsfunktionen in einem Aufruf zur Verfügung stellt.

classifyText

 Klassifiziert ein Dokument in Kategorien.

moderateText

 Ein Dokument wird auf schädliche und sensible Inhalte überprüft.