Custom Models - List

Referência

Serviço:: Azure AI Services

Versão da API:: 2.1

Obter informações sobre todos os modelos personalizados

GET {endpoint}/formrecognizer/v2.1/custom/models?op=full

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).
op	query	True	string	Especifique se pretende devolver o resumo ou a lista completa de modelos.

Cabeçalho do Pedido

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

Respostas

Name	Tipo	Description
200 OK	Models	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

List custom models

Pedido de amostra

HTTP

GET {endpoint}/formrecognizer/v2.1/custom/models?op=full

Resposta da amostra

Código de estado:: 200

{
  "summary": {
    "count": 2,
    "limit": 5000,
    "lastUpdatedDateTime": "2019-05-01T10:53:21Z"
  },
  "modelList": [
    {
      "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8",
      "modelName": "test model 1",
      "status": "ready",
      "createdDateTime": "2019-05-01T10:53:21Z",
      "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
      "attributes": {
        "isComposed": false
      }
    },
    {
      "modelId": "f973e3c1-0001-43bb-bea8-49d0603ab3a8",
      "modelName": "test model 2",
      "status": "ready",
      "createdDateTime": "2019-05-01T10:53:21Z",
      "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
      "attributes": {
        "isComposed": true
      }
    }
  ],
  "nextLink": ""
}

Definições

Name	Description
Attributes	Atributos de modelo opcionais.
ErrorInformation
ErrorResponse
ModelInfo	Informações básicas do modelo personalizado.
Models	Resposta à operação de modelos personalizados de lista.
ModelStatus	Estado do modelo.
Summary	Resumo de todos os modelos personalizados preparados.

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

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.

Models

Resposta à operação de modelos personalizados de lista.

Name	Tipo	Description
modelList	ModelInfo[]	Coleção de modelos personalizados preparados.
nextLink	string	Ligação para a página seguinte de modelos personalizados.
summary	Summary	Resumo de todos os modelos personalizados preparados.

ModelStatus

Estado do modelo.

Name	Tipo	Description
creating	string
invalid	string
ready	string

Summary

Resumo de todos os modelos personalizados preparados.

Name	Tipo	Description
count	integer	Contagem atual de modelos personalizados preparados.
lastUpdatedDateTime	string	Data e hora (UTC) em que o resumo foi atualizado pela última vez.
limit	integer	Número máximo de modelos que podem ser preparados para esta conta.

Partilhar via