Analyzers - Update

服務:

Azure AI Services

API 版本:

2024-12-01-preview

更新分析器屬性。

PATCH {endpoint}/contentunderstanding/analyzers/{analyzerId}?api-version=2024-12-01-preview

URI 參數

名稱	位於	必要	類型	Description
analyzerId	path	True	string	分析器的唯一標識碼。 Regex 模式: ^[a-zA-Z0-9._-]{1,64}$
endpoint	path	True	string uri	Content Understanding 服務端點。
api-version	query	True	string	要用於這項作業的 API 版本。

要求標頭

Media Types: "application/merge-patch+json"

名稱	必要	類型	Description
x-ms-client-request-id		string uuid	要求不透明、全域唯一、用戶端產生的字串標識碼。

要求本文

Media Types: "application/merge-patch+json"

名稱	類型	Description
description	string	分析器的描述。
tags	object	與分析器相關聯的標記。

回應

名稱	類型	Description
200 OK	ContentAnalyzer	要求已成功。 標題 x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	未預期的錯誤回應。 標題 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: accessCode
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize
權杖 URL: https://login.microsoftonline.com/common/oauth2/token

範圍

名稱	Description
https://cognitiveservices.azure.com/.default

範例

Update Analyzer

範例要求

HTTP

PATCH {endpoint}/contentunderstanding/analyzers/myAnalyzer?api-version=2024-12-01-preview

{
  "description": "Updated analyzer description.",
  "tags": {
    "reviewedBy": "Paul"
  }
}

範例回覆

狀態碼:

200

{
  "analyzerId": "myAnalyzer",
  "description": "Updated analyzer description.",
  "tags": {
    "createdBy": "John",
    "reviewedBy": "Paul"
  },
  "status": "succeeded",
  "createdAt": "2024-10-14T18:46:36.051Z",
  "lastModifiedAt": "2024-10-14T18:46:36.051Z",
  "baseAnalyzerId": "prebuilt-document",
  "config": {
    "locales": null,
    "enableFace": false,
    "enableOcr": true,
    "enableLayout": true,
    "enableBarcode": true,
    "enableFormula": false,
    "returnDetails": true
  },
  "fieldSchema": {
    "name": "MyForm",
    "description": "My custom form",
    "fields": {
      "Company": {
        "type": "string",
        "description": "Name of company."
      }
    },
    "definitions": {}
  },
  "trainingData": {
    "kind": "blob",
    "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
    "prefix": "trainingData",
    "fileListPath": "trainingData/fileList.jsonl"
  }
}

定義

名稱	Description
Azure.Core.Foundations.Error	error 物件。
Azure.Core.Foundations.ErrorResponse	包含錯誤詳細數據的回應。
Azure.Core.Foundations.InnerError	物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
BlobDataSource	Blob 記憶體數據源。
ContentAnalyzer	從多模式檔擷取內容和欄位的分析器。
ContentAnalyzerConfig	分析器的組態設定。
ContentAnalyzerUpdate	從多模式檔擷取內容和欄位的分析器。
DataSourceKind	數據源種類。
FieldDefinition	使用類似語法的 JSON 架構定義欄位。
FieldSchema	要從檔擷取的欄位架構。
FieldType	域值的語意數據類型。
GenerationMethod	產生方法。
ResourceStatus	資源的狀態。

Azure.Core.Foundations.Error

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	Azure.Core.Foundations.Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	Azure.Core.Foundations.InnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

Azure.Core.Foundations.ErrorResponse

包含錯誤詳細數據的回應。

名稱	類型	Description
error	Azure.Core.Foundations.Error	error 物件。

Azure.Core.Foundations.InnerError

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	Azure.Core.Foundations.InnerError	內部錯誤。

BlobDataSource

Blob 記憶體數據源。

名稱	類型	Description
containerUrl	string	Blob 容器的 URL。
fileListPath	string	列出要包含之特定 Blob 之檔案的選擇性路徑。
kind	string: blob	數據源的種類。
prefix	string	選擇性前置詞，用來篩選容器內的 Blob。

ContentAnalyzer

從多模式檔擷取內容和欄位的分析器。

名稱	類型	Description
analyzerId	string	分析器的唯一標識碼。
baseAnalyzerId	string	要從中累加定型的分析器。
config	ContentAnalyzerConfig	分析器組態設定。
createdAt	string	建立分析器的日期和時間。
description	string	分析器的描述。
fieldSchema	FieldSchema	要擷取之字段的架構。
lastModifiedAt	string	上次修改分析器的日期和時間。
scenario	string	分析器的優化案例。
status	ResourceStatus	分析器的狀態。
tags	object	與分析器相關聯的標記。
trainingData	DataSource: BlobDataSource	數據源，其中包含分析器的定型數據。
warnings	Azure.Core.Foundations.Error[]	建立分析器時遇到的警告。

ContentAnalyzerConfig

分析器的組態設定。

名稱	類型	Description
enableBarcode	boolean	啟用條碼偵測。
enableFace	boolean	啟用臉部偵測。
enableFormula	boolean	啟用數學公式偵測。
enableLayout	boolean	啟用版面配置分析。
enableOcr	boolean	啟用光學字元辨識（OCR）。
locales	string[]	語音轉譯的地區設定提示清單。
returnDetails	boolean	傳回所有內容詳細數據。

ContentAnalyzerUpdate

從多模式檔擷取內容和欄位的分析器。

名稱	類型	Description
description	string	分析器的描述。
tags	object	與分析器相關聯的標記。

DataSourceKind

數據源種類。

名稱	類型	Description
blob	string	Blob 記憶體數據源。

FieldDefinition

使用類似語法的 JSON 架構定義欄位。

名稱	類型	預設值	Description
$ref	string		另一個字段定義的參考。
description	string		欄位描述。
enum	string[]		可能域值的列舉。
enumDescriptions	object		每個列舉值的描述。
examples	string[]		域值的範例。
items	FieldDefinition		如果 type 是 array，則每個數位專案的欄位類型架構。
method	GenerationMethod	generate	產生方法。
properties	<string,  FieldDefinition>		如果類型為物件，則命名子欄位。
type	FieldType		域值的語意數據類型。

FieldSchema

要從檔擷取的欄位架構。

名稱	類型	Description
definitions	<string,  FieldDefinition>	架構中欄位所參考的其他定義。
description	string	欄位架構的描述。
fields	<string,  FieldDefinition>	架構中定義的欄位。
name	string	欄位架構的名稱。

FieldType

域值的語意數據類型。

名稱	類型	Description
array	string	相同類型的子欄位清單。
boolean	string	布爾值。
date	string	日期，標準化為 ISO 8601 （YYYY-MM-DD） 格式。
integer	string	整數為64位帶正負號的整數。
number	string	數位為雙精確度浮點數。
object	string	子欄位的具名清單。
string	string	純文本。
time	string	時間，標準化為 ISO 8601 （hh：mm：ss） 格式。

GenerationMethod

產生方法。

名稱	類型	Description
classify	string	值會根據預先定義的類別集合進行分類。
extract	string	值會在內容中出現時擷取。
generate	string	值會根據內容自由產生。

ResourceStatus

資源的狀態。

名稱	類型	Description
creating	string	正在建立資源。
deleting	string	正在刪除資源。
failed	string	資源在建立期間失敗。
ready	string	資源已就緒。