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

Document Models - List Models

服务:

Azure AI Services

API 版本:

2024-11-30

列出所有文档模型

GET {endpoint}/documentintelligence/documentModels?api-version=2024-11-30

URI 参数

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

请求头

名称	必需	类型	说明
x-ms-client-request-id		string uuid	请求的不透明、全局唯一的客户端生成的字符串标识符。

响应

名称	类型	说明
200 OK	PagedDocumentModelDetails	请求已成功。 标头 x-ms-client-request-id: string
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

示例

Get Document Models

示例请求

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?api-version=2024-11-30

示例响应

状态代码:

200

{
  "value": [
    {
      "modelId": "prebuilt-layout",
      "createdDateTime": "2021-07-30T00:00:00Z",
      "description": "Prebuilt model to extract text, selection marks, tables, and other layout information.",
      "apiVersion": "2024-11-30"
    },
    {
      "modelId": "myCustomModel",
      "createdDateTime": "2021-09-24T12:54:35Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "description": "Custom model description",
      "apiVersion": "2024-11-30"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?nextLink=nextLinkData"
}

定义

名称	说明
AzureBlobContentSource	Azure Blob 存储内容。
AzureBlobFileListContentSource	Azure Blob 存储中的文件列表。
DocumentAnalysisFeature	要启用的文档分析功能。
DocumentBuildMode	自定义文档模型生成模式。
DocumentFieldSchema	使用 JSON 架构样式语法描述字段语义架构。
DocumentFieldType	字段值的语义数据类型。
DocumentIntelligenceError	错误对象。
DocumentIntelligenceErrorResponse	错误响应对象。
DocumentIntelligenceInnerError	包含有关错误的更具体信息的对象。
DocumentIntelligenceWarning	错误对象。
DocumentModelDetails	文档模型信息。
DocumentTypeDetails	文档类型信息。
PagedDocumentModelDetails	DocumentModelDetails 项的分页集合
SplitMode	文件拆分行为。

AzureBlobContentSource

Azure Blob 存储内容。

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

AzureBlobFileListContentSource

Azure Blob 存储中的文件列表。

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

DocumentAnalysisFeature

要启用的文档分析功能。

名称	类型	说明
barcodes	string	启用文档中条形码检测。
formulas	string	启用文档中数学表达式的检测。
keyValuePairs	string	启用文档中常规键值对（窗体字段）的检测。
languages	string	启用文本内容语言检测。
ocrHighResolution	string	以更高的分辨率执行 OCR 以处理带有精细打印的文档。
queryFields	string	通过 queryFields 查询参数启用其他字段的提取。
styleFont	string	启用各种字体样式的识别。

DocumentBuildMode

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

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

DocumentFieldSchema

使用 JSON 架构样式语法描述字段语义架构。

名称	类型	说明
description	string	字段说明。
example	string	示例字段内容。
items	DocumentFieldSchema	每个数组元素的字段类型架构。
properties	<string,  DocumentFieldSchema>	对象字段的命名子字段。
type	DocumentFieldType	字段值的语义数据类型。

DocumentFieldType

字段值的语义数据类型。

名称	类型	说明
address	string	已分析的地址。
array	string	相同类型的子字段列表。
boolean	string	布尔值，规范化为 true 或 false。
countryRegion	string	国家/地区，规范化为 ISO 3166-1 alpha-3 格式（例如美国）。
currency	string	具有可选货币符号和单位的货币金额。
date	string	日期，规范化为 ISO 8601 （YYYY-MM-DD） 格式。
integer	string	整数，规范化为 64 位有符号整数。
number	string	浮点数，规范化为双精度浮点。
object	string	可能不同类型的子字段的命名列表。
phoneNumber	string	电话号码，规范化为 E.164 （+{CountryCode}{SubscriberNumber}） 格式。
selectionGroup	string	所选字符串值的数组。
selectionMark	string	是否选择了字段？
signature	string	签名是否存在？
string	string	纯文本。
time	string	时间，规范化为 ISO 8601 （hh：mm：ss） 格式。

DocumentIntelligenceError

错误对象。

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

DocumentIntelligenceErrorResponse

错误响应对象。

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

DocumentIntelligenceInnerError

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

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

DocumentIntelligenceWarning

错误对象。

名称	类型	说明
code	string	服务器定义的警告代码集之一。
message	string	警告的可读表示形式。
target	string	错误的目标。

DocumentModelDetails

文档模型信息。

名称	类型	默认值	说明
apiVersion	string		用于创建此文档模型的 API 版本。
azureBlobFileListSource	AzureBlobFileListContentSource		指定训练数据的 Azure Blob 存储文件列表。 必须指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource	AzureBlobContentSource		包含训练数据的 Azure Blob 存储位置。 必须指定 azureBlobSource 或 azureBlobFileListSource。
buildMode	DocumentBuildMode		自定义文档模型生成模式。
classifierId	string		对于组合模型，自定义分类器用于拆分和分类输入文件。
createdDateTime	string		创建文档模型的日期和时间（UTC）。
description	string		文档模型说明。
docTypes	<string,  DocumentTypeDetails>		支持的文档类型。
expirationDateTime	string		文档模型到期的日期和时间（UTC）。
modelId	string		唯一的文档模型名称。
modifiedDateTime	string		上次修改文档模型的日期和时间（UTC）。
split	SplitMode	none	对于组合模型，文件拆分行为。
tags	object		与文档模型关联的键值标记属性的列表。
trainingHours	number		用于模型训练的 V100 等效 GPU 小时数。
warnings	DocumentIntelligenceWarning[]		生成模型时遇到的警告列表。

DocumentTypeDetails

文档类型信息。

名称	类型	说明
buildMode	DocumentBuildMode	自定义文档模型生成模式。
confidenceThreshold	number	仅当 docType 置信度高于阈值时，才执行分析。
description	string	文档模型说明。
features	DocumentAnalysisFeature[]	可选分析功能列表。
fieldConfidence	object	每个字段的估计置信度。
fieldSchema	<string,  DocumentFieldSchema>	使用 JSON 架构样式语法描述文档语义架构。
maxDocumentsToAnalyze	integer	要分析的指定类型的文档的最大数量。 Default=all。
modelId	string	用于分析具有指定类型的文档的文档模型。
queryFields	string[]	要提取的其他字段的列表。 前任。 “NumberOfGuests，StoreNumber”

PagedDocumentModelDetails

DocumentModelDetails 项的分页集合

名称	类型	说明
nextLink	string	指向下一页项的链接
value	DocumentModelDetails[]	此页上的 DocumentModelDetails 项

SplitMode

文件拆分行为。

名称	类型	说明
auto	string	自动将文件拆分为文档。
none	string	将整个文件视为单个文档。
perPage	string	将文件中的每一页视为单独的文档。