Partilhar via


Document Models - Get Model

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

GET {endpoint}/documentintelligence/documentModels/{modelId}?api-version=2024-07-31-preview

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
path True

string

uri

O ponto de extremidade do serviço de Inteligência de Documentos.

modelId
path True

string

Nome exclusivo do modelo de documento.

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

api-version
query True

string

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

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-client-request-id

string

uuid

Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Respostas

Name Tipo Description
200 OK

DocumentModelDetails

O pedido foi bem-sucedido.

Cabeçalhos

x-ms-client-request-id: string

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Âmbitos

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

Exemplos

Get Custom Document Model
Get Prebuilt Document Model

Get Custom Document Model

Pedido de amostra

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

Resposta da amostra

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "createdDateTime": "2021-09-24T12:54:35Z",
  "expirationDateTime": "2023-01-01T00:00:00Z",
  "apiVersion": "2024-07-31-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

Pedido de amostra

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

Resposta da amostra

{
  "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-07-31-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

Conteúdo do Armazenamento de Blobs do Azure.

AzureBlobFileListContentSource

Lista de ficheiros no Armazenamento de Blobs do Azure.

DocumentAnalysisFeature

Recursos de análise de documentos para habilitar.

DocumentBuildMode

Modo de construção de modelo de documento personalizado.

DocumentFieldSchema

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

DocumentFieldType

Tipo de dados semânticos do valor do campo.

DocumentModelDetails

Informações do modelo do documento.

DocumentTypeDetails

Informações sobre o 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.

SplitMode

Comportamento de divisão de ficheiros.

Warning

O objeto de erro.

AzureBlobContentSource

Conteúdo do Armazenamento de Blobs do Azure.

Name Tipo Description
containerUrl

string

URL do contêiner de Armazenamento de Blobs do Azure.

prefix

string

Prefixo do nome do blob.

AzureBlobFileListContentSource

Lista de ficheiros no Armazenamento de Blobs do Azure.

Name Tipo Description
containerUrl

string

URL do contêiner de Armazenamento de Blobs do Azure.

fileList

string

Caminho para um arquivo JSONL dentro do contêiner especificando um subconjunto de documentos.

DocumentAnalysisFeature

Recursos de análise de documentos para habilitar.

Name Tipo Description
barcodes

string

Habilite a deteção de códigos de barras no documento.

formulas

string

Permitir a deteção de expressões matemáticas no documento.

keyValuePairs

string

Habilite a deteção de pares de valores de chave gerais (campos de formulário) no documento.

languages

string

Habilite a deteção do idioma do conteúdo de texto.

ocrHighResolution

string

Execute OCR em uma resolução mais alta para lidar com documentos com letras miúdas.

queryFields

string

Habilite a extração de campos adicionais por meio do parâmetro de consulta queryFields.

styleFont

string

Permitir o reconhecimento de vários estilos de fonte.

DocumentBuildMode

Modo de construção de modelo de documento personalizado.

Name Tipo Description
generative

string

Habilite documentos de todos os tipos usando técnicas de IA generativa.

neural

string

Documentos de suporte 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.

Name Tipo Description
description

string

Descrição do campo.

example

string

Exemplo de conteúdo do campo.

items

DocumentFieldSchema

Esquema de tipo de campo de cada elemento da matriz.

properties

<string,  DocumentFieldSchema>

Subcampos nomeados do campo de objeto.

type

DocumentFieldType

Tipo de dados semânticos do valor do campo.

DocumentFieldType

Tipo de dados semânticos 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 para verdadeiro ou falso.

countryRegion

string

País/região, normalizado para o formato ISO 3166-1 alpha-3 (ex. EUA).

currency

string

Valor da moeda com símbolo e unidade de moeda opcionais.

date

string

Data, normalizada para o formato ISO 8601 (AAAA-MM-DD).

integer

string

Número inteiro, normalizado para inteiro assinado 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}).

selectionGroup

string

Matriz de valores de cadeia de caracteres 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 do documento.

Name Tipo Default value Description
apiVersion

string

Versão da API usada para criar este modelo de documento.

azureBlobFileListSource

AzureBlobFileListContentSource

Lista de arquivos do Armazenamento de Blobs do Azure especificando os dados de treinamento. AzureBlobSource ou azureBlobFileListSource devem ser especificados.

azureBlobSource

AzureBlobContentSource

Local do Armazenamento de Blobs do Azure que contém os dados de treinamento. AzureBlobSource ou azureBlobFileListSource devem ser especificados.

buildMode

DocumentBuildMode

Modo de construção de modelo de documento personalizado.

classifierId

string

Para modelos compostos, o classificador personalizado para dividir e classificar o arquivo de entrada.

createdDateTime

string

Data e hora (UTC) em que o modelo de documento foi criado.

description

string

Descrição do modelo do documento.

docTypes

<string,  DocumentTypeDetails>

Tipos de documentos suportados.

expirationDateTime

string

Data e hora (UTC) em que o modelo de documento expirará.

modelId

string

Nome exclusivo do modelo de documento.

split

SplitMode

none

Para modelos compostos, o comportamento de divisão de arquivos.

tags

object

Lista de atributos de tag chave-valor associados ao modelo de documento.

trainingHours

number

Número de horas de GPU equivalente a V100 consumidas para treinamento de modelos.

warnings

Warning[]

Lista de avisos encontrados durante a criação do modelo.

DocumentTypeDetails

Informações sobre o tipo de documento.

Name Tipo Description
buildMode

DocumentBuildMode

Modo de construção de modelo de documento personalizado.

confidenceThreshold

number

Execute a análise apenas se a confiança docType estiver acima do limite.

description

string

Descrição do modelo do documento.

features

DocumentAnalysisFeature[]

Lista de recursos de análise opcionais.

fieldConfidence

object

Confiança estimada para cada campo.

fieldSchema

<string,  DocumentFieldSchema>

Descrição do esquema semântico do documento usando uma sintaxe de estilo de esquema JSON.

maxDocumentsToAnalyze

integer

Número máximo de documentos do tipo especificado para analisar. Padrão = todos.

modelId

string

Modelo de documento a ser usado para analisar documentos com o tipo especificado.

queryFields

string[]

Lista de campos adicionais a extrair. Ex. "NúmerodeConvidados, Número da Loja"

Error

O objeto de erro.

Name Tipo Description
code

string

Um de um conjunto de códigos de erro definido pelo servidor.

details

Error[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.

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 alvo 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 de um conjunto de códigos de erro definido pelo servidor.

innererror

InnerError

Erro interno.

message

string

Uma representação legível por humanos do erro.

SplitMode

Comportamento de divisão de ficheiros.

Name Tipo Description
auto

string

Divida automaticamente o arquivo em documentos.

none

string

Trate todo o arquivo como um único documento.

perPage

string

Trate cada página do arquivo como um documento separado.

Warning

O objeto de erro.

Name Tipo Description
code

string

Um de um conjunto de códigos de aviso definido pelo servidor.

message

string

Uma representação legível por humanos do aviso.

target

string

O alvo do erro.