Document Models - Build Model

Service:

Azure AI Services

API Version:

2024-02-29-preview

Crea un modelo de análisis de documentos personalizado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Punto de conexión del servicio Document Intelligence.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
buildMode	True	DocumentBuildMode	Modo de compilación del modelo de documento personalizado.
modelId	True	string	Nombre único del modelo de documento.
azureBlobFileListSource		AzureBlobFileListContentSource	Azure Blob Storage lista de archivos que especifican los datos de entrenamiento. Debe especificarse azureBlobSource o azureBlobFileListSource.
azureBlobSource		AzureBlobContentSource	Azure Blob Storage ubicación que contiene los datos de entrenamiento. Debe especificarse azureBlobSource o azureBlobFileListSource.
description		string	Descripción del modelo de documento.
tags		object	Lista de atributos de etiqueta clave-valor asociados al modelo de documento.

Respuestas

Nombre	Tipo	Description
202 Accepted		La solicitud se ha aceptado para su procesamiento, pero el procesamiento aún no se ha completado. Headers Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

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

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

Ejemplos

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

Definiciones

Nombre	Description
AzureBlobContentSource	Azure Blob Storage contenido.
AzureBlobFileListContentSource	Lista de archivos en Azure Blob Storage.
BuildDocumentModelRequest	Cuerpo de la solicitud para crear un nuevo modelo de documento personalizado.
DocumentBuildMode	Modo de compilación del modelo de documento personalizado.
Error	Objeto de error.
ErrorResponse	Objeto de respuesta de error.
InnerError	Objeto que contiene información más específica sobre el error.

AzureBlobContentSource

Azure Blob Storage contenido.

Nombre	Tipo	Description
containerUrl	string	Azure Blob Storage dirección URL del contenedor.
prefix	string	Prefijo de nombre de blob.

AzureBlobFileListContentSource

Lista de archivos en Azure Blob Storage.

Nombre	Tipo	Description
containerUrl	string	Azure Blob Storage dirección URL del contenedor.
fileList	string	Ruta de acceso a un archivo JSONL dentro del contenedor que especifica un subconjunto de documentos.

BuildDocumentModelRequest

Cuerpo de la solicitud para crear un nuevo modelo de documento personalizado.

Nombre	Tipo	Description
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob Storage lista de archivos que especifican los datos de entrenamiento. Debe especificarse azureBlobSource o azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource	Azure Blob Storage ubicación que contiene los datos de entrenamiento. Debe especificarse azureBlobSource o azureBlobFileListSource.
buildMode	DocumentBuildMode	Modo de compilación del modelo de documento personalizado.
description	string	Descripción del modelo de documento.
modelId	string	Nombre único del modelo de documento.
tags	object	Lista de atributos de etiqueta clave-valor asociados al modelo de documento.

DocumentBuildMode

Modo de compilación del modelo de documento personalizado.

Nombre	Tipo	Description
neural	string	Compatibilidad con documentos con diversas plantillas visuales.
template	string	Destinos de documentos con plantillas visuales similares.

Error

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

ErrorResponse

Objeto de respuesta de error.

Nombre	Tipo	Description
error	Error	Información de error.

InnerError

Objeto que contiene información más específica sobre el error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	InnerError	Error interno.
message	string	Representación legible del error.