Partilhar via

Document Models - Build Model

  • Referência
Serviço:
Azure AI Services
Versão da API:
2024-07-31-preview

Cria um modelo de análise de documentos personalizado.

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

string

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

Corpo do Pedido

Name Necessário Tipo Description
buildMode True

DocumentBuildMode

Modo de construção de 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 do documento.
maxTrainingHours

number

Número máximo de horas de GPU equivalente a V100 para usar no treinamento do modelo. Padrão=0,5.
tags

object

Lista de atributos de tag 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

  • Operation-Location: string
  • Retry-After: integer
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

Build Document Model

Pedido de amostra

POST https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels:build?api-version=2024-07-31-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

Código de estado:
202 
Operation-Location: https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-07-31-preview

Definições

Name Description
AzureBlobContentSource

Conteúdo do Armazenamento de Blobs do Azure.
AzureBlobFileListContentSource

Lista de ficheiros no Armazenamento de Blobs do Azure.
BuildDocumentModelRequest

Solicite o corpo para criar um novo modelo de documento personalizado.
DocumentBuildMode

Modo de construção de 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

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.

BuildDocumentModelRequest

Solicite o corpo para criar um novo modelo de documento personalizado.

Name Tipo Default value 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 construção de modelo de documento personalizado.
description

string

Descrição do modelo do documento.
maxTrainingHours

number

0.5

Número máximo de horas de GPU equivalente a V100 para usar no treinamento do modelo. Padrão=0,5.
modelId

string

Nome exclusivo do modelo de documento.
tags

object

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

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.

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.