Partilhar via

Obter status para todos os trabalhos de tradução

  • Artigo

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

  • Use o get translations status método para solicitar uma lista e o status de todos os trabalhos de tradução enviados pelo usuário (associado ao recurso).

  • $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 a serem retornados em todas as páginas.
    • $skip Indica o número de registros a serem ignorados da lista de lotes 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.
    • O servidor honra os valores especificados pelo cliente. No entanto, os clientes devem estar preparados para lidar com respostas que contenham um tamanho de página diferente ou um token de continuação.
    • Quando ambos $top forem $skip incluídos, o servidor primeiro se aplicará $skip e, em seguida $top , na coleção.

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) retorna operações bem-sucedidas e canceladas.
    • 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).

URL do Pedido

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

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.

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
$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 $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. Nota: 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. Nota: 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.
statuses 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.
e bala.
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 de todas as operações. HeadersRetry-After: inteiroETag: string
400 Mau pedido. Pedido inválido. Verifique os parâmetros de entrada.
401 Não autorizado. Verifique as suas credenciais.
500 Erro interno do servidor.
Outros códigos de status • Demasiados pedidos
• Servidor temporariamente indisponível

Obter resposta de status de traduções

Resposta de status de traduções 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 TranslationStatus[] Matriz TranslationStatus[]
value.id string ID da operação.
value.createdDateTimeUtc string Operação criada data hora.
valor.lastActionDateTimeUtc string Data em que o status da operação foi atualizado.
valor.status String Lista de possíveis status para trabalho ou documento:
• Cancelado
• Cancelamento
• Falhou
• NotStarted
• Corrida
• Bem sucedido
• ValidaçãoFalhou
valor.resumo StatusSummary[] Resumo contendo os detalhes listados.
valor.resumo.total integer Contagem do total de documentos.
value.summary.failed integer Falha na contagem de documentos.
valor.resumo.sucesso integer Contagem de documentos traduzidos com sucesso.
value.summary.inProgresso integer Contagem de documentos em curso.
value.summary.notYetStarted integer Contagem de documentos ainda não iniciados no processamento.
valor.summary.cancelado integer Contagem de documentos cancelados.
value.summary.totalCharacterCharged integer Contagem total de caracteres cobrados.

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 se houvesse 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

Você pode usar esse método para recuperar o parâmetro job id para a cadeia de caracteres de consulta get-translation-status .

Exemplo de resposta bem-sucedida

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

{
    "value": [
        {
            "id": "36724748-f7a0-4db7-b7fd-f041ddc75033",
            "createdDateTimeUtc": "2021-06-18T03:35:30.153374Z",
            "lastActionDateTimeUtc": "2021-06-18T03:36:44.6155316Z",
            "status": "Succeeded",
            "summary": {
                "total": 3,
                "failed": 2,
                "success": 1,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "1c7399a7-6913-4f20-bb43-e2fe2ba1a67d",
            "createdDateTimeUtc": "2021-05-24T17:57:43.8356624Z",
            "lastActionDateTimeUtc": "2021-05-24T17:57:47.128391Z",
            "status": "Failed",
            "summary": {
                "total": 1,
                "failed": 1,
                "success": 0,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "daa2a646-4237-4f5f-9a48-d515c2d9af3c",
            "createdDateTimeUtc": "2021-04-14T19:49:26.988272Z",
            "lastActionDateTimeUtc": "2021-04-14T19:49:43.9818634Z",
            "status": "Succeeded",
            "summary": {
                "total": 2,
                "failed": 0,
                "success": 2,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 21899
            }
        }
    ],
    ""@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operations/727BF148-F327-47A0-9481-ABAE6362F11E/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