Document Models - List Models
Listar todos os modelos de documento
GET {endpoint}/documentintelligence/documentModels?api-version=2024-11-30
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
O ponto de extremidade do serviço do Document Intelligence. |
api-version
|
query | True |
string |
A versão da API a ser usada para esta operação. |
Cabeçalho da solicitação
Nome | Obrigató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
Nome | Tipo | Description |
---|---|---|
200 OK |
A solicitação foi bem-sucedida. Cabeçalhos x-ms-client-request-id: string |
|
Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
Ocp-Apim-Subscription-Key
Tipo:
apiKey
Em:
header
OAuth2Auth
Tipo:
oauth2
Flow:
accessCode
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
URL do Token:
https://login.microsoftonline.com/common/oauth2/token
Escopos
Nome | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Exemplos
Get Document Models
Solicitação de exemplo
GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?api-version=2024-11-30
Resposta de exemplo
{
"value": [
{
"modelId": "prebuilt-layout",
"createdDateTime": "2021-07-30T00:00:00Z",
"description": "Prebuilt model to extract text, selection marks, tables, and other layout information.",
"apiVersion": "2024-11-30"
},
{
"modelId": "myCustomModel",
"createdDateTime": "2021-09-24T12:54:35Z",
"expirationDateTime": "2023-01-01T00:00:00Z",
"description": "Custom model description",
"apiVersion": "2024-11-30"
}
],
"nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?nextLink=nextLinkData"
}
Definições
Nome | Description |
---|---|
Azure |
Conteúdo do Armazenamento de Blobs do Azure. |
Azure |
Lista de arquivos no Armazenamento de Blobs do Azure. |
Document |
Recursos de análise de documentos a serem habilitados. |
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 |
O objeto de erro. |
Document |
Objeto de resposta de erro. |
Document |
Um objeto que contém informações mais específicas sobre o erro. |
Document |
O objeto de erro. |
Document |
Informações do modelo de documento. |
Document |
Informações de tipo de documento. |
Paged |
Coleção de páginas de itens DocumentModelDetails |
Split |
Comportamento de divisão de arquivos. |
AzureBlobContentSource
Conteúdo do Armazenamento de Blobs do Azure.
Nome | Tipo | Description |
---|---|---|
containerUrl |
string |
URL do contêiner do Armazenamento de Blobs do Azure. |
prefix |
string |
Prefixo de nome de blob. |
AzureBlobFileListContentSource
Lista de arquivos no Armazenamento de Blobs do Azure.
Nome | Tipo | Description |
---|---|---|
containerUrl |
string |
URL do contêiner do 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 a serem habilitados.
Nome | Tipo | Description |
---|---|---|
barcodes |
string |
Habilite a detecção de códigos de barras no documento. |
formulas |
string |
Habilite a detecção de expressões matemáticas no documento. |
keyValuePairs |
string |
Habilite a detecção de pares de valor de chave geral (campos de formulário) no documento. |
languages |
string |
Habilite a detecção do idioma de conteúdo de texto. |
ocrHighResolution |
string |
Execute o OCR em uma resolução mais alta para lidar com documentos com impressão fina. |
queryFields |
string |
Habilite a extração de campos adicionais por meio do parâmetro de consulta queryFields. |
styleFont |
string |
Habilite o reconhecimento de vários estilos de fonte. |
DocumentBuildMode
Modo de build do modelo de documento personalizado.
Nome | Tipo | Description |
---|---|---|
neural |
string |
Suporte a documentos com modelos visuais diversos. |
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 de campo de exemplo. |
items |
Esquema de tipo de campo de cada elemento de matriz. |
|
properties |
<string,
Document |
Sub-campos 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 verdadeiro ou falso. |
countryRegion |
string |
País/região, normalizado para o formato alfa-3 ISO 3166-1 (por exemplo, EUA). |
currency |
string |
Valor de moeda com símbolo e unidade de moeda opcionais. |
date |
string |
Data, normalizada para o formato ISO 8601 (YYYY-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}). |
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 sem formatação. |
time |
string |
Hora, normalizada para o formato ISO 8601 (hh:mm:ss). |
DocumentIntelligenceError
O objeto de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
details |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
|
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 pelo ser humano do erro. |
target |
string |
O destino do erro. |
DocumentIntelligenceErrorResponse
Objeto de resposta de erro.
Nome | Tipo | Description |
---|---|---|
error |
Informações de erro. |
DocumentIntelligenceInnerError
Um objeto que contém informações mais específicas sobre o erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um de um conjunto definido pelo servidor de códigos de erro. |
innererror |
Erro interno. |
|
message |
string |
Uma representação legível pelo ser humano do erro. |
DocumentIntelligenceWarning
O objeto de erro.
Nome | Tipo | Description |
---|---|---|
code |
string |
Um de um conjunto definido pelo servidor de códigos de aviso. |
message |
string |
Uma representação legível pelo ser humano do aviso. |
target |
string |
O destino do erro. |
DocumentModelDetails
Informações do modelo de documento.
Nome | Tipo | Valor padrão | Description |
---|---|---|---|
apiVersion |
string |
Versão da API usada para criar este modelo de documento. |
|
azureBlobFileListSource |
Lista de arquivos do Armazenamento de Blobs do Azure especificando os dados de treinamento. AzureBlobSource ou azureBlobFileListSource devem ser especificados. |
||
azureBlobSource |
Local do Armazenamento de Blobs do Azure que contém os dados de treinamento. AzureBlobSource ou azureBlobFileListSource devem ser especificados. |
||
buildMode |
Modo de build do 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) quando 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. |
|
modifiedDateTime |
string |
Data e hora (UTC) quando o modelo de documento foi modificado pela última vez. |
|
split | none |
Para modelos compostos, o comportamento de divisão de arquivos. |
|
tags |
object |
Lista de atributos de marca chave-valor associados ao modelo de documento. |
|
trainingHours |
number |
Número de horas de GPU equivalentes à V100 consumidas para treinamento de modelo. |
|
warnings |
Lista de avisos encontrados durante a criação do modelo. |
DocumentTypeDetails
Informações de tipo de documento.
Nome | Tipo | Description |
---|---|---|
buildMode |
Modo de build do modelo de documento personalizado. |
|
confidenceThreshold |
number |
Somente execute a análise se a confiança docType estiver acima do limite. |
description |
string |
Descrição do modelo de documento. |
features |
Lista de recursos de análise opcionais. |
|
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. |
maxDocumentsToAnalyze |
integer |
Número máximo de documentos do tipo especificado a serem analisados. Default=all. |
modelId |
string |
Modelo de documento a ser usado para analisar documentos com o tipo especificado. |
queryFields |
string[] |
Lista de campos adicionais a serem extraídos. Ex. "NumberOfGuests,StoreNumber" |
PagedDocumentModelDetails
Coleção de páginas de itens DocumentModelDetails
Nome | Tipo | Description |
---|---|---|
nextLink |
string |
O link para a próxima página de itens |
value |
Os itens DocumentModelDetails nesta página |
SplitMode
Comportamento de divisão de arquivos.
Nome | 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 no arquivo como um documento separado. |