Document Models - Build Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

Cria um modelo de análise de documento personalizado.

POST {endpoint}/documentintelligence/documentModels:build?api-version=2024-02-29-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	O ponto de extremidade de serviço do Document Intelligence.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
buildMode	True	DocumentBuildMode	Modo de build do modelo de documento personalizado.
modelId	True	string	Nome exclusivo do modelo de documento.
azureBlobFileListSource		AzureBlobFileListContentSource	Armazenamento de Blobs do Azure lista de arquivos que especifica os dados de treinamento. AzureBlobSource ou azureBlobFileListSource deve ser especificado.
azureBlobSource		AzureBlobContentSource	Armazenamento de Blobs do Azure local que contém os dados de treinamento. AzureBlobSource ou azureBlobFileListSource deve ser especificado.
description		string	Descrição do modelo de documento.
tags		object	Lista de atributos de marca chave-valor associados ao modelo de documento.

Respostas

Nome	Tipo	Description
202 Accepted		A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. Headers Operation-Location: string Retry-After: integer
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

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

Exemplos

Build Document Model

Sample Request

HTTP

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"
  }
}

Sample Response

Status code:

202

Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-02-29-preview

Definições

Nome	Description
AzureBlobContentSource	Armazenamento de Blobs do Azure conteúdo.
AzureBlobFileListContentSource	Lista de arquivos em Armazenamento de Blobs do Azure.
BuildDocumentModelRequest	Corpo da solicitação para criar um novo modelo de documento personalizado.
DocumentBuildMode	Modo de build do modelo de documento personalizado.
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.

AzureBlobContentSource

Armazenamento de Blobs do Azure conteúdo.

Nome	Tipo	Description
containerUrl	string	Armazenamento de Blobs do Azure URL do contêiner.
prefix	string	Prefixo do nome do blob.

AzureBlobFileListContentSource

Lista de arquivos em Armazenamento de Blobs do Azure.

Nome	Tipo	Description
containerUrl	string	Armazenamento de Blobs do Azure URL do contêiner.
fileList	string	Caminho para um arquivo JSONL dentro do contêiner especificando um subconjunto de documentos.

BuildDocumentModelRequest

Corpo da solicitação para criar um novo modelo de documento personalizado.

Nome	Tipo	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Armazenamento de Blobs do Azure lista de arquivos que especifica os dados de treinamento. AzureBlobSource ou azureBlobFileListSource deve ser especificado.
azureBlobSource	AzureBlobContentSource	Armazenamento de Blobs do Azure local que contém os dados de treinamento. AzureBlobSource ou azureBlobFileListSource deve ser especificado.
buildMode	DocumentBuildMode	Modo de build do modelo de documento personalizado.
description	string	Descrição do modelo de documento.
modelId	string	Nome exclusivo do modelo de documento.
tags	object	Lista de atributos de marca chave-valor associados ao modelo de documento.

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.

Error

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
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 do erro.
target	string	O destino do erro.

ErrorResponse

Objeto de resposta de erro.

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

InnerError

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	InnerError	Erro interno.
message	string	Uma representação legível do erro.