DocumentTranslationClient class
Client per il servizio Azure AI Document Translation, utilizzato per tradurre batch di documenti memorizzati in Archiviazione BLOB di Azure.
Costruttori
| Document |
Crea un'istanza di DocumentTranslationClient. |
Proprietà
| pipeline | Pipeline usata da questo client per effettuare richieste |
Metodi
| cancel |
Annulla un'elaborazione o una traduzione in coda. Una traduzione non verrà annullata se è già stata completata o non è riuscita o annullata. Verrà restituita una richiesta non valida. Tutti i documenti che hanno completato la traduzione non verranno annullati e verranno addebitati. Se possibile, tutti i documenti in sospeso verranno annullati. |
| get |
Restituisce lo stato di traduzione per un documento specifico in base all'ID richiesta e all'ID documento. |
| get |
L'elenco dei formati supportati supportati dal servizio di Traduzione Documenti. L'elenco include l'estensione di file comune, nonché il tipo di contenuto se si usa l'API di caricamento. |
| get |
Restituisce lo stato di una richiesta di traduzione di documenti. Lo stato include lo stato complessivo della richiesta, nonché lo stato per i documenti che vengono tradotti come parte di tale richiesta. |
| list |
Restituisce lo stato per tutti i documenti in una richiesta di traduzione di documenti batch. Se il numero di documenti nella risposta supera il limite di paging, viene usato il paging sul lato server. Le risposte impaginate indicano un risultato parziale e includono un token di continuazione nella risposta. L'assenza di un token di continuazione significa che non sono disponibili pagine aggiuntive. le opzioni top, skip e maxPageSize possono essere usate per specificare un numero di risultati da restituire e un offset per la collezione. La parte superiore indica il numero totale di record che l'utente desidera restituire su tutte le pagine. Skip indica il numero di record da saltare dalla lista di stati dei documenti detenuta dal server in base al metodo di ordinamento specificato. Per impostazione predefinita, l'ordinamento viene eseguito in base all'ora di inizio decrescente. maxPageSize è il massimo degli elementi restituiti in una pagina. Se altri articoli vengono richiesti tramite top (o top non specificato e ci sono altri articoli da restituire), |
| list |
Restituisce un elenco di richieste batch inviate e lo stato per ogni richiesta. Questo elenco contiene solo le richieste batch inviate dall'utente (in base alla risorsa). Se il numero di richieste supera il limite di paging, viene usato il paging lato server. Le risposte impaginate indicano un risultato parziale e includono un token di continuazione nella risposta. L'assenza di un token di continuazione significa che non sono disponibili pagine aggiuntive. le opzioni top, skip e maxPageSize possono essere usate per specificare un numero di risultati da restituire e un offset per la collezione. La parte superiore indica il numero totale di record che l'utente desidera restituire su tutte le pagine. Skip indica il numero di record da saltare dall'elenco dei lotti in base al metodo di ordinamento specificato. Per impostazione predefinita, l'ordinamento viene eseguito in base all'ora di inizio decrescente. maxPageSize è il massimo degli elementi restituiti in una pagina. Se altri articoli vengono richiesti tramite top (o top non specificato e ci sono altri articoli da restituire), |
| start |
Usare questa API per inviare una richiesta di traduzione bulk (batch) al servizio di traduzione documenti. Ogni richiesta può contenere più documenti e deve contenere un contenitore di origine e di destinazione per ogni documento. Il filtro di prefisso e suffisso (se specificato) viene usato per filtrare le cartelle. Il prefisso viene applicato al sottopercorso dopo il nome del contenitore. La memoria di glossario/traduzione può essere inclusa nella richiesta e viene applicata dal servizio quando il documento viene tradotto. Se il glossario non è valido o non raggiungibile durante la traduzione, viene indicato un errore nello stato del documento. Se nella destinazione esiste già un file con lo stesso nome, verrà sovrascritto. TargetUrl per ogni lingua di destinazione deve essere univoco. |
Dettagli costruttore
DocumentTranslationClient(string, KeyCredential | TokenCredential, DocumentTranslationClientOptionalParams)
Crea un'istanza di DocumentTranslationClient.
new DocumentTranslationClient(endpointParam: string, credential: KeyCredential | TokenCredential, options?: DocumentTranslationClientOptionalParams)Parametri
- endpointParam
-
string
L'endpoint di Traduzione del Documento, ad https://<resource-name>.cognitiveservices.azure.comesempio .
- credential
Una credenziale chiave o un token utilizzato per autenticare le richieste al servizio.
Opzioni usate per configurare il client.
Dettagli proprietà
pipeline
Pipeline usata da questo client per effettuare richieste
pipeline: PipelineValore della proprietà
Dettagli metodo
cancelTranslation(string, CancelTranslationOptionalParams)
Annulla un'elaborazione o una traduzione in coda. Una traduzione non verrà annullata se è già stata completata o non è riuscita o annullata. Verrà restituita una richiesta non valida. Tutti i documenti che hanno completato la traduzione non verranno annullati e verranno addebitati. Se possibile, tutti i documenti in sospeso verranno annullati.
function cancelTranslation(translationId: string, options?: CancelTranslationOptionalParams): Promise<TranslationStatus>Parametri
- translationId
-
string
- options
- CancelTranslationOptionalParams
Valori restituiti
Promise<TranslationStatus>
getDocumentStatus(string, string, GetDocumentStatusOptionalParams)
Restituisce lo stato di traduzione per un documento specifico in base all'ID richiesta e all'ID documento.
function getDocumentStatus(translationId: string, documentId: string, options?: GetDocumentStatusOptionalParams): Promise<DocumentStatus>Parametri
- translationId
-
string
- documentId
-
string
- options
- GetDocumentStatusOptionalParams
Valori restituiti
Promise<DocumentStatus>
getSupportedFormats(FileFormatType, GetSupportedFormatsOptionalParams)
L'elenco dei formati supportati supportati dal servizio di Traduzione Documenti. L'elenco include l'estensione di file comune, nonché il tipo di contenuto se si usa l'API di caricamento.
function getSupportedFormats(typeParam: FileFormatType, options?: GetSupportedFormatsOptionalParams): Promise<SupportedFileFormats>Parametri
- typeParam
- FileFormatType
Valori restituiti
Promise<SupportedFileFormats>
getTranslationStatus(string, GetTranslationStatusOptionalParams)
Restituisce lo stato di una richiesta di traduzione di documenti. Lo stato include lo stato complessivo della richiesta, nonché lo stato per i documenti che vengono tradotti come parte di tale richiesta.
function getTranslationStatus(translationId: string, options?: GetTranslationStatusOptionalParams): Promise<TranslationStatus>Parametri
- translationId
-
string
Valori restituiti
Promise<TranslationStatus>
listDocumentStatuses(string, ListDocumentStatusesOptionalParams)
Restituisce lo stato per tutti i documenti in una richiesta di traduzione di documenti batch.
Se il numero di documenti nella risposta supera il limite di paging, viene usato il paging sul lato server. Le risposte impaginate indicano un risultato parziale e includono un token di continuazione nella risposta. L'assenza di un token di continuazione significa che non sono disponibili pagine aggiuntive.
le opzioni top, skip e maxPageSize possono essere usate per specificare un numero di risultati da restituire e un offset per la collezione.
La parte superiore indica il numero totale di record che l'utente desidera restituire su tutte le pagine. Skip indica il numero di record da saltare dalla lista di stati dei documenti detenuta dal server in base al metodo di ordinamento specificato. Per impostazione predefinita, l'ordinamento viene eseguito in base all'ora di inizio decrescente. maxPageSize è il massimo degli elementi restituiti in una pagina. Se altri articoli vengono richiesti tramite top (o top non specificato e ci sono altri articoli da restituire),
function listDocumentStatuses(translationId: string, options?: ListDocumentStatusesOptionalParams): PagedAsyncIterableIterator<DocumentStatus, DocumentStatus[], PageSettings>Parametri
- translationId
-
string
Valori restituiti
listTranslationStatuses(ListTranslationStatusesOptionalParams)
Restituisce un elenco di richieste batch inviate e lo stato per ogni richiesta. Questo elenco contiene solo le richieste batch inviate dall'utente (in base alla risorsa).
Se il numero di richieste supera il limite di paging, viene usato il paging lato server. Le risposte impaginate indicano un risultato parziale e includono un token di continuazione nella risposta. L'assenza di un token di continuazione significa che non sono disponibili pagine aggiuntive.
le opzioni top, skip e maxPageSize possono essere usate per specificare un numero di risultati da restituire e un offset per la collezione.
La parte superiore indica il numero totale di record che l'utente desidera restituire su tutte le pagine. Skip indica il numero di record da saltare dall'elenco dei lotti in base al metodo di ordinamento specificato. Per impostazione predefinita, l'ordinamento viene eseguito in base all'ora di inizio decrescente. maxPageSize è il massimo degli elementi restituiti in una pagina. Se altri articoli vengono richiesti tramite top (o top non specificato e ci sono altri articoli da restituire),
function listTranslationStatuses(options?: ListTranslationStatusesOptionalParams): PagedAsyncIterableIterator<TranslationStatus, TranslationStatus[], PageSettings>Parametri
Valori restituiti
startTranslation(StartTranslationDetails, StartTranslationOptionalParams)
Usare questa API per inviare una richiesta di traduzione bulk (batch) al servizio di traduzione documenti. Ogni richiesta può contenere più documenti e deve contenere un contenitore di origine e di destinazione per ogni documento.
Il filtro di prefisso e suffisso (se specificato) viene usato per filtrare le cartelle. Il prefisso viene applicato al sottopercorso dopo il nome del contenitore.
La memoria di glossario/traduzione può essere inclusa nella richiesta e viene applicata dal servizio quando il documento viene tradotto.
Se il glossario non è valido o non raggiungibile durante la traduzione, viene indicato un errore nello stato del documento. Se nella destinazione esiste già un file con lo stesso nome, verrà sovrascritto. TargetUrl per ogni lingua di destinazione deve essere univoco.
function startTranslation(body: StartTranslationDetails, options?: StartTranslationOptionalParams): PollerLike<OperationState<TranslationStatus>, TranslationStatus>Parametri
- options
- StartTranslationOptionalParams