Skillsets - Create

サービス:: Search Service

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

検索サービスに新しいスキルセットを作成します。

POST {endpoint}/skillsets?api-version=2025-11-01-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	検索サービスのエンドポイント URL。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

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

要求本文

名前	必須	型	説明
name	True	string	スキルセットの名前。
skills	True	SearchIndexerSkill[]: AzureMachineLearningSkill[] AzureOpenAIEmbeddingSkill[] ChatCompletionSkill[] ConditionalSkill[] ContentUnderstandingSkill[] CustomEntityLookupSkill[] DocumentExtractionSkill[] DocumentIntelligenceLayoutSkill[] EntityLinkingSkill[] EntityRecognitionSkillV3[] ImageAnalysisSkill[] KeyPhraseExtractionSkill[] LanguageDetectionSkill[] MergeSkill[] OcrSkill[] PIIDetectionSkill[] SentimentSkillV3[] ShaperSkill[] SplitSkill[] TextTranslationSkill[] VisionVectorizeSkill[] WebApiSkill[]	スキルセット内のスキルの一覧。
@odata.etag		string	スキルセットの ETag。
cognitiveServices		CognitiveServicesAccount: AIServicesAccountIdentity AIServicesAccountKey CognitiveServicesAccountKey DefaultCognitiveServicesAccount	スキルランディング時に使うためのAzure AIサービスの詳細。
description		string	スキルセットの説明。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vaultで作成する暗号化鍵の説明です。この鍵は、スキルセット定義に対して、Microsoftでさえも復号できない完全な保証を得たい場合に、スキルセット定義に対して追加の暗号化レベルを提供するために使用されます。スキルセット定義を暗号化すると、常に暗号化されたままになります。検索サービスは、このプロパティを null に設定しようとすると無視されます。暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。スキルセットの定義は影響を受けません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
indexProjections		SearchIndexerIndexProjection	セカンダリ検索インデックスへの追加プロジェクションの定義。
knowledgeStore		SearchIndexerKnowledgeStore	強化データのAzureブロブ、テーブル、またはファイルへの追加射影の定義。

応答

名前	型	説明
201 Created	SearchIndexerSkillset	要求が成功し、結果として新しいリソースが作成されました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

api-key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

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

例

SearchServiceCreateSkillset

要求のサンプル

HTTP

POST https://previewexampleservice.search.windows.net/skillsets?api-version=2025-11-01-preview


{
  "name": "tempskillset",
  "description": "Skillset for extracting entities and more",
  "skills": [
    {
      "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
      "name": "skill2",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "countryHint",
          "source": "/document/countryHint"
        }
      ],
      "outputs": [
        {
          "name": "languageCode",
          "targetName": "languageCode"
        }
      ]
    },
    {
      "textSplitMode": "pages",
      "maximumPageLength": 4000,
      "unit": "azureOpenAITokens",
      "azureOpenAITokenizerParameters": {
        "encoderModelName": "cl100k_base",
        "allowedSpecialTokens": [
          "[START]",
          "[END]"
        ]
      },
      "@odata.type": "#Microsoft.Skills.Text.SplitSkill",
      "name": "skill3",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "textItems",
          "targetName": "pages"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
      "name": "skill4",
      "context": "/document/pages/*",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "keyPhrases",
          "targetName": "keyPhrases"
        }
      ]
    },
    {
      "uri": "https://contoso.example.org/",
      "httpMethod": "POST",
      "timeout": "PT5S",
      "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
      "name": "skill5",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "customresult",
          "targetName": "result"
        }
      ]
    },
    {
      "outputMode": "oneToMany",
      "markdownHeaderDepth": "h3",
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill",
      "context": "/document",
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "markdown_document",
          "targetName": "markdown_document"
        }
      ]
    },
    {
      "outputFormat": "text",
      "outputMode": "oneToMany",
      "extractionOptions": [
        "images",
        "locationMetadata"
      ],
      "chunkingProperties": {
        "unit": "characters",
        "maximumLength": 500,
        "overlapLength": 50
      },
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill#2",
      "context": "/document",
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "text_sections",
          "targetName": "text_sections"
        },
        {
          "name": "normalized_images",
          "targetName": "normalized_images"
        }
      ]
    },
    {
      "apiKey": "<api-key>",
      "commonModelParameters": {
        "model": "gpt-4o",
        "frequencyPenalty": 0,
        "presencePenalty": 0,
        "maxTokens": 0,
        "temperature": 0,
        "seed": 0,
        "stop": []
      },
      "extraParameters": {
        "safe_mode": true
      },
      "extraParametersBehavior": "error",
      "responseFormat": {
        "type": "jsonSchema",
        "jsonSchemaProperties": {
          "name": "Some Name",
          "description": "Some Description",
          "strict": true,
          "schema": {
            "type": "object",
            "properties": "{\"steps\": {\"type\": \"array\", \"description\": \"A list of reasoning steps.\", \"items\": {\"type\": \"string\"}}, \"answer\": {\"type\": \"string\", \"description\": \"The final answer.\"}}",
            "required": [
              "steps",
              "answer"
            ],
            "additionalProperties": false
          }
        }
      },
      "uri": "https://azs-grok-aoai.openai.azure.com/openai/deployments/azs-grok-gpt-4o/chat/completions",
      "timeout": "PT30S",
      "degreeOfParallelism": 5,
      "@odata.type": "#Microsoft.Skills.Custom.ChatCompletionSkill",
      "name": "chatCompletionSkill",
      "context": "/document/normalized_images/*",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "systemMessage",
          "source": "/document/system_message"
        },
        {
          "name": "userMessage",
          "source": "/document/user_message"
        },
        {
          "name": "image",
          "source": "/document/normalized_images/*"
        },
        {
          "name": "imageDetail",
          "source": "/document/detail"
        }
      ],
      "outputs": [
        {
          "name": "response",
          "targetName": "response"
        }
      ]
    },
    {
      "extractionOptions": [
        "images",
        "locationMetadata"
      ],
      "chunkingProperties": {
        "unit": "characters",
        "maximumLength": 500,
        "overlapLength": 50
      },
      "@odata.type": "#Microsoft.Skills.Util.ContentUnderstandingSkill",
      "name": "contentUnderstandingSKill",
      "context": "/document",
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "text_sections",
          "targetName": "text_sections2"
        },
        {
          "name": "normalized_images",
          "targetName": "normalized_images2"
        }
      ]
    }
  ],
  "cognitiveServices": {
    "key": "myKey",
    "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com",
    "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey",
    "description": "Description of the Azure AI service resource attached to a skillset"
  },
  "@odata.etag": "0x1234568AE7E58A1"
}

応答のサンプル

状態コード:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "tempskillset",
  "description": "Skillset for extracting entities and more",
  "skills": [
    {
      "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
      "name": "skill2",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "countryHint",
          "source": "/document/countryHint",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "languageCode",
          "targetName": "languageCode"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.SplitSkill",
      "name": "skill3",
      "textSplitMode": "pages",
      "maximumPageLength": 4000,
      "unit": "azureOpenAITokens",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "textItems",
          "targetName": "pages"
        }
      ],
      "azureOpenAITokenizerParameters": {
        "encoderModelName": "cl100k_base",
        "allowedSpecialTokens": [
          "[START]",
          "[END]"
        ]
      }
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
      "name": "skill4",
      "context": "/document/pages/*",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "keyPhrases",
          "targetName": "keyPhrases"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
      "name": "skill5",
      "uri": "https://contoso.example.org/",
      "httpMethod": "POST",
      "timeout": "PT5S",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "customresult",
          "targetName": "result"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill",
      "context": "/document",
      "outputMode": "oneToMany",
      "markdownHeaderDepth": "h3",
      "extractionOptions": [],
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "markdown_document",
          "targetName": "markdown_document"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill#2",
      "context": "/document",
      "outputMode": "oneToMany",
      "outputFormat": "text",
      "extractionOptions": [
        "images",
        "locationMetadata"
      ],
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "text_sections",
          "targetName": "text_sections"
        },
        {
          "name": "normalized_images",
          "targetName": "normalized_images"
        }
      ],
      "chunkingProperties": {
        "unit": "characters",
        "maximumLength": 500,
        "overlapLength": 50
      }
    },
    {
      "@odata.type": "#Microsoft.Skills.Custom.ChatCompletionSkill",
      "name": "chatCompletionSkill",
      "context": "/document/normalized_images/*",
      "uri": "https://azs-grok-aoai.openai.azure.com/openai/deployments/azs-grok-gpt-4o/chat/completions",
      "timeout": "PT30S",
      "degreeOfParallelism": 5,
      "apiKey": "<api-key>",
      "extraParametersBehavior": "error",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "systemMessage",
          "source": "/document/system_message",
          "inputs": []
        },
        {
          "name": "userMessage",
          "source": "/document/user_message",
          "inputs": []
        },
        {
          "name": "image",
          "source": "/document/normalized_images/*",
          "inputs": []
        },
        {
          "name": "imageDetail",
          "source": "/document/detail",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "response",
          "targetName": "response"
        }
      ],
      "commonModelParameters": {
        "model": "gpt-4o",
        "frequencyPenalty": 0,
        "presencePenalty": 0,
        "maxTokens": 0,
        "temperature": 0,
        "seed": 0,
        "stop": []
      },
      "extraParameters": {
        "safe_mode": true
      },
      "responseFormat": {
        "type": "jsonSchema",
        "jsonSchemaProperties": {
          "name": "Some Name",
          "description": "Some Description",
          "strict": true,
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "steps",
              "answer"
            ],
            "properties": "{\"steps\": {\"type\": \"array\", \"description\": \"A list of reasoning steps.\", \"items\": {\"type\": \"string\"}}, \"answer\": {\"type\": \"string\", \"description\": \"The final answer.\"}}"
          }
        }
      }
    },
    {
      "@odata.type": "#Microsoft.Skills.Util.ContentUnderstandingSkill",
      "name": "contentUnderstandingSKill",
      "context": "/document",
      "extractionOptions": [
        "images",
        "locationMetadata"
      ],
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "text_sections",
          "targetName": "text_sections2"
        },
        {
          "name": "normalized_images",
          "targetName": "normalized_images2"
        }
      ],
      "chunkingProperties": {
        "unit": "characters",
        "maximumLength": 500,
        "overlapLength": 50
      }
    }
  ],
  "cognitiveServices": {
    "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey",
    "description": "Description of the Azure AI service resource attached to a skillset",
    "key": "myKey",
    "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com"
  }
}

定義

名前	説明
Accept	Acceptヘッダーです。
AIServicesAccountIdentity	スキルセットに紐づけられたAzure AIサービスリソースのマルチリージョンアカウントです。
AIServicesAccountKey	スキルセットに紐づけられたAzure AIサービスリソースのアカウントキーで、そのリソースのサブドメインで使われます。
AzureMachineLearningSkill	AMLスキルは、カスタムAzure Machine Learning(AML)モデルでAIの強化を拡張することを可能にします。 AML モデルのトレーニングとデプロイが完了すると、AML スキルによって AI エンリッチメントに統合されます。
AzureOpenAIEmbeddingSkill	Azure OpenAIリソースを使って、与えられたテキスト入力に対してベクトル埋め込みを生成できます。
AzureOpenAIModelName	Azure Open AIモデル名で呼ばれます。
AzureOpenAITokenizerParameters	Azure OpenAI Tokenizer parameters.
ChatCompletionCommonModelParameters	チャット完了の共通言語モデルパラメーター。省略すると、デフォルト値が使用されます。
ChatCompletionExtraParametersBehavior	Azure AI Foundryが「extraParameters」をどのように扱うべきかを規定しています。デフォルトは「error」です。
ChatCompletionResponseFormat	言語モデルの応答をシリアル化する方法を決定します。デフォルトは「テキスト」です。
ChatCompletionResponseFormatType	LLM が応答をフォーマットする方法を指定します。
ChatCompletionSchema	モデルが出力を構造化するために使用するカスタムスキーマを定義するオブジェクト。
ChatCompletionSchemaProperties	JSONスキーマのレスポンス形式に関するプロパティ。
ChatCompletionSkill	Azure AI FoundryのChat Completionsエンドポイントを通じて言語モデルを呼び出しるスキルです。
CognitiveServicesAccountKey	スキルセットに紐づくAzure AIサービスリソースのマルチリージョンアカウントキー。
ConditionalSkill	ブール演算を必要とするシナリオで、出力に割り当てるデータを決定できるようにするスキル。
ContentUnderstandingSkill	Azure AIコンテンツ理解を活用して文書から構造化されたインサイトを処理・抽出し、文書のインデックス作成と検索性を高める充実した検索可能なコンテンツを実現します。
ContentUnderstandingSkillChunkingProperties	コンテンツをチャンクするためのカーディナリティを制御します。
ContentUnderstandingSkillExtractionOptions	スキルによってドキュメントから抽出されたコンテンツのカーディナリティを制御します。
CustomEntity	検出された一致と関連するメタデータに関する情報を含むオブジェクト。
CustomEntityAlias	ルートエンティティ名の代替のスペルまたはシノニムを指定するために使用できる複合オブジェクト。
CustomEntityLookupSkill	スキルは、ユーザー定義の単語と語句のカスタムリストからテキストを検索します。
CustomEntityLookupSkillLanguage	CustomEntityLookupSkill による入力テキストでサポートされている言語コード。
DefaultCognitiveServicesAccount	スキルセットのデフォルトAzure AIサービスリソースを表す空のオブジェクトです。
DocumentExtractionSkill	エンリッチメントパイプライン内のファイルからコンテンツを抽出するスキル。
DocumentIntelligenceLayoutSkill	Azure AI Servicesを通じて、エンリッチメントパイプライン内のファイルからコンテンツやレイアウト情報を抽出するスキルです。
DocumentIntelligenceLayoutSkillChunkingProperties	コンテンツをチャンクするためのカーディナリティを制御します。
DocumentIntelligenceLayoutSkillExtractionOptions	スキルによってドキュメントから抽出されたコンテンツのカーディナリティを制御します。
EntityCategory	返すエンティティカテゴリを示す文字列。
EntityLinkingSkill	Text Analytics APIを使い、テキストからリンクされたエンティティを抽出します。
EntityRecognitionSkillLanguage	EntityRecognitionSkill によって入力テキストでサポートされている言語コード。
EntityRecognitionSkillV3	Text Analytics APIを使い、テキストから異なるタイプのエンティティを抽出します。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。
ImageAnalysisSkill	画像ファイルを分析するスキル。画像の内容に基づいて、豊富なビジュアル機能のセットを抽出します。
ImageAnalysisSkillLanguage	ImageAnalysisSkillによる入力でサポートされている言語コード。
ImageDetail	返すドメイン固有の詳細を示す文字列。
IndexProjectionMode	インデクサーの残りの部分に対するインデックスプロジェクションの動作を定義します。
InputFieldMappingEntry	スキルの入力フィールドマッピング。
KeyPhraseExtractionSkill	キーフレーズ抽出にテキスト分析を使用するスキル。
KeyPhraseExtractionSkillLanguage	KeyPhraseExtractionSkill による入力テキストでサポートされている言語コード。
LanguageDetectionSkill	入力テキストの言語を検出し、要求で送信されたすべてのドキュメントに対して 1 つの言語コードを報告するスキル。言語コードは、分析の信頼度を示すスコアとペアになっています。
MergeSkill	2 つ以上の文字列を 1 つの統合文字列にマージするスキル。オプションのユーザー定義区切り記号で各コンポーネント部分を区切ります。
OcrLineEnding	OCR スキルによって認識されるテキスト行間で使用する文字のシーケンスを定義します。既定値は "space" です。
OcrSkill	画像ファイルからテキストを抽出するスキル。
OcrSkillLanguage	OcrSkill による入力でサポートされている言語コード。
OutputFieldMappingEntry	スキルの出力フィールドマッピング。
PIIDetectionSkill	Text Analytics APIを使うことで、入力テキストから個人情報を抽出し、マスクするオプションも提供します。
PIIDetectionSkillMaskingMode	入力テキストで検出された個人情報をマスクするために使用する maskingMode を示す文字列。
SearchIndexerDataNoneIdentity	データソースの ID プロパティをクリアします。
SearchIndexerDataUserAssignedIdentity	使用するデータソースの ID を指定します。
SearchIndexerIndexProjection	セカンダリ検索インデックスへの追加プロジェクションの定義。
SearchIndexerIndexProjectionSelector	指定された検索インデックスに格納するデータの説明。
SearchIndexerIndexProjectionsParameters	インデックスプロジェクション固有の構成プロパティのディクショナリ。各名前は、特定のプロパティの名前です。各値はプリミティブ型である必要があります。
SearchIndexerKnowledgeStore	エンリッチされたデータの Azure BLOB、テーブル、またはファイルへの追加プロジェクションの定義。
SearchIndexerKnowledgeStoreFileProjectionSelector	Azure Filesにどのデータを保存するかの投影定義。
SearchIndexerKnowledgeStoreObjectProjectionSelector	Azure Blobにどのデータを保存するかのプロジェクション定義。
SearchIndexerKnowledgeStoreParameters	ナレッジストア固有の構成プロパティのディクショナリ。各名前は、特定のプロパティの名前です。各値はプリミティブ型である必要があります。
SearchIndexerKnowledgeStoreProjection	さまざまなプロジェクションセレクターのコンテナーオブジェクト。
SearchIndexerKnowledgeStoreTableProjectionSelector	Azure Tablesに保存するデータについての説明。
SearchIndexerSkillset	スキルの一覧。
SearchResourceEncryptionKey	Azure Key Vault の顧客管理の暗号化キー。作成および管理するキーを使用して、インデックスやシノニムマップなどの保存データの暗号化または暗号化解除を行うことができます。
SentimentSkillLanguage	SentimentSkill によって入力テキストでサポートされている言語コード。
SentimentSkillV3	Text Analytics APIを用いて、非構造化テキストを評価し、各レコードに対して、サービスが文レベルおよび文書レベルで得た最高の信頼度スコアに基づいて「ネガティブ」「ニュートラル」「ポジティブ」などのセンチメントラベルを提供します。
ShaperSkill	出力を再整形するためのスキル。複合フィールド (マルチパートフィールドとも呼ばれます) をサポートする複合型が作成されます。
SplitSkill	文字列をテキストのチャンクに分割するスキル。
SplitSkillEncoderModelName	どのトークナイザーを使うべきかを示す値です。
SplitSkillLanguage	SplitSkill による入力テキストでサポートされている言語コード。
SplitSkillUnit	使用する単位を示す値。
TextSplitMode	実行する分割モードを示す値。
TextTranslationSkill	ある言語から別の言語にテキストを翻訳するスキル。
TextTranslationSkillLanguage	TextTranslationSkill による入力テキストでサポートされている言語コード。
VisionVectorizeSkill	Azure AI ServicesのVision Vectorize APIを使って、画像やテキスト入力に対してベクター埋め込みを生成できます。
VisualFeature	返すビジュアル機能の種類を示す文字列。
WebApiSkill	Web API エンドポイントを呼び出すことができるスキル。カスタムコードを呼び出すことでスキルセットを拡張できます。

Accept

列挙

Acceptヘッダーです。

値	説明
application/json;odata.metadata=minimal

AIServicesAccountIdentity

Object

スキルセットに紐づけられたAzure AIサービスリソースのマルチリージョンアカウントです。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.AIServicesByIdentity	派生型の識別子。
description	string	スキルセットに添付されたAzure AIサービスリソースの説明。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	AI サービスへの接続に使用されるユーザー割り当てマネージド ID。指定しない場合は、システム割り当てマネージド ID が使用されます。スキルセットの更新時に、ID が指定されていない場合、値は変更されません。「none」に設定すると、このプロパティの値はクリアされます。
subdomainUrl	string	対応するAIサービスのサブドメイン/Azure AI ServicesエンドポイントURL。

AIServicesAccountKey

Object

スキルセットに紐づけられたAzure AIサービスリソースのアカウントキーで、そのリソースのサブドメインで使われます。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.AIServicesByKey	派生型の識別子。
description	string	スキルセットに添付されたAzure AIサービスリソースの説明。
key	string	スキルセットに紐づいたAzure AIサービスリソースをプロビジョニングするために使われたキーです。
subdomainUrl	string	対応するAIサービスのサブドメイン/Azure AI ServicesエンドポイントURL。

AzureMachineLearningSkill

Object

AMLスキルは、カスタムAzure Machine Learning(AML)モデルでAIの強化を拡張することを可能にします。 AML モデルのトレーニングとデプロイが完了すると、AML スキルによって AI エンリッチメントに統合されます。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Custom.AmlSkill	派生型の識別子。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
degreeOfParallelism	integer (int32)	(省略可能)指定した場合、インデクサーが指定したエンドポイントと並行して行う呼び出しの数を示します。要求の負荷が高すぎる場合にエンドポイントが失敗した場合は、この値を小さくするか、エンドポイントがより多くの要求を受け入れることができ、インデクサーのパフォーマンスを向上させる場合は、この値を上げることができます。設定しない場合は、既定値の 5 が使用されます。 degreeOfParallelism は、最大 10 と最小 1 に設定できます。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
key	string	(キー認証に必要)AML サービスのキー。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。
region	string	(トークン認証の場合は省略可能)。 AML サービスがデプロイされているリージョン。
resourceId	string	(トークン認証に必要)。 AMLサービスのAzure Resource ManagerリソースIDです。フォーマットはsubscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoftのはずです。MachineLearningServices/workspaces/{workspace-name}/services/{service_name}.
timeout	string (duration)	(省略可能) 指定した場合は、API 呼び出しを行う http クライアントのタイムアウト値を示します。
uri	string (uri)	(認証またはキー認証がない場合は必須)JSON ペイロードの送信先となる AML サービスのスコア付け URI。 https URI スキームのみが許可されます。

AzureOpenAIEmbeddingSkill

Object

Azure OpenAIリソースを使って、与えられたテキスト入力に対してベクトル埋め込みを生成できます。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	派生型の識別子。
apiKey	string	指定されたAzure OpenAIリソースのAPIキー。
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	送信接続に使用されるユーザー割り当てマネージド ID。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
deploymentId	string	指定されたリソース上のAzure OpenAIモデル展開のID。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
dimensions	integer (int32)	結果として出力される埋め込みに必要なディメンションの数。 text-embedding-3 以降のモデルでのみサポートされます。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
modelName	AzureOpenAIModelName	指定された deploymentId パスにデプロイされる埋め込みモデルの名前。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。
resourceUri	string (uri)	Azure OpenAIリソースのリソースURIです。

AzureOpenAIModelName

列挙

Azure Open AIモデル名で呼ばれます。

値	説明
text-embedding-ada-002	TextEmbeddingAda002モデル。
text-embedding-3-large	TextEmbedding3Largeモデル。
text-embedding-3-small	TextEmbedding3Small モデル。
gpt-4o	GPT4oモデル。
gpt-4o-mini	GPT4oMiniモデル。
gpt-4.1	GPT41モデル。
gpt-4.1-mini	GPT41Miniモデルです。
gpt-4.1-nano	GPT41Nanoモデル。
gpt-5	GPT5モデル。
gpt-5-mini	GPT5Miniモデル。
gpt-5-nano	Gpt5Nanoモデルです。

AzureOpenAITokenizerParameters

Object

Azure OpenAI Tokenizer parameters.

名前	型	説明
allowedSpecialTokens	string[]	(オプション)単位が azureOpenAITokens に設定されている場合にのみ適用されます。このパラメーターは、トークン化プロセス内で許可される特別なトークンのコレクションを定義します。
encoderModelName	SplitSkillEncoderModelName	ユニットが azureOpenAITokens に設定されている場合にのみ適用されます。オプションには、「R50k_base」、「P50k_base」、「P50k_edit」、「CL100k_base」が含まれます。デフォルト値は「CL100k_base」です。

ChatCompletionCommonModelParameters

Object

チャット完了の共通言語モデルパラメーター。省略すると、デフォルト値が使用されます。

名前	型	規定値	説明
frequencyPenalty	number (double)	0	[-2,2] の範囲の浮動小数点で、トークンが繰り返される可能性を増減します。既定値は 0 です。
maxTokens	integer (int32)		生成するトークンの最大数。
model	string		使用するモデルの名前(例:'gpt-4o'など)。指定しない場合、デフォルトは null です。
presencePenalty	number (double)	0	[-2,2] の範囲のフロートで、既存の存在に基づいて新しいトークンにペナルティを課します。既定値は 0 です。
seed	integer (int32)		決定論的出力を制御するためのランダムシード省略すると、ランダム化が使用されます。
stop	string[]		テキスト生成を遮断する停止シーケンスのリスト。デフォルトは none です。
temperature	number (double)	0.7	サンプリング温度。デフォルトは 0.7 です。

ChatCompletionExtraParametersBehavior

列挙

Azure AI Foundryが「extraParameters」をどのように扱うべきかを規定しています。デフォルトは「error」です。

値	説明
passThrough	余分なパラメータは直接モデルに渡します。
drop	余分なパラメータをすべて削除します。
error	余分なパラメータが存在する場合にエラーを発生させます。

ChatCompletionResponseFormat

Object

言語モデルの応答をシリアル化する方法を決定します。デフォルトは「テキスト」です。

名前	型	規定値	説明
jsonSchemaProperties	ChatCompletionSchemaProperties		拡張プロパティのオープンディクショナリ。 'type' == 'json_schema'の場合は必須
type	ChatCompletionResponseFormatType	text	LLM が応答をフォーマットする方法を指定します。

ChatCompletionResponseFormatType

列挙

LLM が応答をフォーマットする方法を指定します。

値	説明
text	プレーンテキストのレスポンス形式。
jsonObject	任意のJSONオブジェクト応答形式。
jsonSchema	JSONスキーマに準拠した応答フォーマット。

ChatCompletionSchema

Object

モデルが出力を構造化するために使用するカスタムスキーマを定義するオブジェクト。

名前	型	規定値	説明
additionalProperties	boolean	False	JSON スキーマで定義されていない追加のキー/値を含むことをオブジェクトに含めるかどうかを制御します。既定値は false です。
properties	string		モデルの出力スキーマのプロパティと制約を定義する JSON 形式の文字列。
required	string[]		モデルの応答の一部となる必要があるプロパティ名の配列。構造化出力には、すべてのプロパティを含める必要があります。
type	string	object	スキーマ表現のタイプ。通常は「オブジェクト」。デフォルトは「オブジェクト」です。

ChatCompletionSchemaProperties

Object

JSONスキーマのレスポンス形式に関するプロパティ。

名前	型	規定値	説明
description	string		モデルが準拠する json スキーマの説明。
name	string		モデルが従うjsonスキーマの名前。
schema	ChatCompletionSchema		スキーマの定義。
strict	boolean	True	モデルの応答で構造化された出力を使用するかどうか。既定値は True です。

ChatCompletionSkill

Object

Azure AI FoundryのChat Completionsエンドポイントを通じて言語モデルを呼び出しるスキルです。

名前	型	規定値	説明
@odata.type	string: #Microsoft.Skills.Custom.ChatCompletionSkill		派生型の識別子。
apiKey	string		モデルに対して認証するための API キー。 apiKey と authIdentity の両方を同時に指定することはできません。
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		送信接続に使用されるユーザー割り当てマネージド ID。 authResourceId が指定されていて、指定されていない場合は、システム割り当てマネージド ID が使用されます。インデクサーの更新時に、ID が指定されていない場合、値は変更されません。「none」に設定すると、このプロパティの値はクリアされます。
authResourceId	string		Azure関数や変換を提供する他のアプリケーションで外部コードに接続するカスタムスキルに適用されます。この値は、Azure Active Directoryに登録された際に機能やアプリのために作成されたアプリケーションIDであるべきです。指定すると、カスタムスキルは、検索サービスのマネージド ID (システムまたはユーザー割り当て) と関数またはアプリのアクセストークンを使用して関数またはアプリに接続します。この値は、アクセストークンのスコープを作成するためのリソース ID として使用されます。
batchSize	integer (int32)		ドキュメントの数を示す目的のバッチサイズ。
commonModelParameters	ChatCompletionCommonModelParameters		顧客が微調整できる共通の言語モデルパラメーター。省略すると、合理的なデフォルトが適用されます。
context	string		ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
degreeOfParallelism	integer (int32)		設定されている場合、Web API に対して実行できる並列呼び出しの数。
description	string		スキルの入力、出力、および使用方法を記述するスキルの説明。
extraParameters			チャット完了呼び出しに追加する必要があるモデル固有のパラメーターのオープン型ディクショナリ。 Azure AI Foundryの拡張性パターンに従っています。
extraParametersBehavior	ChatCompletionExtraParametersBehavior	error	Azure AI Foundryがどのように追加パラメータを扱うのか。デフォルトは「error」です。
httpHeaders	object		http 要求を行うために必要なヘッダー。
httpMethod	string		http 要求のメソッド。
inputs	InputFieldMappingEntry[]		スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
name	string		スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]		スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。
responseFormat	ChatCompletionResponseFormat		LLM が応答をどのようにフォーマットするかを決定します。デフォルトは「テキスト」応答タイプです。
timeout	string (duration)		要求に必要なタイムアウト。既定値は 30 秒です。
uri	string		Web API の URL。

CognitiveServicesAccountKey

Object

スキルセットに紐づくAzure AIサービスリソースのマルチリージョンアカウントキー。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.CognitiveServicesByKey	派生型の識別子。
description	string	スキルセットに添付されたAzure AIサービスリソースの説明。
key	string	スキルセットに紐づいたAzure AIサービスリソースをプロビジョニングするために使われたキーです。

ConditionalSkill

Object

ブール演算を必要とするシナリオで、出力に割り当てるデータを決定できるようにするスキル。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Util.ConditionalSkill	派生型の識別子。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

ContentUnderstandingSkill

Object

Azure AIコンテンツ理解を活用して文書から構造化されたインサイトを処理・抽出し、文書のインデックス作成と検索性を高める充実した検索可能なコンテンツを実現します。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Util.ContentUnderstandingSkill	派生型の識別子。
chunkingProperties	ContentUnderstandingSkillChunkingProperties	コンテンツをチャンクするためのカーディナリティを制御します。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
extractionOptions	ContentUnderstandingSkillExtractionOptions[]	スキルによってドキュメントから抽出されたコンテンツのカーディナリティを制御します。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

ContentUnderstandingSkillChunkingProperties

Object

コンテンツをチャンクするためのカーディナリティを制御します。

名前	型	規定値	説明
maximumLength	integer (int32)		チャンクの最大長(文字数)。既定値は 500 です。
overlapLength	integer (int32)		2 つのテキストチャンク間で指定されるオーバーラップの長さ。既定値は 0 です。
unit	enum: characters	characters	チャンクの単位。

ContentUnderstandingSkillExtractionOptions

列挙

スキルによってドキュメントから抽出されたコンテンツのカーディナリティを制御します。

値	説明
images	ドキュメントから画像コンテンツを抽出するように指定します。
locationMetadata	場所のメタデータをドキュメントから抽出するように指定します。

CustomEntity

Object

検出された一致と関連するメタデータに関する情報を含むオブジェクト。

名前	型	説明
accentSensitive	boolean	既定は false です。エンティティ名との比較をアクセントの影響を受けるべきかどうかを示すブール値。
aliases	CustomEntityAlias[]	ルートエンティティ名の代替スペルまたはシノニムを指定するために使用できる複雑なオブジェクトの配列。
caseSensitive	boolean	既定は false です。エンティティ名との比較を文字の大文字と小文字の区別にする必要があるかどうかを示すブール値。「Microsoft」の大文字に区別されない例のマッチングは、microsoft、microSoft、MICROSOFT です。
defaultAccentSensitive	boolean	このエンティティのデフォルトのアクセント感度値を変更します。これは、すべてのエイリアスのデフォルト値 accentSensitive 値を変更するために使用されます。
defaultCaseSensitive	boolean	このエンティティの既定の大文字と小文字の区別値を変更します。これは、すべてのエイリアスのデフォルト値 caseSensitive 値を変更するために使用されます。
defaultFuzzyEditDistance	integer (int32)	このエンティティの既定のあいまい編集距離値を変更します。これを使用して、すべてのエイリアスのデフォルト値 fuzzyEditDistance 値を変更できます。
description	string	このフィールドは、一致したテキストに関するカスタムメタデータのパススルーとして使用できます。このフィールドの値は、スキル出力でそのエンティティが一致するたびに表示されます。
fuzzyEditDistance	integer (int32)	既定値は 0 です。最大値は 5 です。エンティティ名との一致を構成する発散文字の許容数を示します。特定の一致について、可能な限り最小のあいまいさが返されます。例えば、編集距離を3に設定しても、「Windows10」は「Windows」、「Windows10」、「Windows 7」と一致します。大文字と小文字の区別が false に設定されている場合、大文字と小文字の違いはあいまいさの許容範囲にはカウントされませんが、それ以外はカウントされます。
id	string	このフィールドは、一致したテキストに関するカスタムメタデータのパススルーとして使用できます。このフィールドの値は、スキル出力でそのエンティティが一致するたびに表示されます。
name	string	最上位のエンティティ記述子。スキル出力の一致はこの名前でグループ化され、検出されるテキストの「正規化された」形式を表す必要があります。
subtype	string	このフィールドは、一致したテキストに関するカスタムメタデータのパススルーとして使用できます。このフィールドの値は、スキル出力でそのエンティティが一致するたびに表示されます。
type	string	このフィールドは、一致したテキストに関するカスタムメタデータのパススルーとして使用できます。このフィールドの値は、スキル出力でそのエンティティが一致するたびに表示されます。

CustomEntityAlias

Object

ルートエンティティ名の代替のスペルまたはシノニムを指定するために使用できる複合オブジェクト。

名前	型	説明
accentSensitive	boolean	エイリアスがアクセントを区別するかどうかを判断します。
caseSensitive	boolean	エイリアスで大文字と小文字が区別されるかどうかを判断します。
fuzzyEditDistance	integer (int32)	エイリアスのあいまい編集距離を決定します。
text	string	エイリアスのテキスト。

CustomEntityLookupSkill

Object

スキルは、ユーザー定義の単語と語句のカスタムリストからテキストを検索します。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.CustomEntityLookupSkill	派生型の識別子。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
defaultLanguageCode	CustomEntityLookupSkillLanguage	使用する言語コードを示す値。既定値は `en` です。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
entitiesDefinitionUri	string	一致するすべてのターゲットテキストを含む JSON または CSV ファイルへのパス。このエンティティ定義は、インデクサー実行の開始時に読み取られます。インデクサーの実行中にこのファイルを更新しても、後続の実行まで有効になりません。この構成には、HTTPS 経由でアクセスできる必要があります。
globalDefaultAccentSensitive	boolean	AccentSensitive のグローバルフラグ。 CustomEntity で AccentSensitive が設定されていない場合、この値は既定値になります。
globalDefaultCaseSensitive	boolean	CaseSensitive のグローバルフラグ。 CustomEntity で CaseSensitive が設定されていない場合、この値は既定値になります。
globalDefaultFuzzyEditDistance	integer (int32)	FuzzyEditDistance のグローバルフラグ。 CustomEntity で FuzzyEditDistance が設定されていない場合、この値は既定値になります。
inlineEntitiesDefinition	CustomEntity[]	インライン CustomEntity 定義。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

CustomEntityLookupSkillLanguage

列挙

CustomEntityLookupSkill による入力テキストでサポートされている言語コード。

値	説明
da	デンマーク語
de	ドイツ語
en	英語
es	スペイン語
fi	フィンランド語
fr	フランス語
it	イタリア語
ko	韓国語
pt	Portuguese

DefaultCognitiveServicesAccount

Object

スキルセットのデフォルトAzure AIサービスリソースを表す空のオブジェクトです。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.DefaultCognitiveServices	派生型の識別子。
description	string	スキルセットに添付されたAzure AIサービスリソースの説明。

DocumentExtractionSkill

Object

エンリッチメントパイプライン内のファイルからコンテンツを抽出するスキル。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Util.DocumentExtractionSkill	派生型の識別子。
configuration		スキルの構成のディクショナリ。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
dataToExtract	string	スキル用に抽出するデータの種類。定義されていない場合は、'contentAndMetadata' に設定されます。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。
parsingMode	string	スキルの parsingMode。定義されていない場合は、'default' に設定されます。

DocumentIntelligenceLayoutSkill

Object

Azure AI Servicesを通じて、エンリッチメントパイプライン内のファイルからコンテンツやレイアウト情報を抽出するスキルです。

名前	型	規定値	説明
@odata.type	string: #Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill		派生型の識別子。
chunkingProperties	DocumentIntelligenceLayoutSkillChunkingProperties		コンテンツをチャンクするためのカーディナリティを制御します。
context	string		ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
description	string		スキルの入力、出力、および使用方法を記述するスキルの説明。
extractionOptions	DocumentIntelligenceLayoutSkillExtractionOptions[]		スキルによってドキュメントから抽出されたコンテンツのカーディナリティを制御します。
inputs	InputFieldMappingEntry[]		スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
markdownHeaderDepth	enum: h1 h2 h3 h4 h5 h6	h6	マークダウン出力のヘッダーの深さ。既定値は h6 です。
name	string		スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputFormat	enum: markdown text	markdown	出力フォーマットを制御します。デフォルトは「markdown」です。
outputMode	enum: oneToMany	oneToMany	スキルによって生成される出力のカーディナリティを制御します。既定値は 'oneToMany' です。
outputs	OutputFieldMappingEntry[]		スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

DocumentIntelligenceLayoutSkillChunkingProperties

Object

コンテンツをチャンクするためのカーディナリティを制御します。

名前	型	規定値	説明
maximumLength	integer (int32)		チャンクの最大長(文字数)。既定値は 500 です。
overlapLength	integer (int32)		2 つのテキストチャンク間で指定されるオーバーラップの長さ。既定値は 0 です。
unit	enum: characters	characters	チャンクの単位。

DocumentIntelligenceLayoutSkillExtractionOptions

列挙

スキルによってドキュメントから抽出されたコンテンツのカーディナリティを制御します。

値	説明
images	ドキュメントから画像コンテンツを抽出するように指定します。
locationMetadata	場所のメタデータをドキュメントから抽出するように指定します。

EntityCategory

列挙

返すエンティティカテゴリを示す文字列。

値	説明
location	物理的な場所を記述するエンティティ。
organization	組織を記述するエンティティ。
person	人を記述するエンティティ。
quantity	数量を記述するエンティティ。
datetime	日付と時刻を記述するエンティティ。
url	URL を記述するエンティティ。
email	電子メールアドレスを記述するエンティティ。

EntityLinkingSkill

Object

Text Analytics APIを使い、テキストからリンクされたエンティティを抽出します。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.V3.EntityLinkingSkill	派生型の識別子。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
defaultLanguageCode	string	使用する言語コードを示す値。既定値は `en` です。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
minimumPrecision	number (double) minimum: 0 maximum: 1	信頼度スコアが指定された値より大きいエンティティのみを含めるために使用される 0 ~ 1 の値。設定されていない場合 (既定値)、または明示的に null に設定されている場合は、すべてのエンティティが含まれます。
modelVersion	string	Text Analyticsサービスを呼び出す際に使うモデルのバージョン。指定されていない場合は、既定で使用可能な最新の値になります。絶対に必要な場合を除き、この値は指定しないことをお勧めします。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

EntityRecognitionSkillLanguage

列挙

EntityRecognitionSkill によって入力テキストでサポートされている言語コード。

値	説明
ar	アラビア語
cs	チェコ語
zh-Hans	簡体中国語
zh-Hant	繁体字中国語
da	デンマーク語
nl	オランダ語
en	英語
fi	フィンランド語
fr	フランス語
de	ドイツ語
el	ギリシャ語
hu	Hungarian
it	イタリア語
ja	日本語
ko	韓国語
no	ノルウェー語(ボクマール)
pl	ポーランド語
pt-PT	ポルトガル語 (ポルトガル)
pt-BR	ポルトガル語 (ブラジル)
ru	ロシア語
es	スペイン語
sv	スウェーデン語
tr	トルコ語

EntityRecognitionSkillV3

Object

Text Analytics APIを使い、テキストから異なるタイプのエンティティを抽出します。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.V3.EntityRecognitionSkill	派生型の識別子。
categories	EntityCategory[]	抽出する必要があるエンティティカテゴリの一覧。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
defaultLanguageCode	EntityRecognitionSkillLanguage	使用する言語コードを示す値。既定値は `en` です。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
minimumPrecision	number (double) minimum: 0 maximum: 1	信頼度スコアが指定された値より大きいエンティティのみを含めるために使用される 0 ~ 1 の値。設定されていない場合 (既定値)、または明示的に null に設定されている場合は、すべてのエンティティが含まれます。
modelVersion	string	Text Analytics APIを呼び出す際に使うモデルのバージョン。指定されていない場合は、既定で使用可能な最新の値になります。絶対に必要な場合を除き、この値は指定しないことをお勧めします。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info		追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ImageAnalysisSkill

Object

画像ファイルを分析するスキル。画像の内容に基づいて、豊富なビジュアル機能のセットを抽出します。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Vision.ImageAnalysisSkill	派生型の識別子。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
defaultLanguageCode	ImageAnalysisSkillLanguage	使用する言語コードを示す値。既定値は `en` です。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
details	ImageDetail[]	返すドメイン固有の詳細を示す文字列。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。
visualFeatures	VisualFeature[]	ビジュアル機能の一覧。

ImageAnalysisSkillLanguage

列挙

ImageAnalysisSkillによる入力でサポートされている言語コード。

値	説明
ar	アラビア語
az	アゼルバイジャン語
bg	ブルガリア語
bs	ボスニア語 (ラテン)
ca	カタロニア語
cs	チェコ語
cy	Welsh
da	デンマーク語
de	ドイツ語
el	ギリシャ語
en	英語
es	スペイン語
et	Estonian
eu	バスク語
fi	フィンランド語
fr	フランス語
ga	Irish
gl	ガリシア語
he	Hebrew
hi	Hindi
hr	Croatian
hu	Hungarian
id	Indonesian
it	イタリア語
ja	日本語
kk	Kazakh
ko	韓国語
lt	Lithuanian
lv	Latvian
mk	Macedonian
ms	マレー語 (マレーシア)
nb	ノルウェー語 (ブークモール)
nl	オランダ語
pl	ポーランド語
prs	Dari
pt-BR	ポルトガル語 (ブラジル)
pt	ポルトガル語 (ポルトガル)
pt-PT	ポルトガル語 (ポルトガル)
ro	Romanian
ru	ロシア語
sk	Slovak
sl	Slovenian
sr-Cyrl	セルビア語 - キリル文字 RS
sr-Latn	セルビア語 - ラテン RS
sv	スウェーデン語
th	タイ語
tr	トルコ語
uk	ウクライナ語
vi	ベトナム語
zh	簡体字中国語
zh-Hans	簡体字中国語
zh-Hant	繁体中国語

ImageDetail

列挙

返すドメイン固有の詳細を示す文字列。

値	説明
celebrities	有名人として認められたディテール。
landmarks	目印として認識されたディテール。

IndexProjectionMode

列挙

インデクサーの残りの部分に対するインデックスプロジェクションの動作を定義します。

値	説明
skipIndexingParentDocuments	ソースドキュメントは、インデクサーのターゲットインデックスへの書き込みからスキップされます。
includeIndexingParentDocuments	ソースドキュメントは、インデクサーのターゲットインデックスに書き込まれます。これが既定のパターンです。

InputFieldMappingEntry

Object

スキルの入力フィールドマッピング。

名前	型	説明
inputs	InputFieldMappingEntry[]	複合型の作成時に使用される再帰的入力。
name	string	入力の名前。
source	string	入力のソース。
sourceContext	string	再帰入力の選択に使用されるソースコンテキスト。

KeyPhraseExtractionSkill

Object

キーフレーズ抽出にテキスト分析を使用するスキル。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.KeyPhraseExtractionSkill	派生型の識別子。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
defaultLanguageCode	KeyPhraseExtractionSkillLanguage	使用する言語コードを示す値。既定値は `en` です。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
maxKeyPhraseCount	integer (int32)	返すキーフレーズの数を示す数値。存在しない場合は、識別されたすべてのキーフレーズが返されます。
modelVersion	string	Text Analyticsサービスを呼び出す際に使うモデルのバージョン。指定されていない場合は、既定で使用可能な最新の値になります。絶対に必要な場合を除き、この値は指定しないことをお勧めします。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

KeyPhraseExtractionSkillLanguage

列挙

KeyPhraseExtractionSkill による入力テキストでサポートされている言語コード。

値	説明
da	デンマーク語
nl	オランダ語
en	英語
fi	フィンランド語
fr	フランス語
de	ドイツ語
it	イタリア語
ja	日本語
ko	韓国語
no	ノルウェー語(ボクマール)
pl	ポーランド語
pt-PT	ポルトガル語 (ポルトガル)
pt-BR	ポルトガル語 (ブラジル)
ru	ロシア語
es	スペイン語
sv	スウェーデン語

LanguageDetectionSkill

Object

入力テキストの言語を検出し、要求で送信されたすべてのドキュメントに対して 1 つの言語コードを報告するスキル。言語コードは、分析の信頼度を示すスコアとペアになっています。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.LanguageDetectionSkill	派生型の識別子。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
defaultCountryHint	string	言語を明確にできない場合に、言語検出モデルのヒントとして使用する国コード。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
modelVersion	string	Text Analyticsサービスを呼び出す際に使うモデルのバージョン。指定されていない場合は、既定で使用可能な最新の値になります。絶対に必要な場合を除き、この値は指定しないことをお勧めします。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

MergeSkill

Object

2 つ以上の文字列を 1 つの統合文字列にマージするスキル。オプションのユーザー定義区切り記号で各コンポーネント部分を区切ります。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.MergeSkill	派生型の識別子。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
insertPostTag	string	タグは、結合されたテキストの末尾を示します。既定では、タグは空のスペースです。
insertPreTag	string	タグは、結合されたテキストの先頭を示します。既定では、タグは空のスペースです。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

OcrLineEnding

列挙

OCR スキルによって認識されるテキスト行間で使用する文字のシーケンスを定義します。既定値は "space" です。

値	説明
space	行は 1 つのスペース文字で区切られます。
carriageReturn	行はキャリッジリターン ('\r') 文字で区切られます。
lineFeed	行は 1 つの改行 ('\n') 文字で区切られます。
carriageReturnLineFeed	行は、改行と改行 ('\r\n') 文字で区切られます。

OcrSkill

Object

画像ファイルからテキストを抽出するスキル。

名前	型	規定値	説明
@odata.type	string: #Microsoft.Skills.Vision.OcrSkill		派生型の識別子。
context	string		ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
defaultLanguageCode	OcrSkillLanguage		使用する言語コードを示す値。既定値は `en` です。
description	string		スキルの入力、出力、および使用方法を記述するスキルの説明。
detectOrientation	boolean	False	方向検出をオンにするかオンにしないかを示す値。既定値は false です。
inputs	InputFieldMappingEntry[]		スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
lineEnding	OcrLineEnding		OCR スキルによって認識されるテキスト行間で使用する文字のシーケンスを定義します。既定値は "space" です。
name	string		スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]		スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

OcrSkillLanguage

列挙

OcrSkill による入力でサポートされている言語コード。

値	説明
af	Afrikaans
sq	Albanian
anp	アンギカ語 (デーヴァナーガリー)
ar	アラビア語
ast	アストリア語
awa	アワディー語 (デーヴァナーガリー)
az	アゼルバイジャン語 (ラテン)
bfy	バゲーリー語
eu	バスク語
be	ベラルーシ語(キリル文字とラテン文字)
be-cyrl	ベラルーシ語 (キリル)
be-latn	ベラルーシ語 (ラテン)
bho	ボージュプリー語 (デーヴァナーガリー)
bi	ビスラマ語
brx	ボド語 (デーヴァナーガリー)
bs	ボスニア語 (ラテン)
bra	ブラジュバー語
br	ブルトン語
bg	ブルガリア語
bns	ブンデーリー語
bua	ブリヤート語 (キリル)
ca	カタロニア語
ceb	セブアノ語
rab	チャムリング語
ch	チャモロ語
hne	チャッティースガリー語 (デーヴァナーガリー)
zh-Hans	簡体字中国語
zh-Hant	繁体中国語
kw	コーンウォール語
co	コルシカ語
crh	クリミアタタール語 (ラテン)
hr	Croatian
cs	チェコ語
da	デンマーク語
prs	Dari
dhi	ディマール語 (デーヴァナーガリー)
doi	ドーグリー語 (デーヴァナーガリー)
nl	オランダ語
en	英語
myv	エルジャ語 (キリル)
et	Estonian
fo	フェロー語
fj	フィジー語
fil	Filipino
fi	フィンランド語
fr	フランス語
fur	フルリアン
gag	ガガウズ語 (ラテン)
gl	ガリシア語
de	ドイツ語
gil	キリバス語
gon	ゴーンディー語 (デーヴァナーガリー)
el	ギリシャ語
kl	グリーンランド語
gvr	グルン語 (デーヴァナーガリー)
ht	ハイチ・クレオール語
hlb	ハルビ語 (デーヴァナーガリー)
hni	ハニ語
bgc	ハリヤーンウィー語
haw	ハワイ語
hi	Hindi
mww	ミャオ語 (ラテン)
hoc	ホー(デーヴァナギリ)
hu	Hungarian
is	Icelandic
smn	イナリサーミ語
id	Indonesian
ia	インターリングア
iu	イヌクティトット語 (ラテン)
ga	Irish
it	イタリア語
ja	日本語
Jns	ジャウンサーリー語 (デーヴァナーガリー)
jv	ジャワ語
kea	カーボベルデ・クレオール語
kac	カチン語 (ラテン)
xnr	カーングリー語 (デーヴァナーガリー)
krc	カラチャイバルカル語
kaa-cyrl	カラカルパク語 (キリル)
kaa	カラカルパク語 (ラテン)
csb	カシュビア語
kk-cyrl	カザフ語 (キリル)
kk-latn	カザフ語 (ラテン)
klr	カリン語
kha	カシ語
quc	キチェ語
ko	韓国語
kfq	コルク語
kpy	コリャーク語
kos	コスラエ語
kum	クムク語 (キリル)
ku-arab	クルド語 (アラビア文字)
ku-latn	クルド語 (ラテン文字)
kru	クルク語 (デーヴァナーガリー)
ky	キルギス語 (キリル語)
lkt	ラコタ語
la	ラテン語
lt	Lithuanian
dsb	低地ソルブ語
smj	ルレサーミ語
lb	Luxembourgish
bfz	マハスパハリー語 (デーヴァナーガリー)
ms	マレー語 (ラテン)
mt	Maltese
kmj	マルト語 (デーヴァナーガリー)
gv	マン語
mi	Maori
mr	Marathi
mn	モンゴル語 (キリル)
cnr-cyrl	モンテネグロ語 (キリル)
cnr-latn	モンテネグロ語 (ラテン)
nap	ナポリ語
ne	ネパール語
niu	ニウエ語
nog	ノガイ語
sme	北サーミ語 (ラテン)
nb	ノルウェー語
no	ノルウェー語
oc	オクシタン語
os	オセット語
ps	パシュトウ語
fa	Persian
pl	ポーランド語
pt	Portuguese
pa	パンジャーブ語 (アラビア)
ksh	リプアーリ語
ro	Romanian
rm	ロマンシュ語
ru	ロシア語
sck	サドリ語 (デーヴァナーガリー)
sm	サモア語 (ラテン)
sa	サンスクリット語(デーヴァナギリ)
sat	サンタリ(デーヴァナギリ)
sco	スコットランド語
gd	スコットランドゲール語
sr	セルビア語 (ラテン)
sr-Cyrl	セルビア語 (キリル)
sr-Latn	セルビア語 (ラテン)
xsr	シェルパ語 (デーヴァナーガリー)
srx	スルマウリ語 (デーヴァナーガリー)
sms	スコルトサーミ語
sk	Slovak
sl	Slovenian
so	ソマリ語 (アラビア語)
sma	南部サーミ語
es	スペイン語
sw	スワヒリ語 (ラテン)
sv	スウェーデン語
tg	タジク語 (キリル)
tt	タタール語 (ラテン)
tet	テトゥン語
thf	タンミ語
to	トンガ語
tr	トルコ語
tk	トルクメン語 (ラテン)
tyv	トゥヴァ語
hsb	高地ソルブ語
ur	Urdu
ug	ウイグル語 (アラビア語)
uz-arab	ウズベク語 (アラビア語)
uz-cyrl	ウズベク語 (キリル)
uz	ウズベク語 (ラテン)
vo	ヴォラピュク
wae	ヴァリス語
cy	Welsh
fy	西フリジア語
yua	ユカテコ語
za	チワン語
zu	ズールー語
unk	不明 (すべて)

OutputFieldMappingEntry

Object

スキルの出力フィールドマッピング。

名前	型	説明
name	string	スキルによって定義された出力の名前。
targetName	string	出力のターゲット名。これはオプションであり、デフォルトは名前です。

PIIDetectionSkill

Object

Text Analytics APIを使うことで、入力テキストから個人情報を抽出し、マスクするオプションも提供します。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.PIIDetectionSkill	派生型の識別子。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
defaultLanguageCode	string	使用する言語コードを示す値。既定値は `en` です。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
domain	string	指定した場合、エンティティカテゴリのサブセットのみを含むように PII ドメインが設定されます。指定できる値は、'phi'、'none' です。既定値は 'none' です。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
maskingCharacter	string maxLength: 1	maskMode パラメーターが置換するように設定されている場合にテキストをマスクするために使用される文字。既定値は '*' です。
maskingMode	PIIDetectionSkillMaskingMode	入力テキストで検出された個人情報をマスクするさまざまな方法を提供するパラメーター。既定値は 'none' です。
minimumPrecision	number (double) minimum: 0 maximum: 1	信頼度スコアが指定された値より大きいエンティティのみを含めるために使用される 0 ~ 1 の値。設定されていない場合 (既定値)、または明示的に null に設定されている場合は、すべてのエンティティが含まれます。
modelVersion	string	Text Analyticsサービスを呼び出す際に使うモデルのバージョン。指定されていない場合は、既定で使用可能な最新の値になります。絶対に必要な場合を除き、この値は指定しないことをお勧めします。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。
piiCategories	string[]	抽出およびマスクする必要がある PII エンティティカテゴリの一覧。

PIIDetectionSkillMaskingMode

列挙

入力テキストで検出された個人情報をマスクするために使用する maskingMode を示す文字列。

値	説明
none	マスキングは行われず、maskedText 出力は返されません。
replace	検出されたエンティティを、maskingCharacter パラメータで指定された文字に置き換えます。文字は検出されたエンティティの長さまで繰り返されるため、オフセットは入力テキストと出力 maskedText の両方に正しく対応します。

SearchIndexerDataNoneIdentity

Object

データソースの ID プロパティをクリアします。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	ID のタイプを指定する URI フラグメント。

SearchIndexerDataUserAssignedIdentity

Object

使用するデータソースの ID を指定します。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	ID のタイプを指定する URI フラグメント。
userAssignedIdentity	string	ユーザー割り当て管理IDの完全適格なAzureリソースIDは、通常「/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft」の形をとります。ManagedIdentity/userAssignedIdentities/myId」は検索サービスに割り当てられているはずです。

SearchIndexerIndexProjection

Object

セカンダリ検索インデックスへの追加プロジェクションの定義。

名前	型	説明
parameters	SearchIndexerIndexProjectionsParameters	インデックスプロジェクション固有の構成プロパティのディクショナリ。各名前は、特定のプロパティの名前です。各値はプリミティブ型である必要があります。
selectors	SearchIndexerIndexProjectionSelector[]	2 次検索インデックスに対して実行されるプロジェクションのリスト。

SearchIndexerIndexProjectionSelector

Object

指定された検索インデックスに格納するデータの説明。

名前	型	説明
mappings	InputFieldMappingEntry[]	プロジェクションのマッピング、またはターゲットインデックスのどのフィールドにどのソースをマップする必要があるか。
parentKeyFieldName	string	親ドキュメントのキー値をマップする検索インデックス内のフィールドの名前。キーフィールドではなく、フィルター処理可能な文字列フィールドである必要があります。
sourceContext	string	プロジェクションのソースコンテキスト。ドキュメントが複数のサブドキュメントに分割されるカーディナリティを表します。
targetIndexName	string	投影先の検索インデックスの名前。「キーワード」アナライザーが設定されたキーフィールドが必要です。

SearchIndexerIndexProjectionsParameters

Object

インデックスプロジェクション固有の構成プロパティのディクショナリ。各名前は、特定のプロパティの名前です。各値はプリミティブ型である必要があります。

名前	型	説明
projectionMode	IndexProjectionMode	インデクサーの残りの部分に対するインデックスプロジェクションの動作を定義します。

SearchIndexerKnowledgeStore

Object

エンリッチされたデータの Azure BLOB、テーブル、またはファイルへの追加プロジェクションの定義。

名前	型	説明
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	ナレッジストアの予測を書く際にAzure Storageに接続するために使われるユーザー割り当てのマネージドアイデンティティ。接続文字列が識別子(ResourceId)を示していて指定されていない場合は、システムが割り当てた管理IDが使用されます。インデクサーの更新時に、ID が指定されていない場合、値は変更されません。「none」に設定すると、このプロパティの値はクリアされます。
parameters	SearchIndexerKnowledgeStoreParameters	ナレッジストア固有の構成プロパティのディクショナリ。各名前は、特定のプロパティの名前です。各値はプリミティブ型である必要があります。
projections	SearchIndexerKnowledgeStoreProjection[]	インデックス作成中に実行する追加のプロジェクションのリスト。
storageConnectionString	string	ストレージアカウントの投影への接続文字列はそこに格納されます。

SearchIndexerKnowledgeStoreFileProjectionSelector

Object

Azure Filesにどのデータを保存するかの投影定義。

名前	型	説明
generatedKeyName	string	プロジェクションを格納する生成されたキーの名前。
inputs	InputFieldMappingEntry[]	複雑な投影のための入れ子入力。
referenceKeyName	string	異なる投影法への参照キーの名前。
source	string	プロジェクトへのソースデータ。
sourceContext	string	複雑な投影のソースコンテキスト。
storageContainer	string	プロジェクションを格納する BLOB コンテナー。

SearchIndexerKnowledgeStoreObjectProjectionSelector

Object

Azure Blobにどのデータを保存するかのプロジェクション定義。

名前	型	説明
generatedKeyName	string	プロジェクションを格納する生成されたキーの名前。
inputs	InputFieldMappingEntry[]	複雑な投影のための入れ子入力。
referenceKeyName	string	異なる投影法への参照キーの名前。
source	string	プロジェクトへのソースデータ。
sourceContext	string	複雑な投影のソースコンテキスト。
storageContainer	string	プロジェクションを格納する BLOB コンテナー。

SearchIndexerKnowledgeStoreParameters

Object

ナレッジストア固有の構成プロパティのディクショナリ。各名前は、特定のプロパティの名前です。各値はプリミティブ型である必要があります。

名前	型	規定値	説明
synthesizeGeneratedKeyName	boolean	False	生成されたキー名がまだ存在しない場合、プロジェクションが合成する必要があるかどうか。

SearchIndexerKnowledgeStoreProjection

Object

さまざまなプロジェクションセレクターのコンテナーオブジェクト。

名前	型	説明
files	SearchIndexerKnowledgeStoreFileProjectionSelector[]	Azureファイルストレージへの投影。
objects	SearchIndexerKnowledgeStoreObjectProjectionSelector[]	Projections to Azure Blob storage.
tables	SearchIndexerKnowledgeStoreTableProjectionSelector[]	Azure Table Storage への投影。

SearchIndexerKnowledgeStoreTableProjectionSelector

Object

Azure Tablesに保存するデータについての説明。

名前	型	説明
generatedKeyName	string	プロジェクションを格納する生成されたキーの名前。
inputs	InputFieldMappingEntry[]	複雑な投影のための入れ子入力。
referenceKeyName	string	異なる投影法への参照キーの名前。
source	string	プロジェクトへのソースデータ。
sourceContext	string	複雑な投影のソースコンテキスト。
tableName	string	投影データを保存するAzureテーブルの名前。

SearchIndexerSkillset

Object

スキルの一覧。

名前	型	説明
@odata.etag	string	スキルセットの ETag。
cognitiveServices	CognitiveServicesAccount: AIServicesAccountIdentity AIServicesAccountKey CognitiveServicesAccountKey DefaultCognitiveServicesAccount	スキルランディング時に使うためのAzure AIサービスの詳細。
description	string	スキルセットの説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vaultで作成する暗号化鍵の説明です。この鍵は、スキルセット定義に対して、Microsoftでさえも復号できない完全な保証を得たい場合に、スキルセット定義に対して追加の暗号化レベルを提供するために使用されます。スキルセット定義を暗号化すると、常に暗号化されたままになります。検索サービスは、このプロパティを null に設定しようとすると無視されます。暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。スキルセットの定義は影響を受けません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
indexProjections	SearchIndexerIndexProjection	セカンダリ検索インデックスへの追加プロジェクションの定義。
knowledgeStore	SearchIndexerKnowledgeStore	強化データのAzureブロブ、テーブル、またはファイルへの追加射影の定義。
name	string	スキルセットの名前。
skills	SearchIndexerSkill[]: AzureMachineLearningSkill[] AzureOpenAIEmbeddingSkill[] ChatCompletionSkill[] ConditionalSkill[] ContentUnderstandingSkill[] CustomEntityLookupSkill[] DocumentExtractionSkill[] DocumentIntelligenceLayoutSkill[] EntityLinkingSkill[] EntityRecognitionSkillV3[] ImageAnalysisSkill[] KeyPhraseExtractionSkill[] LanguageDetectionSkill[] MergeSkill[] OcrSkill[] PIIDetectionSkill[] SentimentSkillV3[] ShaperSkill[] SplitSkill[] TextTranslationSkill[] VisionVectorizeSkill[] WebApiSkill[]	スキルセット内のスキルの一覧。

SearchResourceEncryptionKey

Object

Azure Key Vault の顧客管理の暗号化キー。作成および管理するキーを使用して、インデックスやシノニムマップなどの保存データの暗号化または暗号化解除を行うことができます。

名前	型	説明
accessCredentials.applicationId	string	静止データを暗号化する際に使用する必要なAzure Key Vaultへのアクセス権限を付与されたAAD Application IDです。アプリケーション ID は、AAD アプリケーションのオブジェクト ID と混同しないでください。
accessCredentials.applicationSecret	string	指定した AAD アプリケーションの認証キー。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	この暗号化キーに使用する明示的なマネージド ID。指定されず、アクセス資格情報プロパティが null の場合は、システム割り当てマネージド ID が使用されます。リソースの更新時に、明示的な ID が指定されていない場合、変更されません。 "none" が指定されている場合、このプロパティの値はクリアされます。
keyVaultKeyName	string	静止データを暗号化するために使うあなたのAzure Key Vaultキーの名前です。
keyVaultKeyVersion	string	静止データを暗号化するために使用するAzure Key Vaultキーのバージョン。
keyVaultUri	string	Azure Key VaultのURI(DNS名とも呼ばれる)で、静止状態でデータを暗号化するために使う鍵が含まれています。 URI の例は、`https://my-keyvault-name.vault.azure.net`可能性があります。

SentimentSkillLanguage

列挙

SentimentSkill によって入力テキストでサポートされている言語コード。

値	説明
da	デンマーク語
nl	オランダ語
en	英語
fi	フィンランド語
fr	フランス語
de	ドイツ語
el	ギリシャ語
it	イタリア語
no	ノルウェー語(ボクマール)
pl	ポーランド語
pt-PT	ポルトガル語 (ポルトガル)
ru	ロシア語
es	スペイン語
sv	スウェーデン語
tr	トルコ語

SentimentSkillV3

Object

Text Analytics APIを用いて、非構造化テキストを評価し、各レコードに対して、サービスが文レベルおよび文書レベルで得た最高の信頼度スコアに基づいて「ネガティブ」「ニュートラル」「ポジティブ」などのセンチメントラベルを提供します。

名前	型	規定値	説明
@odata.type	string: #Microsoft.Skills.Text.V3.SentimentSkill		派生型の識別子。
context	string		ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
defaultLanguageCode	SentimentSkillLanguage		使用する言語コードを示す値。既定値は `en` です。
description	string		スキルの入力、出力、および使用方法を記述するスキルの説明。
includeOpinionMining	boolean	False	trueに設定すると、スキル出力には意見マイニングのためのText Analyticsの情報、すなわちテキスト内のターゲット(名詞または動詞)およびそれに関連する評価(形容詞)が含まれます。既定値は false です。
inputs	InputFieldMappingEntry[]		スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
modelVersion	string		Text Analyticsサービスを呼び出す際に使うモデルのバージョン。指定されていない場合は、既定で使用可能な最新の値になります。絶対に必要な場合を除き、この値は指定しないことをお勧めします。
name	string		スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]		スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

ShaperSkill

Object

出力を再整形するためのスキル。複合フィールド (マルチパートフィールドとも呼ばれます) をサポートする複合型が作成されます。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Util.ShaperSkill	派生型の識別子。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

SplitSkill

Object

文字列をテキストのチャンクに分割するスキル。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.SplitSkill	派生型の識別子。
azureOpenAITokenizerParameters	AzureOpenAITokenizerParameters	ユニットが azureOpenAITokens に設定されている場合にのみ適用されます。指定した場合、splitSkill はトークン化の実行時にこれらのパラメーターを使用します。パラメーターは有効な 'encoderModelName' と省略可能な 'allowedSpecialTokens' プロパティです。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
defaultLanguageCode	SplitSkillLanguage	使用する言語コードを示す値。既定値は `en` です。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
maximumPageLength	integer (int32)	必要な最大ページ長。既定値は 10000 です。
maximumPagesToTake	integer (int32)	textSplitMode が 'pages' に設定されている場合にのみ適用されます。指定した場合、SplitSkill は最初の 'maximumPagesToTake' ページの処理後に分割を中止し、各ドキュメントから必要な初期ページが少数の場合にのみパフォーマンスを向上させます。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。
pageOverlapLength	integer (int32)	textSplitMode が 'pages' に設定されている場合にのみ適用されます。指定した場合、n+ 1 番目のチャンクは、n 番目のチャンクの末尾からこの文字数/トークンで始まります。
textSplitMode	TextSplitMode	実行する分割モードを示す値。
unit	SplitSkillUnit	textSplitMode がページに設定されている場合にのみ適用されます。指定できる値は 2 つあります。値の選択によって、長さ (maximumPageLength と pageOverlapLength) の測定が決められます。既定値は 'characters' です。これは、長さが文字で測定されることを意味します。

SplitSkillEncoderModelName

列挙

どのトークナイザーを使うべきかを示す値です。

値	説明
r50k_base	50,000 トークンの語彙でトレーニングされた基本モデルを指し、一般的な自然言語処理タスクでよく使用されます。
p50k_base	プロンプトベースのタスク用に最適化された、50,000 トークンの語彙を持つ基本モデル。
p50k_edit	p50k_baseに似ていますが、50,000 トークンの語彙でタスクを編集または言い換えるために微調整されています。
cl100k_base	100,000 トークンの語彙を持つ基本モデル。

SplitSkillLanguage

列挙

SplitSkill による入力テキストでサポートされている言語コード。

値	説明
am	Amharic
bs	Bosnian
cs	チェコ語
da	デンマーク語
de	ドイツ語
en	英語
es	スペイン語
et	Estonian
fi	フィンランド語
fr	フランス語
he	Hebrew
hi	Hindi
hr	Croatian
hu	Hungarian
id	Indonesian
is	Icelandic
it	イタリア語
ja	日本語
ko	韓国語
lv	Latvian
nb	ノルウェー語
nl	オランダ語
pl	ポーランド語
pt	ポルトガル語 (ポルトガル)
pt-br	ポルトガル語 (ブラジル)
ru	ロシア語
sk	Slovak
sl	Slovenian
sr	セルビア語
sv	スウェーデン語
tr	トルコ語
ur	Urdu
zh	簡体中国語

SplitSkillUnit

列挙

使用する単位を示す値。

値	説明
characters	長さは文字ごとに測定されます。
azureOpenAITokens	長さは、tiktoken ライブラリの AzureOpenAI トークナイザーによって測定されます。

TextSplitMode

列挙

実行する分割モードを示す値。

値	説明
pages	テキストを個々のページに分割します。
sentences	テキストを個々の文に分割します。

TextTranslationSkill

Object

ある言語から別の言語にテキストを翻訳するスキル。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.TranslationSkill	派生型の識別子。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
defaultFromLanguageCode	TextTranslationSkillLanguage	from 言語を明示的に指定しないドキュメントに対してドキュメントを翻訳する言語コード。
defaultToLanguageCode	TextTranslationSkillLanguage	to 言語を明示的に指定しないドキュメントにドキュメントを翻訳する言語コード。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。
suggestedFrom	TextTranslationSkillLanguage	fromLanguageCode 入力と defaultFromLanguageCode パラメーターのどちらも指定されておらず、自動言語検出が失敗した場合にドキュメントを翻訳する言語コード。既定値は `en` です。

TextTranslationSkillLanguage

列挙

TextTranslationSkill による入力テキストでサポートされている言語コード。

値	説明
af	Afrikaans
ar	アラビア語
bn	バングラ
bs	ボスニア語 (ラテン)
bg	ブルガリア語
yue	広東語 (繁体字)
ca	カタロニア語
zh-Hans	簡体字中国語
zh-Hant	繁体中国語
hr	Croatian
cs	チェコ語
da	デンマーク語
nl	オランダ語
en	英語
et	Estonian
fj	フィジー語
fil	Filipino
fi	フィンランド語
fr	フランス語
de	ドイツ語
el	ギリシャ語
ht	ハイチ・クレオール語
he	Hebrew
hi	Hindi
mww	ミャオ語
hu	Hungarian
is	Icelandic
id	Indonesian
it	イタリア語
ja	日本語
sw	Kiswahili
tlh	クリンゴン語
tlh-Latn	クリンゴン語(ラテン文字)
tlh-Piqd	クリンゴン語(クリンゴン文字)
ko	韓国語
lv	Latvian
lt	Lithuanian
mg	マダガスカル語
ms	Malay
mt	Maltese
nb	ノルウェー語
fa	Persian
pl	ポーランド語
pt	Portuguese
pt-br	ポルトガル語 (ブラジル)
pt-PT	ポルトガル語 (ポルトガル)
otq	オトミ語
ro	Romanian
ru	ロシア語
sm	サモア語
sr-Cyrl	セルビア語 (キリル)
sr-Latn	セルビア語 (ラテン)
sk	Slovak
sl	Slovenian
es	スペイン語
sv	スウェーデン語
ty	タヒチ語
ta	Tamil
te	Telugu
th	タイ語
to	トンガ語
tr	トルコ語
uk	ウクライナ語
ur	Urdu
vi	ベトナム語
cy	Welsh
yua	ユカテコ語
ga	Irish
kn	Kannada
mi	Maori
ml	Malayalam
pa	Punjabi

VisionVectorizeSkill

Object

Azure AI ServicesのVision Vectorize APIを使って、画像やテキスト入力に対してベクター埋め込みを生成できます。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Vision.VectorizeSkill	派生型の識別子。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
modelVersion	string	AI Services Vision サービスを呼び出すときに使用するモデルのバージョン。指定されていない場合は、既定で使用可能な最新の値になります。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

VisualFeature

列挙

返すビジュアル機能の種類を示す文字列。

値	説明
adult	成人として認識される視覚的特徴。
brands	商業ブランドとして認識されているビジュアル機能。
categories	カテゴリ。
description	Description.
faces	人の顔として認識される視覚的特徴。
objects	オブジェクトとして認識される視覚的特徴。
tags	タグ。

WebApiSkill

Object

Web API エンドポイントを呼び出すことができるスキル。カスタムコードを呼び出すことでスキルセットを拡張できます。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Custom.WebApiSkill	派生型の識別子。
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	送信接続に使用されるユーザー割り当てマネージド ID。 authResourceId が指定されていて、指定されていない場合は、システム割り当てマネージド ID が使用されます。インデクサーの更新時に、ID が指定されていない場合、値は変更されません。「none」に設定すると、このプロパティの値はクリアされます。
authResourceId	string	Azure関数や変換を提供する他のアプリケーションで外部コードに接続するカスタムスキルに適用されます。この値は、Azure Active Directoryに登録された際に機能やアプリのために作成されたアプリケーションIDであるべきです。指定すると、カスタムスキルは、検索サービスのマネージド ID (システムまたはユーザー割り当て) と関数またはアプリのアクセストークンを使用して関数またはアプリに接続します。この値は、アクセストークンのスコープを作成するためのリソース ID として使用されます。
batchSize	integer (int32)	ドキュメントの数を示す目的のバッチサイズ。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
degreeOfParallelism	integer (int32)	設定されている場合、Web API に対して実行できる並列呼び出しの数。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
httpHeaders	object	http 要求を行うために必要なヘッダー。
httpMethod	string	http 要求のメソッド。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
name	string	スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。
timeout	string (duration)	要求に必要なタイムアウト。既定値は 30 秒です。
uri	string	Web API の URL。