Custom Models - Get Summary

服務:

Azure AI Services

API 版本:

2.1

取得所有自定義模型的相關信息

GET {endpoint}/formrecognizer/v2.1/custom/models?op=summary

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點 (通訊協定和主機名，例如： https://westus2.api.cognitive.microsoft.com) 。
op	query	True	string	指定是否要傳回模型的摘要或完整清單。

要求標頭

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

回應

名稱	類型	Description
200 OK	Models	Success
Other Status Codes	ErrorResponse	回應實體隨附的非成功回應，其中包含有關錯誤的其他詳細數據。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

範例

Get models summary

範例要求

HTTP

GET {endpoint}/formrecognizer/v2.1/custom/models?op=summary

範例回覆

狀態碼:

200

{
  "summary": {
    "count": 5,
    "limit": 5000,
    "lastUpdatedDateTime": "2019-05-01T10:53:21Z"
  }
}

定義

名稱	Description
Attributes	選擇性的模型屬性。
ErrorInformation
ErrorResponse
ModelInfo	基本自定義模型資訊。
Models	回應清單自定義模型作業。
ModelStatus	模型的狀態。
Summary	所有定型自定義模型的摘要。

Attributes

選擇性的模型屬性。

名稱	類型	預設值	Description
isComposed	boolean	False	此模型是否組成？ (預設值：false) 。

ErrorInformation

名稱	類型	Description
code	string
message	string

ErrorResponse

名稱	類型	Description
error	ErrorInformation

ModelInfo

基本自定義模型資訊。

名稱	類型	Description
attributes	Attributes	選擇性的模型屬性。
createdDateTime	string	建立模型時的日期和時間 (UTC) 。
lastUpdatedDateTime	string	上次更新狀態的日期和時間 (UTC) 。
modelId	string	模型標識碼。
modelName	string	選擇性使用者定義模型名稱 (長度上限：1024) 。
status	ModelStatus	模型的狀態。

Models

回應清單自定義模型作業。

名稱	類型	Description
modelList	ModelInfo[]	定型自定義模型的集合。
nextLink	string	連結至自定義模型的下一頁。
summary	Summary	所有定型自定義模型的摘要。

ModelStatus

模型的狀態。

名稱	類型	Description
creating	string
invalid	string
ready	string

Summary

所有定型自定義模型的摘要。

名稱	類型	Description
count	integer	已定型自定義模型的目前計數。
lastUpdatedDateTime	string	上次更新摘要的日期和時間 (UTC) 。
limit	integer	可為此帳戶定型的模型數目上限。