DocumentTranslationClient class
Cliente para o serviço Azure AI Document Translation, usado para traduzir lotes de documentos armazenados no Armazenamento de Blobs do Azure.
Construtores
| Document |
Cria uma instância do DocumentTranslationClient. |
Propriedades
| pipeline | O pipeline usado por este cliente para fazer solicitações |
Métodos
| cancel |
Cancele uma tradução atualmente em processamento ou em fila. Uma tradução não será cancelada se já estiver concluída, se tiver falhado ou se tiver sido cancelada. Um pedido incorreto será devolvido. Todos os documentos que tenham tradução concluída não serão cancelados e serão cobrados. Todos os documentos pendentes serão cancelados se possível. |
| get |
Retorna o status de tradução de um documento específico com base na ID da solicitação e na ID do documento. |
| get |
A lista de formatos suportados suportados pelo serviço de Tradução de Documentos. A lista inclui a extensão de arquivo comum, bem como o tipo de conteúdo se estiver usando a API de upload. |
| get |
Retorna o status de uma solicitação de tradução de documento. O status inclui o status geral da solicitação, bem como o status dos documentos que estão sendo traduzidos como parte dessa solicitação. |
| list |
Retorna o status de todos os documentos em uma solicitação de tradução de documentos em lote. Se o número de documentos na resposta exceder nosso limite de paginação, a paginação do lado do servidor será usada. As respostas paginadas indicam um resultado parcial e incluem um token de continuação na resposta. A ausência de um token de continuação significa que não há páginas adicionais disponíveis. as opções top, skip e maxPageSize podem ser usadas para especificar um número de resultados a devolver e um deslocamento para a coleção. O topo indica o número total de registos que o utilizador quer que sejam devolvidos em todas as páginas. Skip indica o número de registos a saltar da lista de estados dos documentos mantida pelo servidor, com base no método de ordenação especificado. Por padrão, classificamos por hora de início decrescente. maxPageSize são os itens máximos devolvidos numa página. Se forem solicitados mais artigos através do topo (ou se o topo não for especificado e houver mais artigos a devolver), |
| list |
Retorna uma lista de solicitações em lote enviadas e o status de cada solicitação. Essa lista contém apenas solicitações em lote enviadas pelo usuário (com base no recurso). Se o número de solicitações exceder nosso limite de paginação, a paginação do lado do servidor será usada. As respostas paginadas indicam um resultado parcial e incluem um token de continuação na resposta. A ausência de um token de continuação significa que não há páginas adicionais disponíveis. as opções top, skip e maxPageSize podem ser usadas para especificar um número de resultados a devolver e um deslocamento para a coleção. O topo indica o número total de registos que o utilizador quer que sejam devolvidos em todas as páginas. Saltar indica o número de registos a saltar da lista de lotes com base no método de ordenação especificado. Por padrão, classificamos por hora de início decrescente. maxPageSize são os itens máximos devolvidos numa página. Se forem solicitados mais artigos através do topo (ou se o topo não for especificado e houver mais artigos a devolver), |
| start |
Use esta API para enviar uma solicitação de tradução em massa (lote) para o serviço de Tradução de Documentos. Cada solicitação pode conter vários documentos e deve conter um contêiner de origem e destino para cada documento. O filtro de prefixo e sufixo (se fornecido) são usados para filtrar pastas. O prefixo é aplicado ao subcaminho após o nome do contêiner. Glossários/memória de tradução podem ser incluídos no pedido e são aplicados pelo serviço quando o documento é traduzido. Se o glossário for inválido ou inacessível durante a tradução, será indicado um erro no estado do documento. Se um arquivo com o mesmo nome já existir no destino, ele será substituído. O targetUrl para cada idioma de destino deve ser exclusivo. |
Detalhes do Construtor
DocumentTranslationClient(string, KeyCredential | TokenCredential, DocumentTranslationClientOptionalParams)
Cria uma instância do DocumentTranslationClient.
new DocumentTranslationClient(endpointParam: string, credential: KeyCredential | TokenCredential, options?: DocumentTranslationClientOptionalParams)Parâmetros
- endpointParam
-
string
O endpoint de Tradução de Documentos, por exemplo https://<resource-name>.cognitiveservices.azure.com.
- credential
Uma credencial-chave ou credencial token usada para autenticar pedidos ao serviço.
Opções usadas para configurar o cliente.
Detalhes de Propriedade
pipeline
O pipeline usado por este cliente para fazer solicitações
pipeline: PipelineValor de Propriedade
Detalhes de Método
cancelTranslation(string, CancelTranslationOptionalParams)
Cancele uma tradução atualmente em processamento ou em fila. Uma tradução não será cancelada se já estiver concluída, se tiver falhado ou se tiver sido cancelada. Um pedido incorreto será devolvido. Todos os documentos que tenham tradução concluída não serão cancelados e serão cobrados. Todos os documentos pendentes serão cancelados se possível.
function cancelTranslation(translationId: string, options?: CancelTranslationOptionalParams): Promise<TranslationStatus>Parâmetros
- translationId
-
string
- options
- CancelTranslationOptionalParams
Devoluções
Promise<TranslationStatus>
getDocumentStatus(string, string, GetDocumentStatusOptionalParams)
Retorna o status de tradução de um documento específico com base na ID da solicitação e na ID do documento.
function getDocumentStatus(translationId: string, documentId: string, options?: GetDocumentStatusOptionalParams): Promise<DocumentStatus>Parâmetros
- translationId
-
string
- documentId
-
string
- options
- GetDocumentStatusOptionalParams
Devoluções
Promise<DocumentStatus>
getSupportedFormats(FileFormatType, GetSupportedFormatsOptionalParams)
A lista de formatos suportados suportados pelo serviço de Tradução de Documentos. A lista inclui a extensão de arquivo comum, bem como o tipo de conteúdo se estiver usando a API de upload.
function getSupportedFormats(typeParam: FileFormatType, options?: GetSupportedFormatsOptionalParams): Promise<SupportedFileFormats>Parâmetros
- typeParam
- FileFormatType
Devoluções
Promise<SupportedFileFormats>
getTranslationStatus(string, GetTranslationStatusOptionalParams)
Retorna o status de uma solicitação de tradução de documento. O status inclui o status geral da solicitação, bem como o status dos documentos que estão sendo traduzidos como parte dessa solicitação.
function getTranslationStatus(translationId: string, options?: GetTranslationStatusOptionalParams): Promise<TranslationStatus>Parâmetros
- translationId
-
string
Devoluções
Promise<TranslationStatus>
listDocumentStatuses(string, ListDocumentStatusesOptionalParams)
Retorna o status de todos os documentos em uma solicitação de tradução de documentos em lote.
Se o número de documentos na resposta exceder nosso limite de paginação, a paginação do lado do servidor será usada. As respostas paginadas indicam um resultado parcial e incluem um token de continuação na resposta. A ausência de um token de continuação significa que não há páginas adicionais disponíveis.
as opções top, skip e maxPageSize podem ser usadas para especificar um número de resultados a devolver e um deslocamento para a coleção.
O topo indica o número total de registos que o utilizador quer que sejam devolvidos em todas as páginas. Skip indica o número de registos a saltar da lista de estados dos documentos mantida pelo servidor, com base no método de ordenação especificado. Por padrão, classificamos por hora de início decrescente. maxPageSize são os itens máximos devolvidos numa página. Se forem solicitados mais artigos através do topo (ou se o topo não for especificado e houver mais artigos a devolver),
function listDocumentStatuses(translationId: string, options?: ListDocumentStatusesOptionalParams): PagedAsyncIterableIterator<DocumentStatus, DocumentStatus[], PageSettings>Parâmetros
- translationId
-
string
Devoluções
listTranslationStatuses(ListTranslationStatusesOptionalParams)
Retorna uma lista de solicitações em lote enviadas e o status de cada solicitação. Essa lista contém apenas solicitações em lote enviadas pelo usuário (com base no recurso).
Se o número de solicitações exceder nosso limite de paginação, a paginação do lado do servidor será usada. As respostas paginadas indicam um resultado parcial e incluem um token de continuação na resposta. A ausência de um token de continuação significa que não há páginas adicionais disponíveis.
as opções top, skip e maxPageSize podem ser usadas para especificar um número de resultados a devolver e um deslocamento para a coleção.
O topo indica o número total de registos que o utilizador quer que sejam devolvidos em todas as páginas. Saltar indica o número de registos a saltar da lista de lotes com base no método de ordenação especificado. Por padrão, classificamos por hora de início decrescente. maxPageSize são os itens máximos devolvidos numa página. Se forem solicitados mais artigos através do topo (ou se o topo não for especificado e houver mais artigos a devolver),
function listTranslationStatuses(options?: ListTranslationStatusesOptionalParams): PagedAsyncIterableIterator<TranslationStatus, TranslationStatus[], PageSettings>Parâmetros
Devoluções
startTranslation(StartTranslationDetails, StartTranslationOptionalParams)
Use esta API para enviar uma solicitação de tradução em massa (lote) para o serviço de Tradução de Documentos. Cada solicitação pode conter vários documentos e deve conter um contêiner de origem e destino para cada documento.
O filtro de prefixo e sufixo (se fornecido) são usados para filtrar pastas. O prefixo é aplicado ao subcaminho após o nome do contêiner.
Glossários/memória de tradução podem ser incluídos no pedido e são aplicados pelo serviço quando o documento é traduzido.
Se o glossário for inválido ou inacessível durante a tradução, será indicado um erro no estado do documento. Se um arquivo com o mesmo nome já existir no destino, ele será substituído. O targetUrl para cada idioma de destino deve ser exclusivo.
function startTranslation(body: StartTranslationDetails, options?: StartTranslationOptionalParams): PollerLike<OperationState<TranslationStatus>, TranslationStatus>Parâmetros
- options
- StartTranslationOptionalParams