Document Models - Build Model
Cria um modelo de análise de documentos personalizado.
POST {endpoint}/documentintelligence/documentModels:build?api-version=2024-02-29-preview
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
O ponto final de serviço do Document Intelligence. |
api-version
|
query | True |
string |
A versão da API a utilizar para esta operação. |
Corpo do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
buildMode | True |
Modo de compilação do modelo de documento personalizado. |
|
modelId | True |
string |
Nome de modelo de documento exclusivo. |
azureBlobFileListSource |
Armazenamento de Blobs do Azure lista de ficheiros que especifica os dados de preparação. Tem de especificar azureBlobSource ou azureBlobFileListSource. |
||
azureBlobSource |
Armazenamento de Blobs do Azure localização que contém os dados de preparação. Tem de especificar azureBlobSource ou azureBlobFileListSource. |
||
description |
string |
Descrição do modelo de documento. |
|
tags |
object |
Lista de atributos de etiquetas chave-valor associados ao modelo de documento. |
Respostas
Name | Tipo | Description |
---|---|---|
202 Accepted |
O pedido foi aceite para processamento, mas o processamento ainda não foi concluído. Cabeçalhos
|
|
Other Status Codes |
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
Build Document Model
Pedido de amostra
POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:build?api-version=2024-02-29-preview
{
"modelId": "myCustomModel",
"description": "Custom model description",
"buildMode": "template",
"azureBlobSource": {
"containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
"prefix": "trainingDocs/"
},
"tags": {
"createdBy": "myUserId"
}
}
Resposta da amostra
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-02-29-preview
Definições
Name | Description |
---|---|
Azure |
Armazenamento de Blobs do Azure conteúdo. |
Azure |
Lista de ficheiros no Armazenamento de Blobs do Azure. |
Build |
Peça ao corpo para criar um novo modelo de documento personalizado. |
Document |
Modo de compilação do modelo de documento personalizado. |
Error |
O objeto de erro. |
Error |
Objeto de resposta de erro. |
Inner |
Um objeto que contém informações mais específicas sobre o 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. |
BuildDocumentModelRequest
Peça ao corpo para criar um novo modelo de documento personalizado.
Name | Tipo | Description |
---|---|---|
azureBlobFileListSource |
Armazenamento de Blobs do Azure lista de ficheiros que especifica os dados de preparação. Tem de especificar azureBlobSource ou azureBlobFileListSource. |
|
azureBlobSource |
Armazenamento de Blobs do Azure localização que contém os dados de preparação. Tem de especificar azureBlobSource ou azureBlobFileListSource. |
|
buildMode |
Modo de compilação do modelo de documento personalizado. |
|
description |
string |
Descrição do modelo de documento. |
modelId |
string |
Nome de modelo de documento exclusivo. |
tags |
object |
Lista de atributos de etiquetas chave-valor associados ao modelo de documento. |
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 de elementos visuais semelhantes. |
Error
O objeto de erro.
Name | Tipo | Description |
---|---|---|
code |
string |
Um dos conjuntos de códigos de erro definidos pelo servidor. |
details |
Error[] |
Uma série de detalhes sobre erros específicos que levaram a este erro comunicado. |
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 |
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 |
Erro interno. |
|
message |
string |
Uma representação legível por humanos do erro. |