Package google.cloud.language.v2

Index

LanguageService

Bietet Textanalysevorgänge wie Sentimentanalyse und Entitätserkennung.

AnalyzeEntities

rpc AnalyzeEntities(AnalyzeEntitiesRequest) returns (AnalyzeEntitiesResponse)

Es werden benannte Entitäten (derzeit Eigennamen und Gattungsnamen) im Text sowie Entitätstypen, Wahrscheinlichkeiten, Erwähnungen für jede Entität und andere Eigenschaften gefunden.

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

rpc AnalyzeSentiment(AnalyzeSentimentRequest) returns (AnalyzeSentimentResponse)

Analysiert die Stimmung des jeweiligen Textes.

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

rpc AnnotateText(AnnotateTextRequest) returns (AnnotateTextResponse)

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

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

rpc ClassifyText(ClassifyTextRequest) returns (ClassifyTextResponse)

Klassifiziert ein Dokument in Kategorien.

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

rpc ModerateText(ModerateTextRequest) returns (ModerateTextResponse)

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

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.

AnalyzeEntitiesRequest

Die Anfragenachricht für die Entitätsanalyse.

Felder
document

Document

Pflichtangabe. Das Eingabedokument.
encoding_type

EncodingType

Der von der API verwendete Codierungstyp zum Berechnen von Offsets.

AnalyzeEntitiesResponse

Die Antwortnachricht für die Entitätsanalyse.

Felder
entities[]

Entity

Die im Eingabedokument erkannten Entitäten.
language_code

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][].
language_supported

bool

Ob die Sprache offiziell 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.

AnalyzeSentimentRequest

Die Anfragenachricht für die Sentimentanalyse.

Felder
document

Document

Pflichtangabe. Das Eingabedokument.
encoding_type

EncodingType

Der Codierungstyp, der von der API zum Berechnen von Satz-Offsets verwendet wird.

AnalyzeSentimentResponse

Die Antwortnachricht für die Sentimentanalyse.

Felder
document_sentiment

Sentiment

Die allgemeine Stimmung des Eingabedokuments.
language_code

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][].
sentences[]

Sentence

Die Stimmung für alle Sätze im Dokument.
language_supported

bool

Ob die Sprache offiziell 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.

AnnotateTextRequest

Die Anfragenachricht für die Textannotation API, mit der mehrere Analysetypen in einem einzigen Aufruf ausgeführt werden können.

Felder
document

Document

Pflichtangabe. Das Eingabedokument.
features

Features

Pflichtangabe. Die aktivierten Funktionen.
encoding_type

EncodingType

Der von der API verwendete Codierungstyp zum Berechnen von Offsets.

Features

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

Felder
extract_entities

bool

Optional. Entitäten extrahieren.
extract_document_sentiment

bool

Optional. Extrahiert die Stimmung auf Dokumentebene.
classify_text

bool

Optional. Klassifiziert das gesamte Dokument in Kategorien.
moderate_text

bool

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

AnnotateTextResponse

Die Antwortnachricht für Textanmerkungen.

Felder
sentences[]

Sentence

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

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

Sentiment

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

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[]

ClassificationCategory

Die im Eingabedokument identifizierten Kategorien.
moderation_categories[]

ClassificationCategory

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

bool

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.

ClassificationCategory

Stellt eine Kategorie dar, die vom Textklassifikator zurückgegeben wird.

Felder
name

string

Der Name der Kategorie, die das Dokument darstellt.
confidence

float

Der Konfidenzwert des Klassifikators für die Kategorie. An dieser Zahl kann abgelesen werden, wie sicher der Klassifikator ist, dass diese Kategorie den vorliegenden Text darstellt.
severity

float

Optional. Die Schwere der Kategorie gemäß dem Klassifikator. Dieser Wert ist nur vorhanden, wenn die „ModerateTextRequest.ModelVersion“ auf „MODEL_VERSION_2“ festgelegt ist und die entsprechende Kategorie einen Schweregrad hat.

ClassifyTextRequest

Die Anfragenachricht für die Dokumentklassifizierung.

Felder
document

Document

Pflichtangabe. Das Eingabedokument.

ClassifyTextResponse

Die Antwortnachricht für die Dokumentklassifizierung.

Felder
categories[]

ClassificationCategory

Die Kategorien, die das Eingabedokument darstellen.
language_code

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][].
language_supported

bool

Ob die Sprache offiziell 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.

Dokument

Stellt die Eingabe für API-Methoden dar.

Felder
type

Type

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

string

Optional. 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 sind die aktuell unterstützten Sprachen für jede API-Methode aufgeführt. 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.
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.
gcs_content_uri

string

Der Google Cloud Storage-URI, in dem sich der Dateiinhalt befindet. Dieser URI muss das Format gs://bucket_name/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

EncodingType

Stellt die Textcodierung dar, die der Aufrufer zum Verarbeiten der Ausgabe verwendet. Es wird empfohlen, ein EncodingType anzugeben, da die API die Anfangsoffsets für verschiedene Ausgaben wie Tokens und Erwähnungen bereitstellt. Sprachen, die standardmäßig unterschiedliche Textcodierungen verwenden, können auf Offsetwerte unterschiedlich zugreifen.

Enums
NONE Wenn EncodingType nicht angegeben ist, werden codierungsabhängige Informationen wie begin_offset auf -1 gesetzt.
UTF8 Codierungsabhängige Informationen wie begin_offset werden anhand der UTF-8-Codierung der Eingabe berechnet. C++ und Go sind Beispiele für Sprachen, die diese Codierung nativ verwenden.
UTF16 Codierungsabhängige Informationen (z. B. begin_offset) werden basierend auf der UTF-16-Codierung der Eingabe berechnet. Java und JavaScript sind Beispiele für Sprachen, die diese Codierung nativ verwenden.
UTF32 Codierungsabhängige Informationen (z. B. begin_offset) werden anhand der UTF-32-Codierung der Eingabe berechnet. Python ist ein Beispiel für eine Sprache, die diese Codierung nativ verwendet.

Entity

Stellt einen Ausdruck im Text dar, der eine bekannte Entität ist, z. B. eine Person, eine Organisation oder ein Standort. Die API verknüpft Informationen wie Wahrscheinlichkeit und Erwähnungen mit Entitäten.

Felder
name

string

Der repräsentative Name für die Entität.
type

Type

Der Entitätstyp.
metadata

map<string, string>

Die mit der Entität verknüpften Metadaten.

Die Metadaten für andere Entitätstypen finden Sie in der Tabelle „Typ“ unten.
mentions[]

EntityMention

Die Erwähnungen dieser Entität im Eingabedokument. Die API unterstützt derzeit Erwähnungen von Eigennamen.
sentiment

Sentiment

Bei Aufrufen von AnalyzeEntitySentimentRequest oder wenn AnnotateTextRequest.Features.extract_entity_sentiment auf „wahr“ gesetzt ist, enthält dieses Feld das aggregierte Sentiment, das im bereitgestellten Dokument für dieses Rechtssubjekt ausgedrückt wird.

Typ

Der Typ der Entität. In der folgenden Tabelle sind die zugehörigen Felder für Entitäten mit unterschiedlichen Metadaten aufgeführt.

Enums
UNKNOWN Unbekannt
PERSON Person
LOCATION Ort
ORGANIZATION Organisation
EVENT Ereignis
WORK_OF_ART Kunstwerk
CONSUMER_GOOD Verbraucherprodukt
OTHER Andere Entitätstypen
PHONE_NUMBER

Telefonnummer

Die Metadaten enthalten die Telefonnummer, die gemäß den örtlichen Konventionen formatiert ist, sowie alle zusätzlichen Elemente, die im Text erscheinen:

  • number: die tatsächliche Nummer, unterteilt in Abschnitte gemäß lokaler Konvention
  • national_prefix – Ländercode, falls erkannt
  • area_code – Region oder Vorwahl, falls erkannt
  • extension – Telefonweiterleitung (wird nach der Verbindung gewählt), falls erkannt
ADDRESS

Adresse

Die Metadaten enthalten die Hausnummer und den Ort sowie alle zusätzlichen Elemente, die im Text erscheinen:

  • street_number – Hausnummer
  • locality – Stadt
  • street_name – Name der Straße/Route, falls erkannt
  • postal_code – Postleitzahl, falls erkannt
  • country – Land, falls erkannt
  • broad_region – Verwaltungsgebiet, z. B. der Bundesstaat, falls erkannt
  • narrow_region – kleineres Verwaltungsgebiet, z. B. ein Landkreis, falls erkannt
  • sublocality – wird in asiatischen Adressen verwendet, um einen Bezirk innerhalb einer Stadt anzugeben, sofern erkannt
DATE

Datum

In den Metadaten werden die Komponenten des Datums angegeben:

  • year – vierstellige Jahreszahl, falls erkannt
  • month – zweistellige Monatszahl, falls erkannt
  • day – zweistellige Tageszahl, falls erkannt
NUMBER

Zahl

Die Metadaten sind die Zahl selbst.
PRICE

Preis

Die Metadaten identifizieren die value und currency.

EntityMention

Stellt eine Erwähnung einer Entität im Text dar. Derzeit werden Erwähnungen von Eigennamen unterstützt.

Felder
text

TextSpan

Der Erwähnungstext.
type

Type

Der Typ der Entitätserwähnung.
sentiment

Sentiment

Bei Aufrufen von AnalyzeEntitySentimentRequest oder wenn AnnotateTextRequest.Features.extract_entity_sentiment auf „wahr“ festgelegt ist, enthält dieses Feld das Sentiment, das für diese Erwähnung des Rechtssubjekts im bereitgestellten Dokument ausgedrückt wird.
probability

float

Wahrscheinlichkeitsbewertung, die mit der Entität verknüpft ist.

Der Wert gibt die Wahrscheinlichkeit an, dass die Entitätserwähnung dem Entitätstyp entspricht. Der Wert liegt im Bereich [0, 1].

Typ

Die unterstützten Erwähnungstypen.

Enums
TYPE_UNKNOWN Unbekannt
PROPER Eigenname
COMMON Gattungsname (oder Kompositum)

ModerateTextRequest

Die Anfragenachricht für die Dokumentmoderation.

Felder
document

Document

Pflichtangabe. Das Eingabedokument.
model_version

ModelVersion

Optional. Die Modellversion, die für „ModerateText“ verwendet werden soll.

ModelVersion

Die Modellversion, die für „ModerateText“ verwendet werden soll.

Enums
MODEL_VERSION_UNSPECIFIED Die Standardversion des Modells.
MODEL_VERSION_1 Verwenden Sie das Modell „v1“. Dieses Modell wird standardmäßig verwendet, wenn keine Angabe gemacht wird. Das Modell der Version 1 gibt nur einen Wahrscheinlichkeitswert (Konfidenz) für jede Kategorie zurück.
MODEL_VERSION_2 Verwenden Sie das V2-Modell. Das Modell der Version 2 gibt nur einen Wahrscheinlichkeitswert (Konfidenz) für jede Kategorie und einen Schweregrad für einen Teil der Kategorien zurück.

ModerateTextResponse

Die Antwortnachricht für die Dokumentmoderation.

Felder
moderation_categories[]

ClassificationCategory

Schädliche und sensible Kategorien, die das Eingabedokument repräsentieren.
language_code

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][].
language_supported

bool

Ob die Sprache offiziell 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.

Sentence

Stellt einen Satz im Eingabedokument dar.

Felder
text

TextSpan

Der Satztext.
sentiment

Sentiment

Bei Aufrufen von AnalyzeSentimentRequest oder wenn AnnotateTextRequest.Features.extract_document_sentiment auf „wahr“ gesetzt ist, enthält dieses Feld das Sentiment für den Satz.

Sentiment

Stellt die Stimmung des gesamten Textes oder der Entitäten im Text dar.

Felder
magnitude

float

Eine positive Zahl im Bereich [0, +inf], die die absolute Stärke der Stimmung unabhängig von der Punktzahl (positiv oder negativ) darstellt.
score

float

Stimmungswert zwischen -1,0 (negative Stimmung) und 1,0 (positive Stimmung).

TextSpan

Stellt einen Textabschnitt im Eingabedokument dar.

Felder
content

string

Der Inhalt des Textabschnitts, ein Teilstring des Dokuments.
begin_offset

int32

Die API berechnet den Anfangsoffset des Inhalts im Originaldokument gemäß dem in der API-Anfrage angegebenen EncodingType.