你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Document Models - Build Model

服务:

Azure AI Services

API 版本:

2024-11-30

生成自定义文档分析模型。

POST {endpoint}/documentintelligence/documentModels:build?api-version=2024-11-30

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string uri	文档智能服务终结点。
api-version	query	True	string	用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
buildMode	True	DocumentBuildMode	自定义文档模型生成模式。
modelId	True	string	唯一的文档模型名称。
allowOverwrite		boolean	允许覆盖具有相同名称的现有模型。
azureBlobFileListSource		AzureBlobFileListContentSource	指定训练数据的 Azure Blob 存储文件列表。 必须指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource		AzureBlobContentSource	包含训练数据的 Azure Blob 存储位置。 必须指定 azureBlobSource 或 azureBlobFileListSource。
description		string	文档模型说明。
maxTrainingHours		number	用于模型训练的 V100 等效 GPU 小时数上限。 Default=0.5。
tags		object	与文档模型关联的键值标记属性的列表。

响应

名称	类型	说明
202 Accepted		已接受请求进行处理，但尚未完成处理。 标头 Operation-Location: string Retry-After: integer
Other Status Codes	DocumentIntelligenceErrorResponse	意外的错误响应。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称	说明
https://cognitiveservices.azure.com/.default

示例

Build Document Model

示例请求

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

示例响应

状态代码:

202

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

定义

名称	说明
AzureBlobContentSource	Azure Blob 存储内容。
AzureBlobFileListContentSource	Azure Blob 存储中的文件列表。
BuildDocumentModelRequest	请求正文以生成新的自定义文档模型。
DocumentBuildMode	自定义文档模型生成模式。
DocumentIntelligenceError	错误对象。
DocumentIntelligenceErrorResponse	错误响应对象。
DocumentIntelligenceInnerError	包含有关错误的更具体信息的对象。

AzureBlobContentSource

Azure Blob 存储内容。

名称	类型	说明
containerUrl	string	Azure Blob 存储容器 URL。
prefix	string	Blob 名称前缀。

AzureBlobFileListContentSource

Azure Blob 存储中的文件列表。

名称	类型	说明
containerUrl	string	Azure Blob 存储容器 URL。
fileList	string	指定文档子集的容器中的 JSONL 文件的路径。

BuildDocumentModelRequest

请求正文以生成新的自定义文档模型。

名称	类型	默认值	说明
allowOverwrite	boolean	False	允许覆盖具有相同名称的现有模型。
azureBlobFileListSource	AzureBlobFileListContentSource		指定训练数据的 Azure Blob 存储文件列表。 必须指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource	AzureBlobContentSource		包含训练数据的 Azure Blob 存储位置。 必须指定 azureBlobSource 或 azureBlobFileListSource。
buildMode	DocumentBuildMode		自定义文档模型生成模式。
description	string		文档模型说明。
maxTrainingHours	number	0.5	用于模型训练的 V100 等效 GPU 小时数上限。 Default=0.5。
modelId	string		唯一的文档模型名称。
tags	object		与文档模型关联的键值标记属性的列表。

DocumentBuildMode

自定义文档模型生成模式。

名称	类型	说明
neural	string	支持具有各种视觉模板的文档。
template	string	使用类似视觉模板的目标文档。

DocumentIntelligenceError

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	DocumentIntelligenceError[]	导致此报告错误的特定错误的详细信息数组。
innererror	DocumentIntelligenceInnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

DocumentIntelligenceErrorResponse

错误响应对象。

名称	类型	说明
error	DocumentIntelligenceError	错误信息。

DocumentIntelligenceInnerError

包含有关错误的更具体信息的对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	DocumentIntelligenceInnerError	内部错误。
message	string	错误的人工可读表示形式。