Partilhar via

Analyzers - Get Operation Status

  • Referência
Serviço:
Azure AI Services
Versão da API:
2024-12-01-preview

Obtenha o status de uma operação de criação do analisador.

GET {endpoint}/contentunderstanding/analyzers/{analyzerId}/operations/{operationId}?api-version=2024-12-01-preview

Parâmetros do URI

Name Em Necessário Tipo Description
analyzerId
 path True

string

O identificador exclusivo do analisador.

Padrão Regex: ^[a-zA-Z0-9._-]{1,64}$
endpoint
 path True

string

uri

Ponto de extremidade do serviço de Compreensão de Conteúdo.
operationId
 path True

string

O ID exclusivo da operação.
api-version
 query True

string

A versão da API a ser usada para esta operação.

Respostas

Name Tipo Description
200 OK

O pedido foi bem-sucedido.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Âmbitos

Name Description
https://cognitiveservices.azure.com/.default

Exemplos

Get Analyzer Operation Status

Pedido de amostra

GET {endpoint}/contentunderstanding/analyzers/myAnalyzer/operations/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-12-01-preview

Resposta da amostra

Código de estado:
200 
{
  "id": "3b31320d-8bab-4f88-b19c-2322a7f11034",
  "status": "Succeeded",
  "result": {
    "analyzerId": "myAnalyzer",
    "description": "My custom analyzer",
    "tags": {
      "createdBy": "John"
    },
    "status": "creating",
    "createdAt": "2024-10-14T18:46:36.051Z",
    "lastModifiedAt": "2024-10-14T18:46:36.051Z",
    "baseAnalyzerId": "prebuilt-document",
    "config": {
      "locales": null,
      "enableFace": false,
      "enableOcr": true,
      "enableLayout": true,
      "enableBarcode": true,
      "enableFormula": false,
      "returnDetails": true
    },
    "fieldSchema": {
      "name": "MyForm",
      "description": "My custom form",
      "fields": {
        "Company": {
          "type": "string",
          "description": "Name of company."
        }
      },
      "definitions": {}
    },
    "trainingData": {
      "kind": "blob",
      "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
      "prefix": "trainingData",
      "fileListPath": "trainingData/fileList.jsonl"
    }
  }
}

Definições

Name Description
Azure.Core.Foundations.Error

O objeto de erro.
Azure.Core.Foundations.ErrorResponse

Uma resposta contendo detalhes do erro.
Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Azure.Core.Foundations.Error

O objeto de erro.

Name Tipo Description
code

string

Um de um conjunto de códigos de erro definido pelo servidor.
details

Azure.Core.Foundations.Error[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message

string

Uma representação legível por humanos do erro.
target

string

O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta contendo detalhes do erro.

Name Tipo Description
error

Azure.Core.Foundations.Error

O objeto de erro.

Azure.Core.Foundations.InnerError

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Tipo Description
code

string

Um de um conjunto de códigos de erro definido pelo servidor.
innererror

Azure.Core.Foundations.InnerError

Erro interno.