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

Document Models - List Models

Service:

Azure AI Services

API Version:

2024-02-29-preview

列出所有文档模型

GET {endpoint}/documentintelligence/documentModels?api-version=2024-02-29-preview

URI 参数

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

请求头

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

响应

名称	类型	说明
200 OK	PagedDocumentModelDetails	请求已成功。 Headers x-ms-client-request-id: string
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

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

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

示例

Get Document Models

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?api-version=2024-02-29-preview

Sample Response

Status code:

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-02-29-preview"
    },
    {
      "modelId": "myCustomModel",
      "createdDateTime": "2021-09-24T12:54:35Z",
      "expirationDateTime": "2023-01-01T00:00:00Z",
      "description": "Custom model description",
      "apiVersion": "2024-02-29-preview"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels?nextLink=nextLinkData"
}

定义

名称	说明
AzureBlobContentSource	Azure Blob 存储内容。
AzureBlobFileListContentSource	Azure Blob 存储中的文件列表。
DocumentBuildMode	自定义文档模型生成模式。
DocumentFieldSchema	使用 JSON 架构样式语法的字段语义架构的说明。
DocumentFieldType	字段值的语义数据类型。
DocumentModelDetails	文档模型信息。
DocumentTypeDetails	文档类型信息。
Error	错误对象。
ErrorResponse	错误响应对象。
InnerError	包含有关错误的更具体信息的对象。
PagedDocumentModelDetails	DocumentModelDetails 项的分页集合
Warning	错误对象。

AzureBlobContentSource

Azure Blob 存储内容。

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

AzureBlobFileListContentSource

Azure Blob 存储中的文件列表。

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

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 格式， (例如 USA) 。
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) 格式。

DocumentModelDetails

文档模型信息。

名称	类型	说明
apiVersion	string	用于创建此文档模型的 API 版本。
azureBlobFileListSource	AzureBlobFileListContentSource	Azure Blob 存储指定训练数据的文件列表。 必须指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource	AzureBlobContentSource	Azure Blob 存储包含训练数据的位置。 必须指定 azureBlobSource 或 azureBlobFileListSource。
buildMode	DocumentBuildMode	自定义文档模型生成模式。
createdDateTime	string	创建文档模型时 (UTC) 日期和时间。
description	string	文档模型说明。
docTypes	<string,  DocumentTypeDetails>	支持的文档类型。
expirationDateTime	string	文档模型过期 (UTC) 日期和时间。
modelId	string	唯一的文档模型名称。
tags	object	与文档模型关联的键值标记属性的列表。
warnings	Warning[]	生成模型时遇到的警告列表。

DocumentTypeDetails

文档类型信息。

名称	类型	说明
buildMode	DocumentBuildMode	自定义文档模型生成模式。
description	string	文档模型说明。
fieldConfidence	object	每个字段的估计置信度。
fieldSchema	<string,  DocumentFieldSchema>	使用 JSON 架构样式语法的文档语义架构的说明。

Error

错误对象。

名称	类型	说明
code	string	服务器定义的一组错误代码中的一个。
details	Error[]	有关导致此项报告错误的特定错误的详细信息数组。
innererror	InnerError	一个 对象，该对象包含比当前对象更具体的错误信息。
message	string	错误的用户可读表示形式。
target	string	错误的目标。

ErrorResponse

错误响应对象。

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

InnerError

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

名称	类型	说明
code	string	服务器定义的一组错误代码中的一个。
innererror	InnerError	内部错误。
message	string	错误的用户可读表示形式。

PagedDocumentModelDetails

DocumentModelDetails 项的分页集合

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

Warning

错误对象。

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