Document Models - Get Model

Referência

Service:: Azure AI Services

API Version:: 2024-02-29-preview

Obtém informações detalhadas sobre o modelo de documento.

GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-02-29-preview

Parâmetros do URI

Name Em Necessário Tipo Description

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O ponto final do serviço Document Intelligence.
modelId	path	True	string	Nome exclusivo do modelo de documento. Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$`
api-version	query	True	string	A versão da API a utilizar para esta operação.

endpoint

path

True

string

O ponto final do serviço Document Intelligence.

modelId

path

True

string

Nome exclusivo do modelo de documento.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

api-version

query

True

string

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

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	Um identificador de cadeia opaco, globalmente exclusivo, gerado pelo cliente para o pedido.

Respostas

Name	Tipo	Description
200 OK	DocumentModelDetails	O pedido foi bem-sucedido. Headers x-ms-client-request-id: string
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Name

Tipo

Description

200 OK

DocumentModelDetails

O pedido foi bem-sucedido.

Headers

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Exemplos

Get Custom Document Model

Get Prebuilt Document Model

Get Custom Document Model

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/myCustomModel?api-version=2024-02-29-preview

Sample Response

Status code:: 200

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-02-29-preview",
  "docTypes": {
    "myForm": {
      "fieldSchema": {
        "Name": {
          "type": "string"
        },
        "Date": {
          "type": "date"
        },
        "Amount": {
          "type": "number"
        }
      },
      "buildMode": "template",
      "fieldConfidence": {
        "Name": 0.9,
        "Date": 0.95,
        "Amount": 0.93
      }
    }
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

Get Prebuilt Document Model

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice?api-version=2024-02-29-preview

Sample Response

Status code:: 200

{
  "modelId": "prebuilt-invoice",
  "description": "Prebuilt model to extract key information from English invoices, including customer, vendor, invoice ID, due date, total, and more.",
  "createdDateTime": "2021-07-30T00:00:00Z",
  "apiVersion": "2024-02-29-preview",
  "docTypes": {
    "prebuilt:invoice": {
      "fieldSchema": {
        "CustomerName": {
          "type": "string"
        },
        "CustomerId": {
          "type": "string"
        },
        "PurchaseOrder": {
          "type": "string"
        },
        "InvoiceId": {
          "type": "string"
        },
        "InvoiceDate": {
          "type": "date"
        },
        "DueDate": {
          "type": "date"
        },
        "VendorName": {
          "type": "string"
        },
        "VendorAddress": {
          "type": "string"
        },
        "VendorAddressRecipient": {
          "type": "string"
        },
        "CustomerAddress": {
          "type": "string"
        },
        "CustomerAddressRecipient": {
          "type": "string"
        },
        "BillingAddress": {
          "type": "string"
        },
        "BillingAddressRecipient": {
          "type": "string"
        },
        "ShippingAddress": {
          "type": "string"
        },
        "ShippingAddressRecipient": {
          "type": "string"
        },
        "SubTotal": {
          "type": "number"
        },
        "TotalTax": {
          "type": "number"
        },
        "InvoiceTotal": {
          "type": "number"
        },
        "AmountDue": {
          "type": "number"
        },
        "PreviousUnpaidBalance": {
          "type": "number"
        },
        "RemittanceAddress": {
          "type": "string"
        },
        "RemittanceAddressRecipient": {
          "type": "string"
        },
        "ServiceAddress": {
          "type": "string"
        },
        "ServiceAddressRecipient": {
          "type": "string"
        },
        "ServiceStartDate": {
          "type": "date"
        },
        "ServiceEndDate": {
          "type": "date"
        },
        "Items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "Amount": {
                "type": "number"
              },
              "Date": {
                "type": "date"
              },
              "Description": {
                "type": "string"
              },
              "Quantity": {
                "type": "number"
              },
              "ProductCode": {
                "type": "string"
              },
              "Tax": {
                "type": "number"
              },
              "Unit": {
                "type": "string"
              },
              "UnitPrice": {
                "type": "number"
              }
            }
          }
        }
      }
    }
  },
  "tags": {}
}

Definições

Name	Description
AzureBlobContentSource	Armazenamento de Blobs do Azure conteúdo.
AzureBlobFileListContentSource	Lista de ficheiros no Armazenamento de Blobs do Azure.
DocumentBuildMode	Modo de compilação do modelo de documento personalizado.
DocumentFieldSchema	Descrição do esquema semântico do campo com uma sintaxe de estilo de Esquema JSON.
DocumentFieldType	Tipo de dados semântico do valor do campo.
DocumentModelDetails	Informações do modelo de documentos.
DocumentTypeDetails	Informações do tipo de documento.
Error	O objeto de erro.
ErrorResponse	Objeto de resposta de erro.
InnerError	Um objeto que contém informações mais específicas sobre o erro.
Warning	O objeto de erro.

AzureBlobContentSource

Armazenamento de Blobs do Azure conteúdo.

Name	Tipo	Description
containerUrl	string	Armazenamento de Blobs do Azure URL do contentor.
prefix	string	Prefixo do nome do blob.

AzureBlobFileListContentSource

Lista de ficheiros no Armazenamento de Blobs do Azure.

Name	Tipo	Description
containerUrl	string	Armazenamento de Blobs do Azure URL do contentor.
fileList	string	Caminho para um ficheiro JSONL no contentor que especifica um subconjunto de documentos.

DocumentBuildMode

Modo de compilação do modelo de documento personalizado.

Name	Tipo	Description
neural	string	Suporte para documentos com diversos modelos visuais.
template	string	Documentos de destino com modelos visuais semelhantes.

DocumentFieldSchema

Descrição do esquema semântico do campo com uma sintaxe de estilo de Esquema JSON.

Name	Tipo	Description
description	string	Descrição do campo.
example	string	Conteúdo do campo de exemplo.
items	DocumentFieldSchema	Esquema de tipo de campo de cada elemento de matriz.
properties	<string, DocumentFieldSchema>	Sub-campos nomeados do campo do objeto.
type	DocumentFieldType	Tipo de dados semântico do valor do campo.

DocumentFieldType

Tipo de dados semântico do valor do campo.

Name	Tipo	Description
address	string	Endereço analisado.
array	string	Lista de subcampos do mesmo tipo.
boolean	string	Valor booleano, normalizado como verdadeiro ou falso.
countryRegion	string	País/região, normalizado para o formato ISO 3166-1 alfa-3 (por exemplo, EUA).
currency	string	Montante da moeda com símbolo de moeda e unidade opcionais.
date	string	Data, normalizada para o formato ISO 8601 (YYYY-MM-DD).
integer	string	Número inteiro, normalizado para número inteiro assinado de 64 bits.
number	string	Número de vírgula flutuante, normalizado para vírgula flutuante de precisão dupla.
object	string	Lista nomeada de subcampos de tipos potencialmente diferentes.
phoneNumber	string	Número de telefone, normalizado para o formato E.164 (+{CountryCode}{SubscriberNumber}).
selectionGroup	string	Matriz de valores de cadeia selecionados.
selectionMark	string	O campo está selecionado?
signature	string	A assinatura está presente?
string	string	Texto simples.
time	string	Tempo normalizado para o formato ISO 8601 (hh:mm:ss).

DocumentModelDetails

Informações do modelo de documentos.

Name	Tipo	Description
apiVersion	string	Versão da API utilizada para criar este modelo de documento.
azureBlobFileListSource	AzureBlobFileListContentSource	Armazenamento de Blobs do Azure lista de ficheiros que especifica os dados de preparação. AzureBlobSource ou azureBlobFileListSource têm de ser especificados.
azureBlobSource	AzureBlobContentSource	Armazenamento de Blobs do Azure localização que contém os dados de preparação. AzureBlobSource ou azureBlobFileListSource têm de ser especificados.
buildMode	DocumentBuildMode	Modo de compilação do modelo de documento personalizado.
createdDateTime	string	Data e hora (UTC) em que o modelo de documento foi criado.
description	string	Descrição do modelo de documento.
docTypes	<string, DocumentTypeDetails>	Tipos de documento suportados.
expirationDateTime	string	Data e hora (UTC) em que o modelo de documento expira.
modelId	string	Nome exclusivo do modelo de documento.
tags	object	Lista de atributos de etiqueta chave-valor associados ao modelo de documento.
warnings	Warning[]	Lista de avisos encontrados ao criar o modelo.

DocumentTypeDetails

Informações do tipo de documento.

Name	Tipo	Description
buildMode	DocumentBuildMode	Modo de compilação do modelo de documento personalizado.
description	string	Descrição do modelo de documento.
fieldConfidence	object	Confiança estimada para cada campo.
fieldSchema	<string, DocumentFieldSchema>	Descrição do esquema semântico do documento com uma sintaxe de estilo de Esquema JSON.

Error

O objeto de erro.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
innererror	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 destino do erro.

ErrorResponse

Objeto de resposta de erro.

Name	Tipo	Description
error	Error	Informações de erro.

InnerError

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

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
innererror	InnerError	Erro interno.
message	string	Uma representação legível por humanos do erro.

Warning

O objeto de erro.

Name	Tipo	Description
code	string	Um dos conjuntos definidos pelo servidor de códigos de aviso.
message	string	Uma representação legível por humanos do aviso.
target	string	O destino do erro.

Partilhar via

Document Models - Get Model

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Scopes

Exemplos

Get Custom Document Model

Sample Request

Sample Response

Get Prebuilt Document Model

Sample Request

Sample Response

Definições

AzureBlobContentSource

AzureBlobFileListContentSource

DocumentBuildMode

DocumentFieldSchema

DocumentFieldType

DocumentModelDetails

DocumentTypeDetails

Error

ErrorResponse

InnerError

Warning

Recursos adicionais