Document Models - Build Model

Serviço:

Azure AI Services

Versão da API:

2024-11-30

Cria um modelo de análise de documento personalizado.

POST {endpoint}/documentintelligence/documentModels:build?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.

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.
allowOverwrite		boolean	Permitir a substituição de um modelo existente com o mesmo nome.
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.
description		string	Descrição do modelo de documento.
maxTrainingHours		number	Número máximo de horas de GPU equivalentes à V100 a serem usadas para treinamento de modelo. Default=0,5.
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. Cabeçalhos Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	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

Build Document Model

Solicitação de exemplo

HTTP

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:build?api-version=2024-11-30

{
  "modelId": "myCustomModel",
  "description": "Custom model description",
  "buildMode": "template",
  "azureBlobSource": {
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken",
    "prefix": "trainingDocs/"
  },
  "tags": {
    "createdBy": "myUserId"
  }
}

Resposta de exemplo

Código de status:

202

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

Definições

Nome	Description
AzureBlobContentSource	Conteúdo do Armazenamento de Blobs do Azure.
AzureBlobFileListContentSource	Lista de arquivos no Armazenamento de Blobs do Azure.
BuildDocumentModelRequest	Solicitar corpo para criar um novo modelo de documento personalizado.
DocumentBuildMode	Modo de build do modelo de documento personalizado.
DocumentIntelligenceError	O objeto de erro.
DocumentIntelligenceErrorResponse	Objeto de resposta de erro.
DocumentIntelligenceInnerError	Um objeto que contém informações mais específicas sobre o erro.

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.

BuildDocumentModelRequest

Solicitar corpo para criar um novo modelo de documento personalizado.

Nome	Tipo	Valor padrão	Description
allowOverwrite	boolean	False	Permitir a substituição de um modelo existente com o mesmo nome.
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 build do modelo de documento personalizado.
description	string		Descrição do modelo de documento.
maxTrainingHours	number	0.5	Número máximo de horas de GPU equivalentes à V100 a serem usadas para treinamento de modelo. Default=0,5.
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	Suporte a documentos com modelos visuais diversos.
template	string	Documentos de destino com modelos visuais semelhantes.

DocumentIntelligenceError

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	DocumentIntelligenceError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	DocumentIntelligenceInnerError	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	DocumentIntelligenceError	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	DocumentIntelligenceInnerError	Erro interno.
message	string	Uma representação legível pelo ser humano do erro.