Package google.cloud.translation.v3

Wichtig: Um auf die in Klammern aufgeführte URL zuzugreifen, müssen Sie mit dem Internet verbunden sein. Die URL wird für den Zugriff außerhalb Ihrer Air-Gap-Umgebung bereitgestellt.

TranslationService

Bietet Übersetzungen in natürliche Sprachen.

TranslateDocument
rpc TranslateDocument(TranslateDocumentRequest) returns (TranslateDocumentResponse) Übersetzt Dokumente im synchronen Modus. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-translation https://www.googleapis.com/auth/cloud-platform

TranslateDocumentRequest

Eine Anfrage zur Dokumentübersetzung.

Felder
parent	string Erforderlich. Standort für einen regionalen Anruf. Format: projects/{project-number-or-id}/locations/{location-id}. Verwenden Sie für globale Aufrufe projects/{project-number-or-id}/locations/global oder projects/{project-number-or-id}. Für Anfragen mit AutoML-Modellen oder benutzerdefinierten Glossaren ist ein nicht globaler Standort erforderlich. Modelle und Glossare müssen sich in derselben Region befinden (dieselbe location-id haben). Andernfalls wird der Fehler INVALID_ARGUMENT (400) zurückgegeben.
source_language_code	string Optional. Der ISO-639-Sprachcode des Eingabedokuments, sofern bekannt, z. B. „en-US“ oder „sr-Latn“. Die unterstützten Sprachcodes finden Sie unter „Sprachunterstützung“. Wenn die Ausgangssprache nicht angegeben ist, versucht die API, sie automatisch zu ermitteln, und gibt sie in der Antwort zurück. Die Ausgangssprache muss angegeben werden, wenn die Anfrage ein Glossar oder ein benutzerdefiniertes Modell enthält.
target_language_code	string Erforderlich. Der ISO 639-Sprachcode, der für die Übersetzung des Eingabedokuments verwendet werden soll. Er muss auf einen der unter „Sprachunterstützung“ aufgeführten Sprachcodes festgelegt sein.
document_input_config	DocumentInputConfig Erforderlich. Eingabekonfigurationen.
glossary_config	TranslateTextGlossaryConfig Optional. Glossar, das angewendet werden soll. Das Glossar muss sich in derselben Region (mit derselben location-id) wie das Modell befinden. Andernfalls wird der Fehler INVALID_ARGUMENT (400) zurückgegeben. Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource glossaryConfig erforderlich: cloudtranslate.glossaries.docPredict

TranslateDocumentResponse

Eine übersetzte Dokumentantwortnachricht.

Felder
document_translation	DocumentTranslation Übersetztes Dokument.
glossary_document_translation	DocumentTranslation Die Übersetzung des Dokuments, wenn in der Anfrage ein Glossar angegeben ist. Dieser Wert kann mit [TranslateDocumentResponse.document_translation] identisch sein, wenn keine Glossarbegriffe angewendet werden.
glossary_config	TranslateTextGlossaryConfig Die glossary_config, die für diese Übersetzung verwendet wurde.

CreateGlossary
rpc CreateGlossary(CreateGlossaryRequest) returns (Operation) Erstellt ein Glossar und gibt den Vorgang mit langer Ausführungszeit zurück. Gibt NOT_FOUND zurück, wenn das Projekt nicht vorhanden ist.

DeleteGlossary
rpc DeleteGlossary(DeleteGlossaryRequest) returns (Operation) Löscht ein Glossar, wenn es noch nicht erstellt wurde. Gibt NOT_FOUND zurück, wenn das Glossar nicht vorhanden ist.

DetectLanguage
rpc DetectLanguage(DetectLanguageRequest) returns (DetectLanguageResponse) Erkennt die Sprache des Textes einer Anfrage.

GetGlossary
rpc GetGlossary(GetGlossaryRequest) returns (Glossary) Ruft ein Glossar ab. Gibt NOT_FOUND zurück, wenn das Glossar nicht vorhanden ist.

GetSupportedLanguages
rpc GetSupportedLanguages(GetSupportedLanguagesRequest) returns (SupportedLanguages) Liefert eine Liste der unterstützten Sprachen für die Übersetzung.

ListGlossaries
rpc ListGlossaries(ListGlossariesRequest) returns (ListGlossariesResponse) Listet Glossare in einem Projekt auf. Gibt NOT_FOUND zurück, wenn das Projekt nicht vorhanden ist.

TranslateText
rpc TranslateText(TranslateTextRequest) returns (TranslateTextResponse) Übersetzt Eingabetext und gibt übersetzten Text zurück.

CreateGlossaryMetadata

Wird im Feld google.longrunning.Operation.metadata gespeichert, das von CreateGlossary zurückgegeben wird.

Felder
name	string Der Name des Glossars, das erstellt wird.
state	State Der aktuelle Status des Vorgangs zum Erstellen des Glossars.
submit_time	Timestamp Der Zeitpunkt, zu dem der Vorgang an den Server gesendet wurde.

Bundesland

Zählt die möglichen Status auf, in denen die Erstellungsanfrage enthalten sein kann.

Enums
STATE_UNSPECIFIED	Ungültig.
RUNNING	Die Anfrage wird bearbeitet.
SUCCEEDED	Das Glossar wurde erstellt.
FAILED	Das Glossar konnte nicht erstellt werden.

CreateGlossaryRequest

Anfragenachricht für CreateGlossary.

Felder
parent	string Erforderlich. Der Projektname
glossary	Glossary Erforderlich. Das zu erstellende Glossar.

DeleteGlossaryMetadata

Im Feld google.longrunning.Operation.metadata gespeichert, das von DeleteGlossary zurückgegeben wird.

Felder
name	string Der Name des Glossars, das gelöscht wird.
state	State Der aktuelle Status des Löschvorgangs für das Glossar.
submit_time	Timestamp Der Zeitpunkt, zu dem der Vorgang an den Server gesendet wurde.

Bundesland

Zählt die möglichen Status auf, in denen die Erstellungsanfrage enthalten sein kann.

Enums
STATE_UNSPECIFIED	Ungültig.
RUNNING	Die Anfrage wird bearbeitet.
SUCCEEDED	Das Glossar wurde gelöscht.
FAILED	Das Glossar konnte nicht gelöscht werden.

DeleteGlossaryRequest

Anfragenachricht für DeleteGlossary

Felder
name	string Erforderlich. Der Name des zu löschenden Glossars.

DeleteGlossaryResponse

Im Feld google.longrunning.Operation.response gespeichert, das von DeleteGlossary zurückgegeben wird.

Felder
name	string Der Name des gelöschten Glossars.
submit_time	Timestamp Der Zeitpunkt, zu dem der Vorgang an den Server gesendet wurde.
end_time	Timestamp Der Zeitpunkt, zu dem das Löschen des Glossars abgeschlossen und google.longrunning.Operation.done auf „true“ gesetzt wurde.

DetectLanguageRequest

Anfragenachricht für Spracherkennung.

Felder
parent	string Erforderlich. Projekt zum Anrufen. Muss sich auf das Projekt eines Anrufers beziehen. Format: projects/{project-id}.
mime_type	string Optional. Das Format des Quelltexts, z. B. „text/html“ oder „text/plain“. Wenn Sie hier nichts eingeben, wird standardmäßig der MIME-Typ „text/html“ verwendet.
content	string Der Inhalt der Eingabe, die als String gespeichert ist.

DetectLanguageResponse

Die Antwortnachricht für die Spracherkennung.

Felder
languages[]	DetectedLanguage Die wahrscheinlichste Sprache, die von der Translation API erkannt wurde. Die Translation API gibt für jede Anfrage immer nur ein Ergebnis zurück.

DetectedLanguage

Die Antwortnachricht für die Spracherkennung.

Felder
language_code	string Der BCP-47-Sprachcode des Quellinhalts in der Anfrage wird automatisch erkannt.
confidence	float Die Konfidenz des Erkennungsergebnisses für diese Sprache

S3Source

Der Speicherort für die Eingabeinhalte.

Felder
input_uri	string Erforderlich. URI der Quelldaten. Beispiel: s3://my_bucket/my_object.

GetGlossaryRequest

Anfragenachricht für GetGlossary

Felder
name	string Erforderlich. Der Name des abzurufenden Glossars.

GetSupportedLanguagesRequest

Die Anfragenachricht zum Ermitteln unterstützter Sprachen.

Felder
parent	string Erforderlich. Projekt zum Anrufen. Muss sich auf das Projekt eines Anrufers beziehen. Format: projects/{project-id}.
display_language_code	string Optional. Die Sprache, in der lokalisierte, lesbare Namen der unterstützten Sprachen zurückgegeben werden sollen. Wenn sie fehlen, werden keine Anzeigenamen in einer Antwort zurückgegeben.

Glossar

Stellt ein Glossar dar, das aus von Nutzern bereitgestellten Daten erstellt wurde.

Felder
name	string Erforderlich. Der Ressourcenname des Glossars. Glossarnamen haben das Format projects/{project-id}/glossaries/{glossary-id}.
input_config	GlossaryInputConfig Erforderlich. Enthält Beispiele, anhand derer das Glossar erstellt werden kann. Das gesamte Glossar darf 10 Millionen Unicode-Codepunkte nicht überschreiten.
entry_count	int32 Nur Ausgabe. Die Anzahl der im Glossar definierten Einträge.
submit_time	Timestamp Nur Ausgabe. Wann „CreateGlossary“ aufgerufen wurde.
end_time	Timestamp Nur Ausgabe. Wann die Glossarerstellung abgeschlossen wurde.
display_name	string Optional. Der Anzeigename des Glossars.
Union-Feld languages. Von Glossar unterstützte Sprachen Für languages ist nur einer der folgenden Werte zulässig:
language_pair	LanguageCodePair Wird mit unidirektionalen Glossaren verwendet.
language_codes_set	LanguageCodesSet Wird mit Glossaren mit Sets äquivalenter Begriffe verwendet.

LanguageCodePair

Wird mit unidirektionalen Glossaren verwendet.

Felder
source_language_code	string Erforderlich. Der BCP-47-Sprachcode des Eingabetexts, z. B. „en-US“. Muss eine genaue Übereinstimmung mit GlossaryTerm.language_code sein.
target_language_code	string Erforderlich. Der BCP-47-Sprachcode für die Übersetzungsausgabe, z. B. „zh-CN“. Muss eine genaue Übereinstimmung mit GlossaryTerm.language_code sein.

LanguageCodesSet

Wird mit Glossaren mit Sets äquivalenter Begriffe verwendet.

Felder
language_codes[]	string Der BCP-47-Sprachcode bzw. die BCP-47-Sprachcodes für im Glossar definierte Begriffe. Alle Einträge sind eindeutig. Die Liste enthält mindestens zwei Einträge. Muss eine genaue Übereinstimmung mit GlossaryTerm.language_code sein.

GlossaryInputConfig

Eingabekonfiguration für Glossare.

Felder

s3_source

S3Source Erforderlich. Speicherort der Glossardaten. Das Dateiformat wird anhand der Dateinamenerweiterung bestimmt. Die API gibt google.rpc.Code.INVALID_ARGUMENT für nicht unterstützte URIs und Dateiformate zurück. Platzhalter sind nicht zulässig. Es muss sich um eine einzelne Datei in einem der folgenden Formate handeln: Für unidirektionale Glossare: TSV/CSV (.tsv/.csv): Datei mit zwei Spalten, die durch Tabulatoren oder Kommas getrennt sind. Die erste Spalte enthält den Quelltext. Die zweite Spalte enthält den Zieltext. Die Datei darf keine Kopfzeilen enthalten. Die erste Zeile enthält also Daten und keine Spaltennamen. TMX (.tmx): TMX-Datei mit parallelen Daten, in denen Quell- und Zielbegriffspaare definiert sind. Für Glossare mit Sets äquivalenter Begriffe: CSV (.csv): Mehrspaltige CSV-Datei, in der äquivalente Glossarbegriffe in mehreren Sprachen definiert werden. Weitere Informationen finden Sie in der Dokumentation.

ListGlossariesRequest

Anfragenachricht für ListGlossaries

Felder
parent	string Erforderlich. Der Name des Projekts, aus dem alle Glossare aufgelistet werden sollen.
page_size	int32 Optional. Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Glossare als angefordert zurück. Wenn nicht angegeben, wählt der Server einen geeigneten Standardwert aus.
page_token	string Optional. Ein Token, das eine Ergebnisseite identifiziert, die der Server liefern soll. Normalerweise ist dies der Wert von [ListGlossariesResponse.next_page_token], der vom vorherigen Aufruf der Methode ListGlossaries zurückgegeben wurde. Die erste Seite wird zurückgegeben, wenn page_token leer ist oder fehlt.
filter	string Optional. Filter, der die Einschränkungen einer Listenoperation angibt. Geben Sie die Einschränkung im Format „Schlüssel=Wert“ an, wobei der Schlüssel „src“ oder „tgt“ sein muss und der Wert ein gültiger Sprachcode sein muss. Bei mehreren Einschränkungen müssen Sie sie mit „AND“ (nur in Großbuchstaben) verknüpfen, z. B. „src=en-US AND tgt=zh-CN“. Beachten Sie, dass hier der genaue Abgleich verwendet wird. Das bedeutet, dass die Verwendung von „en-US“ und „en“ zu unterschiedlichen Ergebnissen führen kann, je nachdem, welchen Sprachcode Sie beim Erstellen des Glossars verwendet haben. Bei unidirektionalen Glossaren werden mit „src“ und „tgt“ Einschränkungen für den Quell- und Zielsprachcode separat hinzugefügt. Bei Glossaren mit Sets äquivalenter Begriffe werden die Sets durch „src“ und/oder „tgt“ eingeschränkt. Beispiel: Mit „src=en-US AND tgt=zh-CN“ werden nur die unidirektionalen Glossare ausgewählt, die genau dem Quellsprachcode „en-US“ und dem Zielsprachcode „zh-CN“ entsprechen. Alle Glossare mit Sets äquivalenter Begriffe, die „en-US“ und „zh-CN“ in ihrem Sprachset enthalten, werden jedoch ausgewählt. Wenn sie fehlt, wird keine Filterung durchgeführt.

ListGlossariesResponse

Antwortnachricht für ListGlossaries.

Felder
glossaries[]	Glossary Die Liste der Glossare für ein Projekt.
next_page_token	string Ein Token zum Abrufen einer Ergebnisseite. Übergeben Sie diesen Wert im Feld [ListGlossariesRequest.page_token] im nachfolgenden Aufruf der Methode ListGlossaries, um die nächste Ergebnisseite abzurufen.

SupportedLanguage

Eine einzelne Antwort zu unterstützten Sprachen entspricht Informationen, die sich auf eine unterstützte Sprache beziehen.

Felder
language_code	string Unterstützter Sprachcode, der in der Regel aus der ISO 639-1-Kennung besteht, z. B. „en“, „ja“. In bestimmten Fällen werden BCP-47-Codes mit Sprach- und Regionskennungen zurückgegeben, z. B. „zh-TW“ und „zh-CN“.
display_name	string Für Menschen lesbarer Name der Sprache, lokalisiert in der in der Anfrage angegebenen Anzeigesprache.
support_source	bool Kann als Ausgangssprache verwendet werden.
support_target	bool Kann als Zielsprache verwendet werden.

SupportedLanguages

Die Antwortnachricht zum Ermitteln der unterstützten Sprachen:

Felder
languages[]	SupportedLanguage Eine Liste der unterstützten Sprachantworten: Diese Liste enthält einen Eintrag für jede Sprache, die von der Translation API unterstützt wird.

TranslateTextGlossaryConfig

Konfiguriert, welches Glossar für eine bestimmte Zielsprache verwendet werden soll, und definiert Optionen zum Anwenden dieses Glossars.

Felder
glossary	string Erforderlich. Die glossary, die für diese Übersetzung angewendet werden soll. Das Format hängt vom Glossar ab: Benutzerdefiniertes Glossar des Nutzers: projects/{project-id}/glossaries/{glossary-id}
ignore_case	bool Optional. Gibt an, dass beim Abgleich die Groß-/Kleinschreibung nicht berücksichtigt wird. Der Standardwert ist „false“, wenn er fehlt.

TranslateTextRequest

Die Anfragenachricht für die synchrone Übersetzung.

Felder
contents[]	string Erforderlich. Der Inhalt der Eingabe im Stringformat. Wir empfehlen, dass der gesamte Inhalt weniger als 30.000 Codepoints umfasst. Die maximale Länge dieses Feldes beträgt 1.024 Zeichen. Verwenden Sie BatchTranslateText für längere Texte.
mime_type	string Optional. Das Format des Quelltexts, z. B. „text/html“ oder „text/plain“. Wenn Sie hier nichts eingeben, wird standardmäßig der MIME-Typ „text/html“ verwendet.
source_language_code	string Der BCP-47-Sprachcode des Eingabetexts, falls bekannt, z. B. en-US oder sr-Latn. Die unterstützten Sprachcodes finden Sie unter „Sprachunterstützung“.
target_language_code	string Erforderlich. Der BCP-47-Sprachcode, der für die Übersetzung des Eingabetexts verwendet werden soll. Er muss auf einen der unter „Sprachunterstützung“ aufgeführten Sprachcodes festgelegt sein.
parent	string Erforderlich. Projekt zum Anrufen. Muss sich auf das Projekt eines Anrufers beziehen. Format: projects/{project-id}
glossary_config	TranslateTextGlossaryConfig Optional. Glossar, das angewendet werden soll.

TranslateTextResponse

Felder
translations[]	Translation Antworten auf Textübersetzungen ohne angewendetes Glossar. Dieses Feld hat dieselbe Länge wie contents.
glossary_translations[]	Translation Antworten auf Textübersetzungen, wenn in der Anfrage ein Glossar angegeben ist. Dieser kann mit translations identisch sein, wenn keine Bedingungen gelten. Dieses Feld hat dieselbe Länge wie contents.

Übersetzung

Eine einzelne Übersetzungsantwort.

Felder
translated_text	string Text, der in die Zielsprache übersetzt wurde. Wenn bei der Übersetzung ein Fehler auftritt, wird dieses Feld möglicherweise aus der Antwort ausgeschlossen.
detected_language_code	string Wenn die Quellsprache übergeben wurde, erfolgt keine automatische Erkennung der Sprache und dieses Feld ist leer.
glossary_config	TranslateTextGlossaryConfig Die glossary_config, die für diese Übersetzung verwendet wurde.