Custom Models - Get

服務:

Azure AI Services

API 版本:

2.1

取得自定義模型的詳細資訊。

GET {endpoint}/formrecognizer/v2.1/custom/models/{modelId}

含選擇性參數:

GET {endpoint}/formrecognizer/v2.1/custom/models/{modelId}?includeKeys={includeKeys}

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點 (通訊協定和主機名，例如： https://westus2.api.cognitive.microsoft.com) 。
modelId	path	True	string uuid	模型標識碼。
includeKeys	query		boolean	在模型資訊中包含擷取金鑰的清單。

要求標頭

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

回應

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

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

範例

Get custom model

範例要求

HTTP

GET {endpoint}/formrecognizer/v2.1/custom/models/f973e3c1-1148-43bb-bea8-49d0603ab3a8

範例回覆

狀態碼:

200

{
  "modelInfo": {
    "modelId": "f973e3c1-1148-43bb-bea8-49d0603ab3a8",
    "modelName": "my composed model",
    "status": "ready",
    "createdDateTime": "2019-05-01T10:53:21Z",
    "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
    "attributes": {
      "isComposed": true
    }
  },
  "keys": {
    "clusters": {
      "0": [
        "Invoice",
        "123112313"
      ],
      "1": [
        "Please remit payment to:",
        "Microsoft"
      ]
    }
  },
  "trainResult": {
    "trainingDocuments": [],
    "fields": [],
    "averageModelAccuracy": 0,
    "errors": []
  },
  "composedTrainResults": [
    {
      "modelId": "4afb20d6-3ed0-4cde-ba40-dbd6207268dd",
      "trainingDocuments": [],
      "fields": [],
      "averageModelAccuracy": 0,
      "errors": []
    },
    {
      "modelId": "6f841356-aa32-42c9-a739-2182c47b79c9",
      "trainingDocuments": [],
      "fields": [],
      "averageModelAccuracy": 0,
      "errors": []
    }
  ]
}

定義

名稱	Description
Attributes	選擇性的模型屬性。
ErrorInformation
ErrorResponse
FormFieldsReport	自定義模型定型欄位的報告。
KeysResult	自定義模型所擷取的索引鍵。
Model	取得自定義模型作業的回應。
ModelInfo	基本自定義模型資訊。
ModelStatus	模型的狀態。
TrainingDocumentInfo	自定義模型定型文件的報表。
TrainResult	自定義模型定型結果。
TrainStatus	定型作業的狀態。

Attributes

選擇性的模型屬性。

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

ErrorInformation

名稱	類型	Description
code	string
message	string

ErrorResponse

名稱	類型	Description
error	ErrorInformation

FormFieldsReport

自定義模型定型欄位的報告。

名稱	類型	Description
accuracy	number	此欄位的估計擷取精確度。
fieldName	string	訓練功能變數名稱。

KeysResult

自定義模型所擷取的索引鍵。

名稱	類型	Description
clusters	object	對象對應 clusterIds 與索引鍵清單。

Model

取得自定義模型作業的回應。

名稱	類型	Description
composedTrainResults	TrainResult[]	撰寫模型的定型結果。
keys	KeysResult	自定義模型所擷取的索引鍵。
modelInfo	ModelInfo	基本自定義模型資訊。
trainResult	TrainResult	自定義模型的定型結果。

ModelInfo

基本自定義模型資訊。

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

ModelStatus

模型的狀態。

名稱	類型	Description
creating	string
invalid	string
ready	string

TrainingDocumentInfo

自定義模型定型文件的報表。

名稱	類型	Description
documentName	string	訓練檔名稱。
errors	ErrorInformation[]	錯誤清單。
pages	integer	已定型的頁面總數。
status	TrainStatus	定型作業的狀態。

TrainResult

自定義模型定型結果。

名稱	類型	Description
averageModelAccuracy	number	平均精確度。
errors	ErrorInformation[]	定型作業期間傳回的錯誤。
fields	FormFieldsReport[]	用來定型模型的欄位清單，以及每個欄位所報告的定型作業錯誤。
modelId	string	模型標識碼。
trainingDocuments	TrainingDocumentInfo[]	用來定型模型的檔案清單，以及每個文件中報告的任何錯誤。

TrainStatus

定型作業的狀態。

名稱	類型	Description
failed	string
partiallySucceeded	string
succeeded	string