Document Models - Get Model
Obtém informações detalhadas do modelo de documento.
GET {endpoint}/formrecognizer/documentModels/{modelId}?api-version=2023-07-31
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string url |
Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus2.api.cognitive.microsoft.com). |
model
|
path | True |
string |
Nome exclusivo do modelo de documento. Regex pattern: |
api-version
|
query | True |
string |
Versão da API solicitada. |
Cabeçalho da solicitação
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
A chave secreta para sua assinatura dos Serviços Cognitivos do Azure. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
OK. |
|
Other Status Codes |
Erro encontrado. |
Segurança
Ocp-Apim-Subscription-Key
A chave secreta para sua assinatura dos Serviços Cognitivos do Azure.
Type:
apiKey
In:
header
Exemplos
Get Custom Document Model |
Get Prebuilt Document Model |
Get Custom Document Model
Sample Request
GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/myCustomModel?api-version=2023-07-31
Sample Response
{
"modelId": "myCustomModel",
"description": "Custom model description",
"createdDateTime": "2021-09-24T12:54:35Z",
"expirationDateTime": "2023-01-01T00:00:00Z",
"apiVersion": "2023-07-31",
"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
GET https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels/prebuilt-invoice?api-version=2023-07-31
Sample Response
{
"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": "2023-07-31",
"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
Nome | Description |
---|---|
Document |
Modo de build do modelo de documento personalizado. |
Document |
Descrição do esquema semântico de campo usando uma sintaxe de estilo de esquema JSON. |
Document |
Tipo de dados semânticos do valor do campo. |
Document |
Informações do modelo de documento. |
Document |
Informações de tipo de documento. |
Error |
Informações de erro. |
Error |
Objeto de resposta de erro. |
Inner |
Erro detalhado. |
DocumentBuildMode
Modo de build do modelo de documento personalizado.
Nome | Tipo | Description |
---|---|---|
neural |
string |
Dar suporte a documentos com diversos modelos visuais. |
template |
string |
Documentos de destino com modelos visuais semelhantes. |
DocumentFieldSchema
Descrição do esquema semântico de campo usando uma sintaxe de estilo de esquema JSON.
Nome | Tipo | Description |
---|---|---|
description |
string |
Descrição do campo. |
example |
string |
Conteúdo do campo de exemplo. |
items |
Esquema de tipo de campo de cada elemento de matriz. |
|
properties |
<string,
Document |
Subcampos nomeados do campo de objeto. |
type |
Tipo de dados semânticos do valor do campo. |
DocumentFieldType
Tipo de dados semânticos do valor do campo.
Nome | Tipo | Description |
---|---|---|
address |
string |
Endereço analisado. |
array |
string |
Lista de subcampos do mesmo tipo. |
boolean |
string |
Valor booliano, normalizado como true ou false. |
countryRegion |
string |
País/região, normalizado para o formato ISO 3166-1 alfa-3 (por exemplo, EUA). |
currency |
string |
Conversor de Moedas valor com o símbolo e a unidade de moeda opcionais. |
date |
string |
Data, normalizada para o formato ISO 8601 (AAAA-MM-DD). |
integer |
string |
Número inteiro, normalizado para inteiro com sinal de 64 bits. |
number |
string |
Número de ponto flutuante, normalizado para ponto 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}). |
selectionMark |
string |
O campo está selecionado? |
signature |
string |
A assinatura está presente? |
string |
string |
Texto sem formatação. |
time |
string |
Hora, normalizada para o formato ISO 8601 (hh:mm:ss). |
DocumentModelDetails
Informações do modelo de documento.
Nome | Tipo | Description |
---|---|---|
apiVersion |
string |
Versão da API usada para criar este modelo de documento. |
createdDateTime |
string |
Data e hora (UTC) em que o modelo de documento foi criado. |
description |
string |
Descrição do modelo de documento. |
docTypes |
<string,
Document |
Tipos de documento com suporte. |
expirationDateTime |
string |
Data e hora (UTC) em que o modelo de documento expirará. |
modelId |
string |
Nome exclusivo do modelo de documento. |
tags |
object |
Lista de atributos de marca chave-valor associados ao modelo de documento. |
DocumentTypeDetails
Informações de tipo de documento.
Nome | Tipo | Description |
---|---|---|
buildMode |
Modo de build do modelo de documento personalizado. |
|
description |
string |
Descrição do modelo de documento. |
fieldConfidence |
object |
Confiança estimada para cada campo. |
fieldSchema |
<string,
Document |
Descrição do esquema semântico do documento usando uma sintaxe de estilo de esquema JSON. |
Error
Informações de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código do erro. |
details |
Error[] |
Lista de erros detalhados. |
innererror |
Erro detalhado. |
|
message |
string |
Mensagem de erro. |
target |
string |
Destino do erro. |
ErrorResponse
Objeto de resposta de erro.
Nome | Tipo | Description |
---|---|---|
error |
Informações de erro. |
InnerError
Erro detalhado.
Nome | Tipo | Description |
---|---|---|
code |
string |
Código do erro. |
innererror |
Erro detalhado. |
|
message |
string |
Mensagem de erro. |