Package google.cloud.translation.v3

Important : Pour accéder à l'URL indiquée entre parenthèses, vous devez vous connecter à Internet. L'URL est fournie pour accéder à l'environnement isolé.

TranslationService

Fournit des opérations de traduction en langage naturel.

TranslateDocument

rpc TranslateDocument(TranslateDocumentRequest) returns (TranslateDocumentResponse)

Traduit les documents en mode synchrone.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

TranslateDocumentRequest

Demande de traduction de document.

Champs
parent

string

Obligatoire. Emplacement pour effectuer un appel régional.

Format : projects/{project-number-or-id}/locations/{location-id}.

Pour les appels globaux, utilisez projects/{project-number-or-id}/locations/global ou projects/{project-number-or-id}.

Un emplacement non global est requis pour les requêtes utilisant des modèles AutoML ou des glossaires personnalisés.

Les modèles et les glossaires doivent se trouver dans la même région (avoir le même ID de localisation). Sinon, une erreur INVALID_ARGUMENT (400) est renvoyée.

source_language_code

string

Facultatif. Code de langue ISO-639 du document d'entrée, si connu (par exemple, "en-US" ou "sr-Latn"). Les codes de langue acceptés sont listés dans la section "Langues acceptées". Si la langue source n'est pas spécifiée, l'API tente de l'identifier automatiquement et la renvoie dans la réponse. La langue source doit être spécifiée si la requête contient un glossaire ou un modèle personnalisé.

target_language_code

string

Obligatoire. Code de langue ISO-639 à utiliser pour la traduction du document d'entrée. Il doit correspondre à l'un des codes de langue listés dans la section "Langues acceptées".

document_input_config

DocumentInputConfig

Obligatoire. Configurations d'entrée.

glossary_config

TranslateTextGlossaryConfig

Facultatif. Glossaire à appliquer. Le glossaire doit se trouver dans la même région (avoir le même ID de localisation) que le modèle. Sinon, une erreur INVALID_ARGUMENT (400) est renvoyée.

L'autorisation IAM suivante est requise pour la ressource glossaryConfig indiquée :

  • cloudtranslate.glossaries.docPredict

TranslateDocumentResponse

Message de réponse d'un document traduit.

Champs
document_translation

DocumentTranslation

Document traduit.

glossary_document_translation

DocumentTranslation

Résultat de la traduction du document si un glossaire est fourni dans la requête. Elle peut être identique à [TranslateDocumentResponse.document_translation] si aucun terme du glossaire ne s'applique.

glossary_config

TranslateTextGlossaryConfig

glossary_config utilisé pour cette traduction.

CreateGlossary

rpc CreateGlossary(CreateGlossaryRequest) returns (Operation)

Crée un glossaire et renvoie l'opération de longue durée. Renvoie NOT_FOUND si le projet n'existe pas.

DeleteGlossary

rpc DeleteGlossary(DeleteGlossaryRequest) returns (Operation)

Supprime un glossaire s'il n'a pas été créé. Renvoie NOT_FOUND si le glossaire n'existe pas.

DetectLanguage

rpc DetectLanguage(DetectLanguageRequest) returns (DetectLanguageResponse)

Détecte la langue du texte dans une requête.

GetGlossary

rpc GetGlossary(GetGlossaryRequest) returns (Glossary)

Récupère un glossaire. Renvoie NOT_FOUND si le glossaire n'existe pas.

GetSupportedLanguages

rpc GetSupportedLanguages(GetSupportedLanguagesRequest) returns (SupportedLanguages)

Renvoie la liste des langues disponibles pour la traduction.

ListGlossaries

rpc ListGlossaries(ListGlossariesRequest) returns (ListGlossariesResponse)

Répertorie les glossaires d'un projet. Renvoie NOT_FOUND si le projet n'existe pas.

TranslateText

rpc TranslateText(TranslateTextRequest) returns (TranslateTextResponse)

Traduit le texte d'entrée et renvoie le texte traduit.

CreateGlossaryMetadata

Stocké dans le champ google.longrunning.Operation.metadata renvoyé par CreateGlossary.

Champs
name

string

Nom du glossaire en cours de création.

state

State

État actuel de l'opération de création du glossaire.

submit_time

Timestamp

Heure à laquelle l'opération a été envoyée au serveur.

État

Énumère les états possibles d'une requête de création.

Énumérations
STATE_UNSPECIFIED Non valide.
RUNNING La demande est en cours de traitement.
SUCCEEDED Le glossaire a bien été créé.
FAILED Échec de la création du glossaire.

CreateGlossaryRequest

Message de requête pour CreateGlossary.

Champs
parent

string

Obligatoire. Nom du projet

glossary

Glossary

Obligatoire. Glossaire à créer.

DeleteGlossaryMetadata

Stocké dans le champ google.longrunning.Operation.metadata renvoyé par DeleteGlossary.

Champs
name

string

Nom du glossaire à supprimer.

state

State

État actuel de l'opération de suppression du glossaire.

submit_time

Timestamp

Heure à laquelle l'opération a été envoyée au serveur.

État

Énumère les états possibles d'une requête de création.

Énumérations
STATE_UNSPECIFIED Non valide.
RUNNING La demande est en cours de traitement.
SUCCEEDED Le glossaire a bien été supprimé.
FAILED Échec de la suppression du glossaire.

DeleteGlossaryRequest

Message de requête pour DeleteGlossary.

Champs
name

string

Obligatoire. Nom du glossaire à supprimer.

DeleteGlossaryResponse

Stocké dans le champ google.longrunning.Operation.response renvoyé par DeleteGlossary.

Champs
name

string

Nom du glossaire supprimé.

submit_time

Timestamp

Heure à laquelle l'opération a été envoyée au serveur.

end_time

Timestamp

Date/Heure de fin de la suppression du glossaire et google.longrunning.Operation.done défini sur "true".

DetectLanguageRequest

Message de requête pour la détection de la langue.

Champs
parent

string

Obligatoire. Projet pour passer un appel. Doit faire référence au projet d'un appelant.

Format : projects/{project-id}.

mime_type

string

Facultatif. Format du texte source (par exemple, "text/html" ou "text/plain"). Si vous ne renseignez pas ce champ, le type MIME est défini par défaut sur "text/html".

content

string

Contenu de l'entrée stocké sous forme de chaîne.

DetectLanguageResponse

Message de réponse pour la détection de la langue.

Champs
languages[]

DetectedLanguage

Langue la plus probable détectée par l'API Translation. Pour chaque requête, l'API Translation ne renverra toujours qu'un seul résultat.

DetectedLanguage

Message de réponse pour la détection de la langue.

Champs
language_code

string

Code de langue BCP-47 du contenu source dans la requête, détecté automatiquement.

confidence

float

Niveau de confiance du résultat de la détection pour cette langue.

S3Source

Emplacement de stockage du contenu d'entrée.

Champs
input_uri

string

Obligatoire. URI des données sources. Par exemple, s3://my_bucket/my_object.

GetGlossaryRequest

Message de requête pour GetGlossary.

Champs
name

string

Obligatoire. Nom du glossaire à récupérer.

GetSupportedLanguagesRequest

Message de requête pour découvrir les langues disponibles.

Champs
parent

string

Obligatoire. Projet pour passer un appel. Doit faire référence au projet d'un appelant.

Format : projects/{project-id}.

display_language_code

string

Facultatif. Langue à utiliser pour renvoyer les noms localisés et lisibles des langues disponibles. Si cette valeur est manquante, les noms à afficher ne sont pas renvoyés dans une réponse.

Glossaire

Représente un glossaire créé à partir des données fournies par l'utilisateur.

Champs
name

string

Obligatoire. Nom de ressource du glossaire. Les noms de glossaires sont au format projects/{project-id}/glossaries/{glossary-id}.

input_config

GlossaryInputConfig

Obligatoire. Fournit des exemples pour créer le glossaire. Le glossaire ne doit pas dépasser 10 millions de points de code Unicode.

entry_count

int32

Uniquement en sortie. Nombre d'entrées définies dans le glossaire.

submit_time

Timestamp

Uniquement en sortie. Date à laquelle CreateGlossary a été appelé.

end_time

Timestamp

Uniquement en sortie. Date de création du glossaire.

display_name

string

Facultatif. Nom à afficher du glossaire.

Champ d'union languages. Langues acceptées par le glossaire. languages ne peut être qu'un des éléments suivants :
language_pair

LanguageCodePair

Utilisé avec les glossaires unidirectionnels.

language_codes_set

LanguageCodesSet

Utilisé avec les glossaires d'ensembles de termes équivalents.

LanguageCodePair

Utilisé avec les glossaires unidirectionnels.

Champs
source_language_code

string

Obligatoire. Code de langue BCP-47 du texte d'entrée (par exemple, "en-US"). Doit correspondre exactement à GlossaryTerm.language_code.

target_language_code

string

Obligatoire. Code de langue BCP-47 pour la sortie de la traduction (par exemple, "zh-CN"). Doit correspondre exactement à GlossaryTerm.language_code.

LanguageCodesSet

Utilisé avec les glossaires d'ensembles de termes équivalents.

Champs
language_codes[]

string

Code(s) de langue BCP-47 pour les termes définis dans le glossaire. Toutes les entrées sont uniques. La liste contient au moins deux entrées. Doit correspondre exactement à GlossaryTerm.language_code.

GlossaryInputConfig

Configuration d'entrée pour les glossaires.

Champs
s3_source

S3Source

Obligatoire. Emplacement de stockage des données du glossaire. Le format du fichier est déterminé en fonction de l'extension du nom de fichier. L'API renvoie google.rpc.Code.INVALID_ARGUMENT pour les URI et les formats de fichiers non compatibles. Les caractères génériques ne sont pas autorisés. Il doit s'agir d'un seul fichier dans l'un des formats suivants :

Pour les glossaires unidirectionnels :

  • TSV/CSV (.tsv/.csv) : fichier à deux colonnes, séparées par une tabulation ou une virgule. La première colonne contient le texte source. La deuxième colonne contient le texte cible. Le fichier ne doit pas contenir d'en-têtes. Autrement dit, la première ligne contient des données, et non des noms de colonnes.

  • TMX (.tmx) : fichier TMX contenant des données parallèles définissant des paires de termes source/cible.

Pour les glossaires d'ensembles de termes équivalents :

  • CSV (.csv) : fichier CSV à plusieurs colonnes définissant des termes de glossaire équivalents dans plusieurs langues. Pour en savoir plus, consultez la documentation sur les glossaires.

ListGlossariesRequest

Message de requête pour ListGlossaries.

Champs
parent

string

Obligatoire. Nom du projet à partir duquel lister tous les glossaires.

page_size

int32

Facultatif. Taille de la page demandée. Le serveur peut renvoyer moins de glossaires que demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée.

page_token

string

Facultatif. Jeton identifiant une page de résultats que le serveur doit renvoyer. Il s'agit généralement de la valeur de [ListGlossariesResponse.next_page_token] renvoyée par l'appel précédent à la méthode ListGlossaries. La première page est renvoyée si page_token est vide ou manquant.

filter

string

Facultatif. Filtre spécifiant les contraintes d'une opération de liste. Spécifiez la contrainte au format "key=value", où la clé doit être "src" ou "tgt", et la valeur doit être un code de langue valide. Pour plusieurs restrictions, concaténez-les avec "AND" (en majuscules uniquement), par exemple : "src=en-US AND tgt=zh-CN". Notez que l'expression exacte est utilisée ici. Cela signifie que l'utilisation de "en-US" et "en" peut entraîner des résultats différents, selon le code de langue que vous avez utilisé lors de la création du glossaire. Pour les glossaires unidirectionnels, "src" et "tgt" ajoutent des restrictions sur le code de langue source et cible séparément. Pour les glossaires d'ensemble de termes équivalents, les attributs "src" et/ou "tgt" ajoutent des restrictions à l'ensemble de termes. Par exemple, "src=en-US AND tgt=zh-CN" ne sélectionnera que les glossaires unidirectionnels dont le code de langue source est exactement "en-US" et le code de langue cible est exactement "zh-CN". En revanche, tous les glossaires d'ensemble de termes équivalents qui contiennent "en-US" et "zh-CN" dans leur ensemble de langues seront sélectionnés. Si elle est manquante, aucun filtrage n'est effectué.

ListGlossariesResponse

Message de réponse pour ListGlossaries.

Champs
glossaries[]

Glossary

Liste des glossaires d'un projet.

next_page_token

string

Jeton permettant de récupérer une page de résultats. Transmettez cette valeur dans le champ [ListGlossariesRequest.page_token] de l'appel suivant à la méthode ListGlossaries pour récupérer la page de résultats suivante.

SupportedLanguage

Une réponse dans une seule langue acceptée correspond à des informations liées à une langue acceptée.

Champs
language_code

string

Code de langue accepté, généralement composé de son identifiant ISO 639-1 (par exemple, "en" ou "ja"). Dans certains cas, des codes BCP-47 incluant des identifiants de langue et de région sont renvoyés (par exemple, &39;zh-TW' et 'zh-CN').

display_name

string

Nom de la langue dans un format lisible par l'humain, localisé dans la langue d'affichage spécifiée dans la requête.

support_source

bool

Peut être utilisé comme langue source.

support_target

bool

Peut être utilisé comme langue cible.

Langages acceptés

Message de réponse pour la découverte des langues disponibles.

Champs
languages[]

SupportedLanguage

Liste des réponses dans les langues acceptées. Cette liste contient une entrée pour chaque langue acceptée par l'API Translation.

TranslateTextGlossaryConfig

Configure le glossaire à utiliser pour une langue cible spécifique et définit les options d'application de ce glossaire.

Champs
glossary

string

Obligatoire. glossary à appliquer pour cette traduction.

Le format dépend du glossaire :

  • Glossaire personnalisé fourni par l'utilisateur : projects/{project-id}/glossaries/{glossary-id}
ignore_case

bool

Facultatif. Indique que la correspondance n'est pas sensible à la casse. La valeur par défaut est "false" si elle est manquante.

TranslateTextRequest

Message de requête pour la traduction synchrone.

Champs
contents[]

string

Obligatoire. Contenu de l'entrée au format de chaîne. Nous vous recommandons de ne pas dépasser 30 000 points de code pour le contenu total. La longueur maximale de ce champ est de 1 024. Utilisez BatchTranslateText pour les textes plus longs.

mime_type

string

Facultatif. Format du texte source, par exemple "text/html" ou "text/plain". Si vous ne renseignez pas ce champ, le type MIME est défini par défaut sur "text/html".

source_language_code

string

Code de langue BCP-47 du texte d'entrée, s'il est connu (par exemple, en-US ou sr-Latn). Les codes de langue acceptés sont listés dans la section "Langues acceptées".

target_language_code

string

Obligatoire. Code de langue BCP-47 à utiliser pour la traduction du texte d'entrée. Définissez l'un des codes de langue répertoriés dans la page Langues acceptées.

parent

string

Obligatoire. Projet pour passer un appel. Doit faire référence au projet d'un appelant.

Format : projects/{project-id}

glossary_config

TranslateTextGlossaryConfig

Facultatif. Glossaire à appliquer.

TranslateTextResponse

Champs
translations[]

Translation

Réponses de traduction de texte sans glossaire appliqué. Ce champ a la même longueur que contents.

glossary_translations[]

Translation

Réponses de traduction de texte si un glossaire est fourni dans la demande. Cette valeur peut être identique à translations si aucune condition ne s'applique. Ce champ a la même longueur que contents.

Traduction

Réponse de traduction unique.

Champs
translated_text

string

Texte traduit dans la langue cible. Si une erreur se produit lors de la traduction, ce champ peut être exclu de la réponse.

detected_language_code

string

Si la langue source a été transmise, la détection automatique de la langue ne se produit pas et ce champ est vide.

glossary_config

TranslateTextGlossaryConfig

glossary_config utilisé pour cette traduction.