Custom Models - Get

Referência

Serviço:: Azure AI Services

Versão da API:: 2.1

Obtenha 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 do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, 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 do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respostas

Name	Tipo	Description
200 OK	Model	Com ê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

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

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

Attributes

Atributos de modelo opcionais.

Name	Tipo	Default value	Description
isComposed	boolean	False	Este modelo é composto? (predefinição: falso).

ErrorInformation

Name	Tipo	Description
code	string
message	string

ErrorResponse

Name	Tipo	Description
error	ErrorInformation

FormFieldsReport

Relatório para um campo de preparação de modelos personalizados.

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

KeysResult

Chaves extraídas pelo modelo personalizado.

Name	Tipo	Description
clusters	object	ClusterIds de mapeamento de objetos para uma lista de chaves.

Model

Resposta à operação obter modelo personalizado.

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

ModelInfo

Informações básicas do modelo personalizado.

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

ModelStatus

Estado do modelo.

Name	Tipo	Description
creating	string
invalid	string
ready	string

TrainingDocumentInfo

Relatório para um documento de preparação de modelos personalizados.

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

TrainResult

Resultado de preparação de modelos personalizados.

Name	Tipo	Description
averageModelAccuracy	number	Precisão média.
errors	ErrorInformation[]	Erros devolvidos durante a operação de preparação.
fields	FormFieldsReport[]	Lista de campos utilizados para preparar o modelo e o erro de operação de preparação comunicado por cada um.
modelId	string	Identificador de modelo.
trainingDocuments	TrainingDocumentInfo[]	Lista dos documentos utilizados para preparar o modelo e quaisquer erros comunicados em cada documento.

TrainStatus

Estado da operação de preparação.

Name	Tipo	Description
failed	string
partiallySucceeded	string
succeeded	string

Partilhar via