Skillsets - Create

サービス:: Search Service

API バージョン:: 2026-04-01

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

POST {endpoint}/skillsets?api-version=2026-04-01

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[]: AzureOpenAIEmbeddingSkill[] ChatCompletionSkill[] ConditionalSkill[] ContentUnderstandingSkill[] CustomEntityLookupSkill[] DocumentExtractionSkill[] DocumentIntelligenceLayoutSkill[] EntityLinkingSkill[] EntityRecognitionSkillV3[] ImageAnalysisSkill[] KeyPhraseExtractionSkill[] LanguageDetectionSkill[] MergeSkill[] OcrSkill[] PIIDetectionSkill[] SentimentSkillV3[] ShaperSkill[] SplitSkill[] TextTranslationSkill[] 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://stableexampleservice.search.windows.net/skillsets?api-version=2026-04-01


{
  "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,
      "@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"
        }
      ]
    }
  ],
  "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,
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "textItems",
          "targetName": "pages"
        }
      ]
    },
    {
      "@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
      }
    }
  ],
  "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サービスリソースのアカウントキーで、そのリソースのサブドメインで使われます。
AzureOpenAIEmbeddingSkill	Azure OpenAI リソースを使用して、特定のテキスト入力のベクター埋め込みを生成できます。
AzureOpenAIModelName	呼び出される Azure Open AI モデル名。
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 に格納するデータのプロジェクション定義。
SearchIndexerKnowledgeStoreProjection	さまざまなプロジェクションセレクターのコンテナーオブジェクト。
SearchIndexerKnowledgeStoreTableProjectionSelector	Azure テーブルに格納するデータの説明。
SearchIndexerSkillset	スキルの一覧。
SearchResourceEncryptionKey	Azure Key Vault のカスタマーマネージド暗号化キー。作成および管理するキーを使用して、インデックスやシノニムマップなどの保存データの暗号化または暗号化解除を行うことができます。
SentimentSkillLanguage	SentimentSkill によって入力テキストでサポートされている言語コード。
SentimentSkillV3	Text Analytics API を使用して、非構造化テキストを評価し、各レコードに対して、文とドキュメントレベルでサービスによって検出された最高の信頼度スコアに基づいてセンチメントラベル ("負"、"ニュートラル"、"肯定的"など) を提供します。
ShaperSkill	出力を再整形するためのスキル。複合フィールド (マルチパートフィールドとも呼ばれます) をサポートする複合型が作成されます。
SplitSkill	文字列をテキストのチャンクに分割するスキル。
SplitSkillLanguage	SplitSkill による入力テキストでサポートされている言語コード。
TextSplitMode	実行する分割モードを示す値。
TextTranslationSkill	ある言語から別の言語にテキストを翻訳するスキル。
TextTranslationSkillLanguage	TextTranslationSkill による入力テキストでサポートされている言語コード。
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。

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-5-mini	GPT5Miniモデル。
gpt-5-nano	Gpt5Nanoモデルです。
gpt-5.4-mini	GPT54Miniモデル。
gpt-5.4-nano	Gpt54Nanoモデル。

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」に設定すると、このプロパティの値はクリアされます。
commonModelParameters	ChatCompletionCommonModelParameters		顧客が微調整できる共通の言語モデルパラメーター。省略すると、合理的なデフォルトが適用されます。
context	string		ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。既定値は /document です。
description	string		スキルの入力、出力、および使用方法を記述するスキルの説明。
extraParameters			チャット完了呼び出しに追加する必要があるモデル固有のパラメーターのオープン型ディクショナリ。 Azure AI Foundryの拡張性パターンに従っています。
extraParametersBehavior	ChatCompletionExtraParametersBehavior	error	Azure AI Foundryがどのように追加パラメータを扱うのか。デフォルトは「error」です。
inputs	InputFieldMappingEntry[]		スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
name	string		スキルセット内で一意に識別されるスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]		スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。
responseFormat	ChatCompletionResponseFormat		LLM が応答をどのようにフォーマットするかを決定します。デフォルトは「テキスト」応答タイプです。
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	ポルトガル語

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	ハンガリー語
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	ウェールズ語
da	デンマーク語
de	ドイツ語
el	ギリシャ語
en	英語
es	スペイン語
et	Estonian
eu	バスク語
fi	フィンランド語
fr	フランス語
ga	アイルランド語
gl	ガリシア語
he	Hebrew
hi	ヒンディー語
hr	Croatian
hu	ハンガリー語
id	インドネシア語
it	イタリア語
ja	日本語
kk	Kazakh
ko	韓国語
lt	リトアニア語
lv	Latvian
mk	Macedonian
ms	マレー語マレーシア
nb	ノルウェー語 (ブークモール)
nl	オランダ語
pl	ポーランド語
prs	Dari
pt-BR	Portuguese-Brazil
pt	Portuguese-Portugal
pt-PT	Portuguese-Portugal
ro	ルーマニア語
ru	ロシア語
sk	スロバキア語
sl	スロベニア語
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	アフリカーンス語
sq	Albanian
anp	アンギカ語 (デーヴァナーガリー)
ar	アラビア語
ast	アストゥリアス
awa	Awadhi-Hindi (デバナギリ)
az	アゼルバイジャン語 (ラテン)
bfy	Bagheli
eu	バスク語
be	ベラルーシ語 (キリル文字とラテン文字)
be-cyrl	ベラルーシ語 (キリル)
be-latn	ベラルーシ語 (ラテン)
bho	Bhojpuri-Hindi (デバナギリ)
bi	ビスラマ
brx	ボド語 (デーヴァナーガリー)
bs	ボスニア語 (ラテン)
bra	Brajbha
br	ブルターニュ
bg	ブルガリア語
bns	Bundeli
bua	ブリヤート語（キリル文字）
ca	カタルニア語
ceb	Cebuano
rab	チャムリング
ch	チャモロ
hne	チャットティサルギ (デバナギリ)
zh-Hans	中国語簡体字
zh-Hant	繁体中国語
kw	コーニッシュ
co	コルシカ
crh	クリミアタタール語 (ラテン)
hr	Croatian
cs	チェコ語
da	デンマーク語
prs	Dari
dhi	ディマール語 (デーヴァナーガリー)
doi	ドグリ (デバナギリ)
nl	オランダ語
en	英語
myv	Erzya (キリル文字)
et	Estonian
fo	フェロー語
fj	フィジー
fil	フィリピン語
fi	フィンランド語
fr	フランス語
fur	Frulian
gag	ガガス語 (ラテン)
gl	ガリシア語
de	ドイツ語
gil	ギルバート語
gon	ゴンディ (デバナギリ)
el	ギリシャ語
kl	グリーンランド
gvr	グルン語 (デーヴァナーガリー)
ht	ハイチ・クレオール
hlb	Halbi (デバナギリ)
hni	ハニ
bgc	Haryanvi
haw	ハワイアン
hi	ヒンディー語
mww	フモン・ダウ語 (ラテン)
hoc	ホー(デーヴァナギリ)
hu	ハンガリー語
is	アイスランド語
smn	いなりさみ
id	インドネシア語
ia	インターリングア
iu	Inuktitut (ラテン文字)
ga	アイルランド語
it	イタリア語
ja	日本語
Jns	ジャウンサリ (デバナギリ)
jv	ジャワ語
kea	カブベルディアヌ
kac	Kachin (ラテン)
xnr	カングリ (デバナギリ)
krc	Karachay-Balkar
kaa-cyrl	Kara-Kalpak (キリル)
kaa	Kara-Kalpak (ラテン)
csb	Kashubian
kk-cyrl	カザフ語 (キリル)
kk-latn	カザフ語 (ラテン)
klr	Khaling
kha	Khasi
quc	キチェ語
ko	韓国語
kfq	恐怖
kpy	Koryak
kos	コスレアーン
kum	Kumyk (キリル文字)
ku-arab	クルド語 (アラビア語)
ku-latn	クルド語 (ラテン)
kru	クルク語 (デーヴァナーガリー)
ky	Kyrgyz（キリル文字）
lkt	ラコタ
la	ラテン語
lt	リトアニア語
dsb	低ソルビアン
smj	Lule Sami
lb	Luxembourgish
bfz	マハース・パハリ (デバナギリ)
ms	マレー語 (ラテン)
mt	マルタ語
kmj	マルト (デバナギリ)
gv	マンクス
mi	マオリ語
mr	マラーティー語
mn	モンゴル語 (キリル)
cnr-cyrl	モンテネグリン (キリル)
cnr-latn	モンテネグリン (ラテン)
nap	ナポリ
ne	ネパール
niu	ニウエアン
nog	Nogay
sme	北サーミ語 (ラテン)
nb	ノルウェー語
no	ノルウェー語
oc	オック語
os	オセット語
ps	パシュトー
fa	Persian
pl	ポーランド語
pt	ポルトガル語
pa	パンジャブ語 (アラビア語)
ksh	リプアーリ語 (Ripuarian)
ro	ルーマニア語
rm	ロマンシュ
ru	ロシア語
sck	サドリ語 (デーヴァナーガリー)
sm	サモア語 (ラテン)
sa	サンスクリット語 (デバナギリ)
sat	サンタリ (デバナギリ)
sco	スコットランド
gd	スコットランド・ゲール語
sr	セルビア語 (ラテン)
sr-Cyrl	セルビア語 (キリル)
sr-Latn	セルビア語 (ラテン)
xsr	シェルパ語 (デーヴァナーガリー)
srx	サーマウリ (デバナギリ)
sms	Skolt Sami
sk	スロバキア語
sl	スロベニア語
so	ソマリア語 (アラビア語)
sma	南サーミ
es	スペイン語
sw	Swahili (ラテン)
sv	スウェーデン語
tg	タジク語 (キリル)
tt	タタール語 (ラテン)
tet	Tetum
thf	Thangmi
to	トンガ
tr	トルコ語
tk	トルクメン語 (ラテン)
tyv	Tuvan
hsb	上ソルビアン
ur	Urdu
ug	ウイグル語 (アラビア語)
uz-arab	ウズベク語 (アラビア語)
uz-cyrl	ウズベク語 (キリル)
uz	ウズベク語 (ラテン)
vo	Volapük
wae	Walser
cy	ウェールズ語
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-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」に設定すると、このプロパティの値はクリアされます。
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 コンテナー。

SearchIndexerKnowledgeStoreProjection

Object

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

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

SearchIndexerKnowledgeStoreTableProjectionSelector

Object

Azure テーブルに格納するデータの説明。

名前	型	説明
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[]: AzureOpenAIEmbeddingSkill[] ChatCompletionSkill[] ConditionalSkill[] ContentUnderstandingSkill[] CustomEntityLookupSkill[] DocumentExtractionSkill[] DocumentIntelligenceLayoutSkill[] EntityLinkingSkill[] EntityRecognitionSkillV3[] ImageAnalysisSkill[] KeyPhraseExtractionSkill[] LanguageDetectionSkill[] MergeSkill[] OcrSkill[] PIIDetectionSkill[] SentimentSkillV3[] ShaperSkill[] SplitSkill[] TextTranslationSkill[] WebApiSkill[]	スキルセット内のスキルの一覧。

SearchResourceEncryptionKey

Object

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

名前	型	説明
accessCredentials.applicationId	string	保存データの暗号化時に使用される Azure Key Vault に対する必要なアクセス許可が付与された AAD アプリケーション 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	派生型の識別子。
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	実行する分割モードを示す値。

SplitSkillLanguage

列挙

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

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

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	アフリカーンス語
ar	アラビア語
bn	ベンガル語
bs	ボスニア語 (ラテン)
bg	ブルガリア語
yue	広東語 (繁体字)
ca	カタルニア語
zh-Hans	中国語簡体字
zh-Hant	繁体中国語
hr	Croatian
cs	チェコ語
da	デンマーク語
nl	オランダ語
en	英語
et	Estonian
fj	フィジー
fil	フィリピン語
fi	フィンランド語
fr	フランス語
de	ドイツ語
el	ギリシャ語
ht	ハイチ・クレオール
he	Hebrew
hi	ヒンディー語
mww	モング・ドー
hu	ハンガリー語
is	アイスランド語
id	インドネシア語
it	イタリア語
ja	日本語
sw	スワヒリ語
tlh	クリンゴン
tlh-Latn	Klingon (ラテン文字)
tlh-Piqd	Klingon (Klingon スクリプト)
ko	韓国語
lv	Latvian
lt	リトアニア語
mg	マダガスカル
ms	Malay
mt	マルタ語
nb	ノルウェー語
fa	Persian
pl	ポーランド語
pt	ポルトガル語
pt-br	ポルトガル語 (ブラジル)
pt-PT	ポルトガル語 (ポルトガル)
otq	ケレタロ・オトミ
ro	ルーマニア語
ru	ロシア語
sm	サモア
sr-Cyrl	セルビア語 (キリル)
sr-Latn	セルビア語 (ラテン)
sk	スロバキア語
sl	スロベニア語
es	スペイン語
sv	スウェーデン語
ty	タヒチ
ta	Tamil
te	Telugu
th	タイ語
to	トンガ
tr	トルコ語
uk	ウクライナ語
ur	Urdu
vi	ベトナム語
cy	ウェールズ語
yua	ユカテックマヤ
ga	アイルランド語
kn	カンナダ語
mi	マオリ語
ml	Malayalam
pa	パンジャブ語

VisualFeature

列挙

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

値	説明
adult	成人ユーザーとして認識されるビジュアル機能。
brands	商用ブランドとして認識されるビジュアル機能。
categories	カテゴリ。
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。