Obter o status de todos os documentos

Artigo
09/01/2024

Recurso de referência
: Azure AI Translator → Document Translation
API Versão: 2024-05-01
Método HTTP: GET

Importante

Todas as solicitações de API para o recurso Tradução de Documentos exigem um ponto de extremidade de domínio personalizado localizado na página de visão geral do recurso no portal do Azure.

Use o método para solicitar o get documents status status de todos os documentos em um trabalho de tradução.
$top, $skipe $maxpagesize os parâmetros de consulta podem ser usados para especificar o número de resultados a serem retornados e um deslocamento para a coleção.
- $top Indica o número total de registros que o usuário deseja que sejam retornados em todas as páginas.
- $skip Indica o número de registros a serem ignorados da lista de status do documento mantida pelo servidor com base no método de classificação especificado. Por padrão, os registros são classificados por hora de início decrescente.
- $maxpagesize é o máximo de itens retornados em uma página.
- Se mais itens forem solicitados via $top (ou $top não for especificado e houver mais itens a serem devolvidos), @nextLink conterá o link para a próxima página.
- 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 nenhuma outra página está disponível.

Nota

Se o servidor não puder honrar $top e/ou $skip, o servidor deve retornar um erro para o cliente informando sobre isso em vez de apenas ignorar as opções de consulta. Isso reduz o risco de o cliente fazer suposições sobre os dados retornados.

$orderBy O parâmetro query pode ser usado para classificar a lista retornada (ex: $orderBy=createdDateTimeUtc asc ou $orderBy=createdDateTimeUtc desc).
A classificação padrão é decrescente por createdDateTimeUtc. Alguns parâmetros de consulta podem ser usados para filtrar a lista retornada (ex: status=Succeeded,Cancelled) apenas retorna documentos bem-sucedidos e cancelados.
Os createdDateTimeUtcStart parâmetros de consulta e createdDateTimeUtcEnd podem ser usados combinados ou separadamente para especificar um intervalo de data/hora para filtrar a lista retornada.
Os parâmetros de consulta de filtragem suportados são (status, id, createdDateTimeUtcStarte createdDateTimeUtcEnd).
Quando ambos $top e $skip estão incluídos, o servidor deve primeiro aplicar $skip e, em seguida, $top na coleção.

URL do Pedido

Envie um pedido GET para:

  curl -i -X GET "{document-translation-endpoint}/translator/document/batches/{id}/documents?api-version={date}"

Localizando o `id` valor

Você pode encontrar o trabalho id no valor URL do cabeçalho Operation-Location de resposta do método POSTstart-batch-translation. A cadeia alfanumérica que segue o /document/ parâmetro é o trabalho idda operação:

Cabeçalho da resposta	URL de resposta
Local de Operação	{document-translation-endpoint}/translator/document/`9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec`?api-version=2024-05-01

Você também pode usar uma solicitação get-translations-status para recuperar uma lista de trabalhos de tradução e seus ids.

Parâmetros de solicitação

Os parâmetros de solicitação passados na cadeia de caracteres de consulta são:

Parâmetro de consulta	Em	Necessário	Type	Description
`id`	path	True	string	O ID da operação.
`$maxpagesize`	query	False	inteiro int32	`$maxpagesize` é o máximo de itens retornados em uma página. Se mais itens forem solicitados via `$top` (ou `$top` não for especificado e houver mais itens a serem devolvidos), @nextLink conterá o link para a próxima página. Os clientes podem solicitar paginação orientada por servidor com um tamanho de página específico especificando uma `$maxpagesize` preferência. O servidor DEVE honrar essa preferência se o tamanho de página especificado for menor do que o tamanho de página padrão do servidor.
$orderBy	query	False	matriz	A consulta de classificação para a coleção (ex: `CreatedDateTimeUtc asc`, `CreatedDateTimeUtc desc`).
`$skip`	query	False	inteiro int32	$skip indica o número de registros a serem ignorados da lista de registros mantidos pelo servidor com base no método de classificação especificado. Por padrão, classificamos por hora de início decrescente. Os clientes PODEM usar parâmetros de $top e `$skip` consulta para especificar o número de resultados a serem retornados e um deslocamento na coleção. Quando o cliente retorna ambos `$top` e `$skip`, o servidor DEVE primeiro aplicar `$skip` e, em seguida, `$top` na coleção. Se o servidor não puder honrar `$top` e/ou `$skip`, o servidor DEVE retornar um erro para o cliente informando sobre ele em vez de apenas ignorar as opções de consulta.
`$top`	query	False	inteiro int32	`$top` Indica o número total de registros que o usuário deseja que sejam retornados em todas as páginas. Os clientes podem usar `$top` e `$skip` consultar parâmetros para especificar o número de resultados a serem retornados e um deslocamento na coleção. Quando o cliente retorna ambos `$top` e `$skip`, o servidor DEVE primeiro aplicar `$skip` e, em seguida, `$top` na coleção. Se o servidor não puder honrar `$top` e/ou `$skip`, o servidor DEVE retornar um erro para o cliente informando sobre ele em vez de apenas ignorar as opções de consulta.
createdDateTimeUtcEnd	query	False	data-hora da cadeia de caracteres	A data/hora final para obter itens antes.
createdDateTimeUtcStart	query	False	data-hora da cadeia de caracteres	A data/hora de início para obter itens depois.
`ids`	query	False	matriz	IDs para usar na filtragem.
estados	query	False	matriz	Status a ser usado na filtragem.

Cabeçalhos do pedido

Os cabeçalhos de solicitação são:

Cabeçalhos	Description	Condição
ocp-apim-subscription-key	Sua chave de API de serviço do Translator no portal do Azure.	Obrigatório
OCP-Apim-Assinatura-Região	A região onde o recurso foi criado.	Necessário ao usar um recurso regional (geográfico) como West US
Tipo de conteúdo	O tipo de conteúdo da carga útil. O valor aceito é application/json ou charset=UTF-8.	Obrigatório

Códigos de status de resposta

A seguir estão os possíveis códigos de status HTTP que uma solicitação retorna.

Código de Estado	Description
200	OK. Solicitação bem-sucedida e retorna o status dos documentos. HeadersRetry-After: inteiroETag: string
400	Pedido inválido. Verifique os parâmetros de entrada.
401	Não autorizado. Verifique as suas credenciais.
404	O recurso não foi encontrado.
500	Erro interno do servidor.
Outros códigos de status	• Demasiados pedidos • O servidor está temporariamente indisponível

Obter resposta de status de documentos

Resposta de status de documentos bem-sucedida

As informações a seguir são retornadas em uma resposta bem-sucedida.

Nome	Tipo	Description
@nextLink	string	Url para a próxima página. Nulo se não houver mais páginas disponíveis.
valor	Status do documento []	A lista de status detalhada de documentos individuais.
valor.caminho	string	Localização do documento ou pasta.
value.sourcePath	string	Localização do documento de origem.
value.createdDateTimeUtc	string	Operação criada data hora.
valor.lastActionDateTimeUtc	string	Data em que o status da operação é atualizado.
valor.status	status	Lista de possíveis status para trabalho ou documento. • Cancelado • Cancelamento • Falhou • NotStarted • Corrida • Bem sucedido • ValidaçãoFalhou
value.to	string	À linguagem.
valor.progresso	Número	Progresso da tradução, se disponível.
value.id	string	ID do documento.
valor.characterCharged	integer	Caracteres cobrados pela API.

Resposta de erro

Nome	Tipo	Description
code	string	Enums contendo códigos de erro de alto nível. Valores possíveis: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiçoIndisponível • Não autorizado
mensagem	string	Obtém mensagem de erro de alto nível.
destino	string	Obtém a origem do erro. Por exemplo, seria `documents` ou `document id` para um documento inválido.
innerError	InnerTranslationError	Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de serviços de IA do Azure. Esta mensagem de erro contém as propriedades necessárias ErrorCode, mensagem e destino de propriedades opcionais, detalhes (par de valores de chave), erro interno (pode ser aninhado).
innerError.code	string	Obtém a cadeia de erro de código.
innerError.message	string	Obtém mensagem de erro de alto nível.
innerError.target	string	Obtém a origem do erro. Por exemplo, seria `documents` ou `document id` se houvesse um documento inválido.

Exemplos

Gorjeta

Use esse método para recuperar o documentId parâmetro para a cadeia de caracteres de consulta get-document-status .

Exemplo de resposta bem-sucedida

O objeto JSON a seguir é um exemplo de uma resposta bem-sucedida.

{
  "value": [
    {
      "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt",
      "sourcePath": "https://myblob.blob.core.windows.net/sourceContainer/fr/mydoc.txt",
      "createdDateTimeUtc": "2020-03-26T00:00:00Z",
      "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
      "status": "Running",
      "to": "fr",
      "progress": 0.1,
      "id": "273622bd-835c-4946-9798-fd8f19f6bbf2",
      "characterCharged": 0
    }
  ],
  "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=5&$skip=15"
}

Exemplo de resposta de erro

O objeto JSON a seguir é um exemplo de uma resposta de erro. O esquema para outros códigos de erro é o mesmo.

Código de status: 500

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "target": "Operation",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

Próximos passos

Siga nosso guia de início rápido para saber mais sobre como usar a Tradução de Documentos e a biblioteca do cliente.

Introdução à Tradução de Documentos

Partilhar via

Obter o status de todos os documentos

URL do Pedido

Localizando o `id` valor

Parâmetros de solicitação

Cabeçalhos do pedido

Códigos de status de resposta

Obter resposta de status de documentos

Resposta de status de documentos bem-sucedida

Resposta de erro

Exemplos

Exemplo de resposta bem-sucedida

Exemplo de resposta de erro

Próximos passos

Comentários

Recursos adicionais

Partilhar via

Obter o status de todos os documentos

URL do Pedido

Localizando o id valor

Parâmetros de solicitação

Cabeçalhos do pedido

Códigos de status de resposta

Obter resposta de status de documentos

Resposta de status de documentos bem-sucedida

Resposta de erro

Exemplos

Exemplo de resposta bem-sucedida

Exemplo de resposta de erro

Próximos passos

Comentários

Recursos adicionais

Localizando o `id` valor