DocumentTranslationClient class
Client pour le service Azure AI Document Translation, utilisé pour traduire des lots de documents stockés dans Stockage Blob Azure.
Constructeurs
| Document |
Crée une instance de DocumentTranslationClient. |
Propriétés
| pipeline | Pipeline utilisé par ce client pour effectuer des requêtes |
Méthodes
| cancel |
Annule une traduction en attente ou en cours de traitement. Une traduction n’est pas annulée si elle est déjà terminée ou a échoué ou annulée. Une demande incorrecte est retournée. Tous les documents qui ont terminé la traduction ne seront pas annulés et seront facturés. Tous les documents en attente seront annulés si possible. |
| get |
Retourne l’état de traduction d’un document spécifique en fonction de l’ID de demande et de l’ID de document. |
| get |
La liste des formats pris en charge par le service de traduction de documents. La liste inclut l’extension de fichier commune, ainsi que le type de contenu si vous utilisez l’API de chargement. |
| get |
Retourne l’état d’une demande de traduction de document. L’état inclut l’état global de la demande, ainsi que l’état des documents qui sont traduits dans le cadre de cette demande. |
| list |
Retourne l’état de tous les documents d’une demande de traduction de documents par lots. Si le nombre de documents dans la réponse dépasse notre limite de pagination, la pagination côté serveur est utilisée. Les réponses paginés indiquent un résultat partiel et incluent un jeton de continuation dans la réponse. L’absence d’un jeton de continuation signifie qu’aucune page supplémentaire n’est disponible. les options top, skip et maxPageSize peuvent être utilisées pour spécifier un nombre de résultats à retourner et un décalage pour la collection. Le haut indique le nombre total d’enregistrements que l’utilisateur souhaite voir retournés sur toutes les pages. Passer indique le nombre d’enregistrements à ignorer dans la liste de statut des documents détenue par le serveur selon la méthode de tri spécifiée. Par défaut, nous trions en décroissant l’heure de début. maxPageSize correspond au maximum d’éléments retournés sur une page. Si plus d’articles sont demandés via le top (ou si top n’est pas spécifié et qu’il y a d’autres articles à retourner), |
| list |
Retourne la liste des demandes de traitement par lots envoyées et l’état de chaque requête. Cette liste contient uniquement les demandes par lots envoyées par l’utilisateur (en fonction de la ressource). Si le nombre de requêtes dépasse notre limite de pagination, la pagination côté serveur est utilisée. Les réponses paginés indiquent un résultat partiel et incluent un jeton de continuation dans la réponse. L’absence d’un jeton de continuation signifie qu’aucune page supplémentaire n’est disponible. les options top, skip et maxPageSize peuvent être utilisées pour spécifier un nombre de résultats à retourner et un décalage pour la collection. Le haut indique le nombre total d’enregistrements que l’utilisateur souhaite voir retournés sur toutes les pages. Passer indique le nombre d’enregistrements à ignorer dans la liste des lots selon la méthode de tri spécifiée. Par défaut, nous trions en décroissant l’heure de début. maxPageSize correspond au maximum d’éléments retournés sur une page. Si plus d’articles sont demandés via le top (ou si top n’est pas spécifié et qu’il y a d’autres articles à retourner), |
| start |
Utilisez cette API pour envoyer une demande de traduction en bloc (par lots) au service Traduction de documents. Chaque requête peut contenir plusieurs documents et doit contenir un conteneur source et de destination pour chaque document. Le préfixe et le filtre de suffixe (s’il est fourni) sont utilisés pour filtrer les dossiers. Le préfixe est appliqué au sous-chemin après le nom du conteneur. La mémoire des glossaires / traduction peut être incluse dans la demande et sont appliquées par le service lorsque le document est traduit. Si le glossaire n’est pas valide ou inaccessible pendant la traduction, une erreur est indiquée dans l’état du document. Si un fichier portant le même nom existe déjà au niveau de la destination, il est remplacé. TargetUrl pour chaque langue cible doit être unique. |
Détails du constructeur
DocumentTranslationClient(string, KeyCredential | TokenCredential, DocumentTranslationClientOptionalParams)
Crée une instance de DocumentTranslationClient.
new DocumentTranslationClient(endpointParam: string, credential: KeyCredential | TokenCredential, options?: DocumentTranslationClientOptionalParams)Paramètres
- endpointParam
-
string
Le point de terminaison de traduction de documents, par https://<resource-name>.cognitiveservices.azure.comexemple .
- credential
Une accréditation clé ou un token utilisé pour authentifier les requêtes au service.
Options utilisées pour configurer le client.
Détails de la propriété
pipeline
Pipeline utilisé par ce client pour effectuer des requêtes
pipeline: PipelineValeur de propriété
Détails de la méthode
cancelTranslation(string, CancelTranslationOptionalParams)
Annule une traduction en attente ou en cours de traitement. Une traduction n’est pas annulée si elle est déjà terminée ou a échoué ou annulée. Une demande incorrecte est retournée. Tous les documents qui ont terminé la traduction ne seront pas annulés et seront facturés. Tous les documents en attente seront annulés si possible.
function cancelTranslation(translationId: string, options?: CancelTranslationOptionalParams): Promise<TranslationStatus>Paramètres
- translationId
-
string
- options
- CancelTranslationOptionalParams
Retours
Promise<TranslationStatus>
getDocumentStatus(string, string, GetDocumentStatusOptionalParams)
Retourne l’état de traduction d’un document spécifique en fonction de l’ID de demande et de l’ID de document.
function getDocumentStatus(translationId: string, documentId: string, options?: GetDocumentStatusOptionalParams): Promise<DocumentStatus>Paramètres
- translationId
-
string
- documentId
-
string
- options
- GetDocumentStatusOptionalParams
Retours
Promise<DocumentStatus>
getSupportedFormats(FileFormatType, GetSupportedFormatsOptionalParams)
La liste des formats pris en charge par le service de traduction de documents. La liste inclut l’extension de fichier commune, ainsi que le type de contenu si vous utilisez l’API de chargement.
function getSupportedFormats(typeParam: FileFormatType, options?: GetSupportedFormatsOptionalParams): Promise<SupportedFileFormats>Paramètres
- typeParam
- FileFormatType
Retours
Promise<SupportedFileFormats>
getTranslationStatus(string, GetTranslationStatusOptionalParams)
Retourne l’état d’une demande de traduction de document. L’état inclut l’état global de la demande, ainsi que l’état des documents qui sont traduits dans le cadre de cette demande.
function getTranslationStatus(translationId: string, options?: GetTranslationStatusOptionalParams): Promise<TranslationStatus>Paramètres
- translationId
-
string
Retours
Promise<TranslationStatus>
listDocumentStatuses(string, ListDocumentStatusesOptionalParams)
Retourne l’état de tous les documents d’une demande de traduction de documents par lots.
Si le nombre de documents dans la réponse dépasse notre limite de pagination, la pagination côté serveur est utilisée. Les réponses paginés indiquent un résultat partiel et incluent un jeton de continuation dans la réponse. L’absence d’un jeton de continuation signifie qu’aucune page supplémentaire n’est disponible.
les options top, skip et maxPageSize peuvent être utilisées pour spécifier un nombre de résultats à retourner et un décalage pour la collection.
Le haut indique le nombre total d’enregistrements que l’utilisateur souhaite voir retournés sur toutes les pages. Passer indique le nombre d’enregistrements à ignorer dans la liste de statut des documents détenue par le serveur selon la méthode de tri spécifiée. Par défaut, nous trions en décroissant l’heure de début. maxPageSize correspond au maximum d’éléments retournés sur une page. Si plus d’articles sont demandés via le top (ou si top n’est pas spécifié et qu’il y a d’autres articles à retourner),
function listDocumentStatuses(translationId: string, options?: ListDocumentStatusesOptionalParams): PagedAsyncIterableIterator<DocumentStatus, DocumentStatus[], PageSettings>Paramètres
- translationId
-
string
Retours
listTranslationStatuses(ListTranslationStatusesOptionalParams)
Retourne la liste des demandes de traitement par lots envoyées et l’état de chaque requête. Cette liste contient uniquement les demandes par lots envoyées par l’utilisateur (en fonction de la ressource).
Si le nombre de requêtes dépasse notre limite de pagination, la pagination côté serveur est utilisée. Les réponses paginés indiquent un résultat partiel et incluent un jeton de continuation dans la réponse. L’absence d’un jeton de continuation signifie qu’aucune page supplémentaire n’est disponible.
les options top, skip et maxPageSize peuvent être utilisées pour spécifier un nombre de résultats à retourner et un décalage pour la collection.
Le haut indique le nombre total d’enregistrements que l’utilisateur souhaite voir retournés sur toutes les pages. Passer indique le nombre d’enregistrements à ignorer dans la liste des lots selon la méthode de tri spécifiée. Par défaut, nous trions en décroissant l’heure de début. maxPageSize correspond au maximum d’éléments retournés sur une page. Si plus d’articles sont demandés via le top (ou si top n’est pas spécifié et qu’il y a d’autres articles à retourner),
function listTranslationStatuses(options?: ListTranslationStatusesOptionalParams): PagedAsyncIterableIterator<TranslationStatus, TranslationStatus[], PageSettings>Paramètres
Retours
startTranslation(StartTranslationDetails, StartTranslationOptionalParams)
Utilisez cette API pour envoyer une demande de traduction en bloc (par lots) au service Traduction de documents. Chaque requête peut contenir plusieurs documents et doit contenir un conteneur source et de destination pour chaque document.
Le préfixe et le filtre de suffixe (s’il est fourni) sont utilisés pour filtrer les dossiers. Le préfixe est appliqué au sous-chemin après le nom du conteneur.
La mémoire des glossaires / traduction peut être incluse dans la demande et sont appliquées par le service lorsque le document est traduit.
Si le glossaire n’est pas valide ou inaccessible pendant la traduction, une erreur est indiquée dans l’état du document. Si un fichier portant le même nom existe déjà au niveau de la destination, il est remplacé. TargetUrl pour chaque langue cible doit être unique.
function startTranslation(body: StartTranslationDetails, options?: StartTranslationOptionalParams): PollerLike<OperationState<TranslationStatus>, TranslationStatus>Paramètres
- options
- StartTranslationOptionalParams