Document Models - List Models

服務:

Azure AI Services

API 版本:

2022-08-31

列出所有檔模型

GET {endpoint}/formrecognizer/documentModels?api-version=2022-08-31

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點 (通訊協定和主機名，例如： https://westus2.api.cognitive.microsoft.com) 。
api-version	query	True	ApiVersion	要求的 API 版本。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string

回應

名稱	類型	Description
200 OK	GetDocumentModelsResponse	正常。
Other Status Codes	ErrorResponse	發生錯誤。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

範例

GetDocumentModels

範例要求

HTTP

GET {endpoint}/formrecognizer/documentModels?api-version=2022-08-31

範例回覆

狀態碼:

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": "2022-08-31"
    },
    {
      "modelId": "myCustomModel",
      "createdDateTime": "2021-09-24T12:54:35Z",
      "description": "{modelDescription}",
      "apiVersion": "2022-08-31"
    }
  ],
  "nextLink": "{nextLinkUrl}"
}

定義

名稱	Description
ApiVersion	API 版本。
DocumentModelSummary	檔模型摘要。
Error	錯誤資訊。
ErrorResponse	錯誤回應物件。
GetDocumentModelsResponse	列出檔模型回應物件。
InnerError	詳細的錯誤。

ApiVersion

API 版本。

名稱	類型	Description
2022-08-31	string

DocumentModelSummary

檔模型摘要。

名稱	類型	Description
apiVersion	string	用來建立此檔模型的 API 版本。
createdDateTime	string	建立檔模型時的日期和時間 (UTC) 。
description	string	檔模型描述。
modelId	string	唯一的檔模型名稱。
tags	object	與檔模型相關聯的索引鍵/值標籤屬性清單。

Error

錯誤資訊。

名稱	類型	Description
code	string	錯誤碼。
details	Error[]	詳細錯誤清單。
innererror	InnerError	詳細的錯誤。
message	string	錯誤訊息。
target	string	錯誤的目標。

ErrorResponse

錯誤回應物件。

名稱	類型	Description
error	Error	錯誤資訊。

GetDocumentModelsResponse

列出檔模型回應物件。

名稱	類型	Description
nextLink	string	連結至檔模型的下一頁。
value	DocumentModelSummary[]	檔案模型清單。

InnerError

詳細的錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	InnerError	詳細的錯誤。
message	string	錯誤訊息。