Custom Models - Get

Referência

Serviço:: Azure AI Services

Versão da API:: 2.1

Obter informações detalhadas sobre um modelo personalizado.

GET {endpoint}/formrecognizer/v2.1/custom/models/{modelId}

Com parâmetros opcionais:

GET {endpoint}/formrecognizer/v2.1/custom/models/{modelId}?includeKeys={includeKeys}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus2.api.cognitive.microsoft.com).
modelId	path	True	string uuid	Identificador de modelo.
includeKeys	query		boolean	Inclua a lista de chaves extraídas nas informações do modelo.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respostas

Nome	Tipo	Description
200 OK	Model	Êxito
Other Status Codes	ErrorResponse	Entidade de resposta que acompanha respostas não bem-sucedidas que contêm detalhes adicionais sobre o erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Get custom model

Solicitação de exemplo

HTTP

GET {endpoint}/formrecognizer/v2.1/custom/models/f973e3c1-1148-43bb-bea8-49d0603ab3a8

Resposta de exemplo

Código de status:: 200

{
  "modelInfo": {
    "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8",
    "modelName": "my composed model",
    "status": "ready",
    "createdDateTime": "2019-05-01T10:53:21Z",
    "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
    "attributes": {
      "isComposed": true
    }
  },
  "keys": {
    "clusters": {
      "0": [
        "Invoice",
        "123112313"
      ],
      "1": [
        "Please remit payment to:",
        "Microsoft"
      ]
    }
  },
  "trainResult": {
    "trainingDocuments": [],
    "fields": [],
    "averageModelAccuracy": 0,
    "errors": []
  },
  "composedTrainResults": [
    {
      "modelId": "4afb20d6-3ed0-4cde-ba40-dbd6207268dd",
      "trainingDocuments": [],
      "fields": [],
      "averageModelAccuracy": 0,
      "errors": []
    },
    {
      "modelId": "6f841356-aa32-42c9-a739-2182c47b79c9",
      "trainingDocuments": [],
      "fields": [],
      "averageModelAccuracy": 0,
      "errors": []
    }
  ]
}

Definições

Nome	Description
Attributes	Atributos de modelo opcionais.
ErrorInformation
ErrorResponse
FormFieldsReport	Relatório para um campo de treinamento de modelo personalizado.
KeysResult	Chaves extraídas pelo modelo personalizado.
Model	Resposta à operação obter modelo personalizado.
ModelInfo	Informações básicas do modelo personalizado.
ModelStatus	Status do modelo.
TrainingDocumentInfo	Relatório de um documento de treinamento de modelo personalizado.
TrainResult	Resultado do treinamento de modelo personalizado.
TrainStatus	Status da operação de treinamento.

Attributes

Atributos de modelo opcionais.

Nome	Tipo	Valor padrão	Description
isComposed	boolean	False	Esse modelo é composto? (padrão: false).

ErrorInformation

Nome	Tipo	Description
code	string
message	string

ErrorResponse

Nome	Tipo	Description
error	ErrorInformation

FormFieldsReport

Relatório para um campo de treinamento de modelo personalizado.

Nome	Tipo	Description
accuracy	number	Precisão estimada da extração para este campo.
fieldName	string	Nome do campo de treinamento.

KeysResult

Chaves extraídas pelo modelo personalizado.

Nome	Tipo	Description
clusters	object	ClusterIds de mapeamento de objeto para uma lista de chaves.

Model

Resposta à operação obter modelo personalizado.

Nome	Tipo	Description
composedTrainResults	TrainResult[]	Resultado do treinamento para o modelo composto.
keys	KeysResult	Chaves extraídas pelo modelo personalizado.
modelInfo	ModelInfo	Informações básicas do modelo personalizado.
trainResult	TrainResult	Resultado do treinamento para o modelo personalizado.

ModelInfo

Informações básicas do modelo personalizado.

Nome	Tipo	Description
attributes	Attributes	Atributos de modelo opcionais.
createdDateTime	string	Data e hora (UTC) quando o modelo foi criado.
lastUpdatedDateTime	string	Data e hora (UTC) em que o status foi atualizado pela última vez.
modelId	string	Identificador de modelo.
modelName	string	Nome de modelo definido pelo usuário opcional (comprimento máximo: 1024).
status	ModelStatus	Status do modelo.

ModelStatus

Status do modelo.

Nome	Tipo	Description
creating	string
invalid	string
ready	string

TrainingDocumentInfo

Relatório de um documento de treinamento de modelo personalizado.

Nome	Tipo	Description
documentName	string	Nome do documento de treinamento.
errors	ErrorInformation[]	Lista de erros.
pages	integer	Número total de páginas treinadas.
status	TrainStatus	Status da operação de treinamento.

TrainResult

Resultado do treinamento de modelo personalizado.

Nome	Tipo	Description
averageModelAccuracy	number	Precisão média.
errors	ErrorInformation[]	Erros retornados durante a operação de treinamento.
fields	FormFieldsReport[]	Lista de campos usados para treinar o modelo e o erro de operação de treinamento relatado por cada um.
modelId	string	Identificador de modelo.
trainingDocuments	TrainingDocumentInfo[]	Lista dos documentos usados para treinar o modelo e quaisquer erros relatados em cada documento.

TrainStatus

Status da operação de treinamento.

Nome	Tipo	Description
failed	string
partiallySucceeded	string
succeeded	string

Compartilhar via