Document Models - Build Model

Servicio:

Azure AI Services

Versión de la API:

2024-07-31-preview

Crea un modelo de análisis de documentos personalizado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string uri	Punto de conexión del servicio De inteligencia de documentos.
api-version	query	True	string	Versión de la API que se va a usar para esta 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.
allowOverwrite		boolean	Permitir sobrescribir un modelo existente con el mismo nombre.
azureBlobFileListSource		AzureBlobFileListContentSource	Lista de archivos de Azure Blob Storage que especifica los datos de entrenamiento. Se debe especificar azureBlobSource o azureBlobFileListSource.
azureBlobSource		AzureBlobContentSource	Ubicación de Azure Blob Storage que contiene los datos de entrenamiento. Se debe especificar azureBlobSource o azureBlobFileListSource.
description		string	Descripción del modelo de documento.
maxTrainingHours		number	Número máximo de horas de GPU equivalentes a V100 que se usarán para el entrenamiento del modelo. Default=0.5.
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. Encabezados Operation-Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

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

Ejemplos

Build Document Model

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

202

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

Definiciones

Nombre	Description
AzureBlobContentSource	Contenido de Azure Blob Storage.
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

Contenido de Azure Blob Storage.

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

AzureBlobFileListContentSource

Lista de archivos en Azure Blob Storage.

Nombre	Tipo	Description
containerUrl	string	Dirección URL del contenedor de Azure Blob Storage.
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	Valor predeterminado	Description
allowOverwrite	boolean	False	Permitir sobrescribir un modelo existente con el mismo nombre.
azureBlobFileListSource	AzureBlobFileListContentSource		Lista de archivos de Azure Blob Storage que especifica los datos de entrenamiento. Se debe especificar azureBlobSource o azureBlobFileListSource.
azureBlobSource	AzureBlobContentSource		Ubicación de Azure Blob Storage que contiene los datos de entrenamiento. Se debe especificar azureBlobSource o azureBlobFileListSource.
buildMode	DocumentBuildMode		Modo de compilación del modelo de documento personalizado.
description	string		Descripción del modelo de documento.
maxTrainingHours	number	0.5	Número máximo de horas de GPU equivalentes a V100 que se usarán para el entrenamiento del modelo. Default=0.5.
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
generative	string	Habilite documentos de todos los tipos mediante técnicas de ia generativa.
neural	string	Compatibilidad con documentos con diversas plantillas visuales.
template	string	Documentos de destino 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.