Document Models - Build Model

Service:

Azure AI Services

API Version:

2023-07-31

Crea un modelo de análisis de documentos personalizado.

POST {endpoint}/formrecognizer/documentModels:build?api-version=2023-07-31

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string url	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus2.api.cognitive.microsoft.com).
api-version	query	True	string	Versión de API solicitada.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Clave secreta de la suscripción de Azure Cognitive Services.

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 pone en cola correctamente. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Error encontrado.

Seguridad

Ocp-Apim-Subscription-Key

Clave secreta de la suscripción de Azure Cognitive Services.

Type: apiKey
In: header

Ejemplos

Build Document Model

Sample Request

HTTP

POST https://myendpoint.cognitiveservices.azure.com/formrecognizer/documentModels:build?api-version=2023-07-31

{
  "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/formrecognizer/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2023-07-31

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	Información de error.
ErrorResponse	Objeto de respuesta de error.
InnerError	Error detallado.

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 para el entrenamiento.

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

Información de error.

Nombre	Tipo	Description
code	string	Código de error.
details	Error[]	Lista de errores detallados.
innererror	InnerError	Error detallado.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto de respuesta de error.

Nombre	Tipo	Description
error	Error	Información de error.

InnerError

Error detallado.

Nombre	Tipo	Description
code	string	Código de error.
innererror	InnerError	Error detallado.
message	string	Mensaje de error.