Content Analyzers - Create Or Replace

サービス:: Azure AI Services

API バージョン:: 2025-11-01

非同期で新しいアナライザーを作成します。

PUT {endpoint}/contentunderstanding/analyzers/{analyzerId}?api-version=2025-11-01

省略可能なパラメーターを含む:

PUT {endpoint}/contentunderstanding/analyzers/{analyzerId}?api-version=2025-11-01&allowReplace={allowReplace}

URI パラメーター

名前	/	必須	型	説明
analyzerId	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	アナライザーの固有の識別子。
endpoint	path	True	string (uri)	コンテンツ理解サービスエンドポイント。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
allowReplace	query		boolean	既存のリソースを置き換えることを許可します。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

要求本文

名前	型	説明
baseAnalyzerId	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9._-]{1,64}$	アナライザーから段階的に学習できます。
config	ContentAnalyzerConfig	アナライザーの設定。
description	string	アナライザーの説明。
dynamicFieldSchema	boolean	定義されたスキーマ外の追加フィールドを含む可能性があるかどうかを示します。
fieldSchema	ContentFieldSchema	抽出すべきフィールドのスキーマ。
knowledgeSources	KnowledgeSource[]: LabeledDataKnowledgeSource[]	分析装置を強化するために使われる追加の知識源。
models	object	モデルの役割を特定のモデル名にマッピングすること。例: { "完了": "gpt-4.1", "embedding": "text-embedding-3-large" }.
processingLocation	ProcessingLocation	データが処理される場所。デフォルトはグローバルに設定されます。
tags	object	アナライザーに関連付けられたタグ。

応答

名前	型	説明
200 OK	ContentAnalyzer	要求は成功しました。ヘッダー Operation-Location: string x-ms-client-request-id: string
201 Created	ContentAnalyzer	要求が成功し、結果として新しいリソースが作成されました。ヘッダー Operation-Location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

ContentAnalyzer

要求は成功しました。

ヘッダー

Operation-Location: string
x-ms-client-request-id: string

201 Created

ContentAnalyzer

要求が成功し、結果として新しいリソースが作成されました。

ヘッダー

Operation-Location: string
x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

Azureリソースのアクセスキーを使った鍵ベースの認証。

型: apiKey
/: header

EntraIdToken

Microsoft Entra ID OAuth2認証はアクセストークンを使いました。

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/token

スコープ

名前	説明
https://cognitiveservices.azure.com/.default

例

Create or Replace Analyzer

要求のサンプル

HTTP

PUT {endpoint}/contentunderstanding/analyzers/myAnalyzer?api-version=2025-11-01

{
  "description": "My analyzer",
  "tags": {
    "createdBy": "John"
  },
  "baseAnalyzerId": "prebuilt-document",
  "config": {
    "enableFormula": false,
    "returnDetails": true
  },
  "fieldSchema": {
    "name": "MyForm",
    "description": "My form",
    "fields": {
      "Company": {
        "type": "string",
        "description": "Name of company."
      }
    },
    "definitions": {}
  },
  "knowledgeSources": [
    {
      "kind": "labeledData",
      "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
      "prefix": "trainingData",
      "fileListPath": "trainingData/fileList.jsonl"
    }
  ]
}

応答のサンプル

状態コード:: 200

Operation-Location: https://myendpoint.cognitiveservices.azure.com/contentunderstanding/analyzers/myAnalyzer/operations/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2025-11-01

{
  "analyzerId": "myAnalyzer",
  "description": "My analyzer",
  "tags": {
    "createdBy": "John"
  },
  "status": "creating",
  "createdAt": "2025-05-01T18:46:36.051Z",
  "lastModifiedAt": "2025-05-01T18:46:36.051Z",
  "baseAnalyzerId": "prebuilt-document",
  "config": {
    "locales": null,
    "enableOcr": true,
    "enableLayout": true,
    "enableFormula": false,
    "returnDetails": true
  },
  "fieldSchema": {
    "name": "MyForm",
    "description": "My form",
    "fields": {
      "Company": {
        "type": "string",
        "description": "Name of company."
      }
    },
    "definitions": {}
  },
  "knowledgeSources": [
    {
      "kind": "labeledData",
      "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
      "prefix": "trainingData",
      "fileListPath": "trainingData/fileList.jsonl"
    }
  ]
}

状態コード:: 201

Operation-Location: https://myendpoint.cognitiveservices.azure.com/contentunderstanding/analyzers/myAnalyzer/operations/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2025-11-01

{
  "analyzerId": "myAnalyzer",
  "description": "My analyzer",
  "tags": {
    "createdBy": "John"
  },
  "status": "creating",
  "createdAt": "2025-05-01T18:46:36.051Z",
  "lastModifiedAt": "2025-05-01T18:46:36.051Z",
  "baseAnalyzerId": "prebuilt-document",
  "config": {
    "locales": null,
    "enableOcr": true,
    "enableLayout": true,
    "enableFormula": false,
    "returnDetails": true
  },
  "fieldSchema": {
    "name": "MyForm",
    "description": "My form",
    "fields": {
      "Company": {
        "type": "string",
        "description": "Name of company."
      }
    },
    "definitions": {}
  },
  "knowledgeSources": [
    {
      "kind": "labeledData",
      "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
      "prefix": "trainingData",
      "fileListPath": "trainingData/fileList.jsonl"
    }
  ]
}

定義

名前	説明
AnnotationFormat	分析結果マークダウンにおける注釈の表現形式。
Azure.Core.Foundations.Error	エラーオブジェクト。
Azure.Core.Foundations.ErrorResponse	エラーの詳細を含む応答。
Azure.Core.Foundations.InnerError	エラーに関するより具体的な情報を含むオブジェクト。 Azure REST API ガイドライン - https://aka.ms/AzureRestApiGuidelines#handling-errorsに準拠。
ChartFormat	分析結果マークダウンにおけるチャートの表現形式。
ContentAnalyzer	マルチモーダル文書から内容やフィールドを抽出するアナライザー。
ContentAnalyzerConfig	アナライザーの設定。
ContentAnalyzerStatus	資源のステータス。
ContentCategoryDefinition	コンテンツカテゴリの定義。
ContentFieldDefinition	構文のようなJSONスキーマを使ったフィールドの定義。
ContentFieldSchema	文書から抽出するフィールドのスキーマ。
ContentFieldType	フィールド値のセマンティックデータ型。
GenerationMethod	生成方法。
KnowledgeSourceKind	知識源のタイプです。
LabeledDataKnowledgeSource	データ知識源とラベル付けされています。
ProcessingLocation	データが処理される場所。デフォルトはグローバルに設定されます。
SupportedModels	アナライザーがサポートするチャット完了および埋め込みモデル。
TableFormat	分析結果マークダウンにおける表の表現形式。

AnnotationFormat

列挙

分析結果マークダウンにおける注釈の表現形式。

値	説明
none	注釈は表していません。
markdown	マークダウンフォーマットで基本的な注釈情報を表現します。

Azure.Core.Foundations.Error

Object

エラーオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
details	Azure.Core.Foundations.Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	Azure.Core.Foundations.InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

Object

エラーの詳細を含む応答。

名前	型	説明
error	Azure.Core.Foundations.Error	エラーオブジェクト。

Azure.Core.Foundations.InnerError

Object

エラーに関するより具体的な情報を含むオブジェクト。 Azure REST API ガイドライン - https://aka.ms/AzureRestApiGuidelines#handling-errorsに準拠。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。

ChartFormat

列挙

分析結果マークダウンにおけるチャートの表現形式。

値	説明
chartJs	チャートを Chart.js コードブロックとして表現します。
markdown	チャートはマークダウンテーブルで表現します。