Skillsets - Create

サービス:

Search Service

API バージョン:

2024-07-01

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

POST {endpoint}/skillsets?api-version=2024-07-01

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	検索サービスのエンドポイント URL。
api-version	query	True	string	クライアント API のバージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string (uuid)	デバッグに役立つ要求と共に送信される追跡 ID。

要求本文

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

応答

名前	型	説明
201 Created	SearchIndexerSkillset	スキルセットが正常に作成されました。
Other Status Codes	ErrorResponse	エラー応答。

例

SearchServiceCreateSkillset

要求のサンプル

HTTP

POST https://myservice.search.windows.net/skillsets?api-version=2024-07-01

{
  "name": "demoskillset",
  "description": "Extract entities, detect language and extract key-phrases",
  "skills": [
    {
      "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill",
      "categories": [
        "organization"
      ],
      "defaultLanguageCode": "en",
      "minimumPrecision": 0.7,
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "organizations",
          "targetName": "organizations"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "languageCode",
          "targetName": "languageCode"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.SplitSkill",
      "textSplitMode": "pages",
      "maximumPageLength": 4000,
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "textItems",
          "targetName": "pages"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
      "context": "/document/pages/*",
      "inputs": [
        {
          "name": "text",
          "source": "/document/pages/*"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "keyPhrases",
          "targetName": "keyPhrases"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
      "name": "MyCustomWebApiSkill",
      "uri": "https://contoso.example.org",
      "httpMethod": "POST",
      "timeout": "PT30S",
      "batchSize": 1,
      "inputs": [
        {
          "name": "text",
          "source": "/document/pages/*"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "customresult",
          "targetName": "result"
        }
      ],
      "httpHeaders": {}
    }
  ],
  "knowledgeStore": {
    "storageConnectionString": "DefaultEndpointsProtocol=https;AccountName=myStorage;AccountKey=myStorageKey;EndpointSuffix=core.windows.net",
    "projections": [
      {
        "tables": [
          {
            "tableName": "Reviews",
            "generatedKeyName": "ReviewId",
            "source": "/document/Review",
            "sourceContext": null,
            "inputs": []
          },
          {
            "tableName": "Sentences",
            "generatedKeyName": "SentenceId",
            "source": "/document/Review/Sentences/*",
            "sourceContext": null,
            "inputs": []
          },
          {
            "tableName": "KeyPhrases",
            "generatedKeyName": "KeyPhraseId",
            "source": "/document/Review/Sentences/*/KeyPhrases",
            "sourceContext": null,
            "inputs": []
          },
          {
            "tableName": "Entities",
            "generatedKeyName": "EntityId",
            "source": "/document/Review/Sentences/*/Entities/*",
            "sourceContext": null,
            "inputs": []
          }
        ]
      },
      {
        "objects": [
          {
            "storageContainer": "Reviews",
            "source": "/document/Review",
            "generatedKeyName": "/document/Review/Id"
          }
        ]
      }
    ]
  },
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

応答のサンプル

状態コード:

201

{
  "name": "demoskillset",
  "description": "Extract entities, detect language and extract key-phrases",
  "skills": [
    {
      "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill",
      "name": "#1",
      "description": null,
      "context": null,
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "organizations",
          "targetName": "organizations"
        }
      ],
      "categories": [
        "organization"
      ],
      "defaultLanguageCode": "en",
      "minimumPrecision": 0.7
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
      "name": "#2",
      "description": null,
      "context": null,
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "languageCode",
          "targetName": "languageCode"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.SplitSkill",
      "name": "#3",
      "description": null,
      "context": null,
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "textItems",
          "targetName": "pages"
        }
      ],
      "defaultLanguageCode": null,
      "textSplitMode": "pages",
      "maximumPageLength": 4000
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
      "name": "#4",
      "description": null,
      "context": "/document/pages/*",
      "inputs": [
        {
          "name": "text",
          "source": "/document/pages/*"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "keyPhrases",
          "targetName": "keyPhrases"
        }
      ],
      "defaultLanguageCode": null,
      "maxKeyPhraseCount": null
    },
    {
      "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
      "name": "MyCustomWebApiSkill",
      "description": null,
      "context": "/document",
      "uri": "https://contoso.example.org",
      "httpMethod": "POST",
      "timeout": "PT30S",
      "batchSize": 1,
      "degreeOfParallelism": null,
      "inputs": [
        {
          "name": "text",
          "source": "/document/pages/*"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "customresult",
          "targetName": "result"
        }
      ],
      "httpHeaders": {}
    }
  ],
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": null
    }
  }
}

定義

名前	説明
AzureActiveDirectoryApplicationCredentials	Azure Key Vault に格納されている暗号化キーへの認証済みアクセスに使用される、検索サービス用に作成された登録済みアプリケーションの資格情報。
AzureOpenAIEmbeddingSkill	Azure OpenAI リソースを使用して、特定のテキスト入力のベクター埋め込みを生成できます。
AzureOpenAIModelName	呼び出される Azure Open AI モデル名。
CognitiveServicesAccountKey	スキルセットにアタッチされている Azure AI サービス リソースのマルチリージョン アカウント キー。
ConditionalSkill	ブール演算を必要とするシナリオで、出力に割り当てるデータを決定できるようにするスキル。
CustomEntity	検出された一致と関連するメタデータに関する情報を含むオブジェクト。
CustomEntityAlias	ルート エンティティ名の代替のスペルまたはシノニムを指定するために使用できる複合オブジェクト。
CustomEntityLookupSkill	スキルは、ユーザー定義の単語と語句のカスタム リストからテキストを検索します。
CustomEntityLookupSkillLanguage	CustomEntityLookupSkill で入力テキストに対してサポートされている言語コード。
DefaultCognitiveServicesAccount	スキルセットの既定の Azure AI サービス リソースを表す空のオブジェクト。
DocumentExtractionSkill	エンリッチメント パイプライン内のファイルからコンテンツを抽出するスキル。
EntityCategory	返すエンティティ カテゴリを示す文字列。
EntityLinkingSkill	Text Analytics API を使用して、リンクされたエンティティをテキストから抽出します。
EntityRecognitionSkill	このスキルは非推奨です。 V3 を使用します。代わりに EntityRecognitionSkill。
EntityRecognitionSkillLanguage	廃止。 EntityRecognitionSkill で入力テキストに対してサポートされている言語コード。
EntityRecognitionSkillV3	Text Analytics API を使用して、テキストからさまざまな種類のエンティティを抽出します。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ImageAnalysisSkill	画像ファイルを分析するスキル。 画像の内容に基づいて、豊富なビジュアル機能のセットを抽出します。
ImageAnalysisSkillLanguage	ImageAnalysisSkill による入力でサポートされる言語コード。
ImageDetail	返すドメイン固有の詳細を示す文字列。
IndexProjectionMode	インデクサーの残りの部分に対するインデックス プロジェクションの動作を定義します。
InputFieldMappingEntry	スキルの入力フィールド マッピング。
KeyPhraseExtractionSkill	キー フレーズ抽出にテキスト分析を使用するスキル。
KeyPhraseExtractionSkillLanguage	KeyPhraseExtractionSkill で入力テキストに対してサポートされている言語コード。
LanguageDetectionSkill	入力テキストの言語を検出し、要求で送信されたすべてのドキュメントに対して 1 つの言語コードを報告するスキル。 言語コードは、分析の信頼度を示すスコアとペアになっています。
LineEnding	OCR スキルによって認識されるテキスト行間で使用する文字のシーケンスを定義します。 既定値は "space" です。
MergeSkill	2 つ以上の文字列を 1 つの統合文字列にマージするスキル。オプションのユーザー定義区切り記号で各コンポーネント部分を区切ります。
OcrSkill	画像ファイルからテキストを抽出するスキル。
OcrSkillLanguage	OcrSkill による入力でサポートされる言語コード。
OutputFieldMappingEntry	スキルの出力フィールド マッピング。
PIIDetectionSkill	Text Analytics API を使用して、入力テキストから個人情報を抽出し、それをマスクするオプションを提供します。
PIIDetectionSkillMaskingMode	入力テキストで検出された個人情報をマスクするために使用する maskMode を示す文字列。
SearchIndexerDataNoneIdentity	データソースの ID プロパティをクリアします。
SearchIndexerDataUserAssignedIdentity	使用するデータソースの ID を指定します。
SearchIndexerIndexProjections	セカンダリ検索インデックスへの追加プロジェクションの定義。
SearchIndexerIndexProjectionSelector	指定された検索インデックスに格納するデータの説明。
SearchIndexerIndexProjectionsParameters	インデックス プロジェクション固有の構成プロパティのディクショナリ。 各名前は、特定のプロパティの名前です。 各値はプリミティブ型である必要があります。
SearchIndexerKnowledgeStore	エンリッチされたデータの Azure BLOB、テーブル、またはファイルへの追加プロジェクションの定義。
SearchIndexerKnowledgeStoreFileProjectionSelector	Azure Files に格納するデータのプロジェクション定義。
SearchIndexerKnowledgeStoreObjectProjectionSelector	Azure BLOB に格納するデータのプロジェクション定義。
SearchIndexerKnowledgeStoreProjection	さまざまなプロジェクション セレクターのコンテナー オブジェクト。
SearchIndexerKnowledgeStoreTableProjectionSelector	Azure テーブルに格納するデータの説明。
SearchIndexerSkillset	スキルの一覧。
SearchResourceEncryptionKey	Azure Key Vault のカスタマー マネージド暗号化キー。 作成および管理するキーは、インデックスやシノニム マップなどの保存データの暗号化または暗号化解除に使用できます。
SentimentSkill	このスキルは非推奨です。 V3 を使用します。代わりに SentimentSkill。
SentimentSkillLanguage	廃止。 SentimentSkill で入力テキストに対してサポートされている言語コード。
SentimentSkillV3	Text Analytics API を使用して、非構造化テキストを評価し、各レコードに対して、文とドキュメント レベルでサービスによって検出された最高の信頼度スコアに基づいてセンチメント ラベル ("負"、"ニュートラル"、"肯定的"など) を提供します。
ShaperSkill	出力を再整形するためのスキル。 複合フィールド (マルチパート フィールドとも呼ばれます) をサポートする複合型が作成されます。
SplitSkill	文字列をテキストのチャンクに分割するスキル。
SplitSkillLanguage	SplitSkill で入力テキストに対してサポートされている言語コード。
TextSplitMode	実行する分割モードを示す値。
TextTranslationSkill	ある言語から別の言語にテキストを翻訳するスキル。
TextTranslationSkillLanguage	TextTranslationSkill による入力テキストでサポートされる言語コード。
VisualFeature	返すビジュアル機能の種類を示す文字列。
WebApiSkill	Web API エンドポイントを呼び出すことができるスキル。カスタム コードを呼び出すことでスキルセットを拡張できます。

AzureActiveDirectoryApplicationCredentials

Object

Azure Key Vault に格納されている暗号化キーへの認証済みアクセスに使用される、検索サービス用に作成された登録済みアプリケーションの資格情報。

名前	型	説明
applicationId	string	保存データの暗号化時に使用される Azure Key Vault に対する必要なアクセス許可が付与された AAD アプリケーション ID。 アプリケーション ID は、AAD アプリケーションのオブジェクト ID と混同しないでください。
applicationSecret	string	指定した AAD アプリケーションの認証キー。

AzureOpenAIEmbeddingSkill

Object

Azure OpenAI リソースを使用して、特定のテキスト入力のベクター埋め込みを生成できます。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	スキルの種類を指定する URI フラグメント。
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-3-large
text-embedding-3-small
text-embedding-ada-002

CognitiveServicesAccountKey

Object

スキルセットにアタッチされている Azure AI サービス リソースのマルチリージョン アカウント キー。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.CognitiveServicesByKey	スキルセットにアタッチされている Azure AI サービス リソースの種類を指定する URI フラグメント。
description	string	スキルセットにアタッチされている Azure AI サービス リソースの説明。
key	string	スキルセットにアタッチされている Azure AI サービス リソースのプロビジョニングに使用されるキー。

ConditionalSkill

Object

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

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

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	スキルの種類を指定する URI フラグメント。
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	スキルセットにアタッチされている Azure AI サービス リソースの種類を指定する URI フラグメント。
description	string	スキルセットにアタッチされている Azure AI サービス リソースの説明。

DocumentExtractionSkill

Object

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

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

EntityCategory

列挙

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

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

EntityLinkingSkill

Object

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

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.V3.EntityLinkingSkill	スキルの種類を指定する URI フラグメント。
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[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

EntityRecognitionSkill

Object

このスキルは非推奨です。 V3 を使用します。代わりに EntityRecognitionSkill。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.EntityRecognitionSkill	スキルの種類を指定する URI フラグメント。
categories	EntityCategory[]	抽出する必要があるエンティティ カテゴリの一覧。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。 既定値は /document です。
defaultLanguageCode	EntityRecognitionSkillLanguage	使用する言語コードを示す値。 既定値は enです。
description	string	スキルの入力、出力、および使用方法を記述するスキルの説明。
includeTypelessEntities	boolean	既知のエンティティが定義済みの型に準拠していないエンティティを含めるかどうかを決定します。 この構成が設定されていない場合 (既定値)、null に設定されている場合、または false に設定されている場合、定義済みの型のいずれかに準拠していないエンティティは表示されません。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソース データ セット内の列、またはアップストリーム スキルの出力を指定できます。
minimumPrecision	number (double)	信頼度スコアが指定された値より大きいエンティティのみを含めるために使用される 0 ~ 1 の値。 設定されていない場合 (既定値)、または明示的に null に設定されている場合は、すべてのエンティティが含まれます。
name	string	スキルセット内で一意に識別されるスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

EntityRecognitionSkillLanguage

列挙

廃止。 EntityRecognitionSkill で入力テキストに対してサポートされている言語コード。

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

EntityRecognitionSkillV3

Object

Text Analytics API を使用して、テキストからさまざまな種類のエンティティを抽出します。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.V3.EntityRecognitionSkill	スキルの種類を指定する URI フラグメント。
categories	string[]	抽出する必要があるエンティティ カテゴリの一覧。
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 API を呼び出すときに使用するモデルのバージョン。 指定されていない場合は、既定で使用可能な最新の値になります。 絶対に必要な場合を除き、この値は指定しないことをお勧めします。
name	string	スキルセット内で一意に識別されるスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

ImageAnalysisSkill

Object

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

名前	型	説明
@odata.type	string: #Microsoft.Skills.Vision.ImageAnalysisSkill	スキルの種類を指定する URI フラグメント。
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	エストニア語
eu	バスク語
fi	フィンランド語
fr	フランス語
ga	アイルランド語
gl	ガリシア語
he	ヘブライ語
hi	ヒンディー語
hr	クロアチア語
hu	ハンガリー語
id	インドネシア語
it	イタリア語
ja	日本語
kk	カザフ語
ko	韓国語
lt	リトアニア語
lv	ラトビア語
mk	マケドニアの
ms	マレー語 マレーシア
nb	ノルウェー語 (ブークマル)
nl	オランダ語
pl	ポーランド語
prs	ダリー語
pt	Portuguese-Portugal
pt-BR	Portuguese-Brazil
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

列挙

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

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

InputFieldMappingEntry

Object

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

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

KeyPhraseExtractionSkill

Object

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

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.KeyPhraseExtractionSkill	スキルの種類を指定する URI フラグメント。
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	デンマーク語
de	ドイツ語
en	英語
es	スペイン語
fi	フィンランド語
fr	フランス語
it	イタリア語
ja	日本語
ko	韓国語
nl	オランダ語
no	ノルウェー語 (ブークマル)
pl	ポーランド語
pt-BR	ポルトガル語 (ブラジル)
pt-PT	ポルトガル語 (ポルトガル)
ru	ロシア語
sv	スウェーデン語

LanguageDetectionSkill

Object

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

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

LineEnding

列挙

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

値	説明
carriageReturn	行は復帰 ('\r') 文字で区切られます。
carriageReturnLineFeed	行は復帰と改行 ('\r\n') 文字で区切られます。
lineFeed	行は、1 つの改行 ('\n') 文字で区切られます。
space	行は 1 つの空白文字で区切られます。

MergeSkill

Object

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

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

OcrSkill

Object

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

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

OcrSkillLanguage

列挙

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

値	説明
Jns	ジャウンサリ (デバナギリ)
af	アフリカーンス語
anp	Angika (Devanagiri)
ar	アラビア語
ast	アストゥリアス
awa	Awadhi-Hindi (デバナギリ)
az	アゼルバイジャン語 (ラテン)
be	ベラルーシ語 (キリル文字とラテン文字)
be-cyrl	ベラルーシ語 (キリル)
be-latn	ベラルーシ語 (ラテン)
bfy	Bagheli
bfz	マハース・パハリ (デバナギリ)
bg	ブルガリア語
bgc	Haryanvi
bho	Bhojpuri-Hindi (デバナギリ)
bi	ビスラマ
bns	Bundeli
br	ブルトン語
bra	Brajbha
brx	Bodo (Devanagiri)
bs	ボスニア語 (ラテン)
bua	Buryat (キリル)
ca	カタロニア語
ceb	セブアノ
ch	チャモロ
cnr-cyrl	モンテネグリン (キリル)
cnr-latn	モンテネグリン (ラテン)
co	コルシカ
crh	クリミアタタール語 (ラテン)
cs	チェコ語
csb	Kashubian
cy	ウェールズ語
da	デンマーク語
de	ドイツ語
dhi	Dhimal (Devanagiri)
doi	ドグリ (デバナギリ)
dsb	低ソルビアン
el	ギリシャ語
en	英語
es	スペイン語
et	エストニア語
eu	バスク語
fa	ペルシャ語
fi	フィンランド語
fil	フィリピノ語
fj	フィジー語
fo	フェロー語
fr	フランス語
fur	Frulian
fy	西フリジアン語
ga	アイルランド語
gag	ガガス語 (ラテン)
gd	スコットランド・ゲール語
gil	Gilbertese
gl	ガリシア語
gon	ゴンディ (デバナギリ)
gv	マンクス
gvr	Gurung (Devanagiri)
haw	ハワイ語
hi	ヒンディー語
hlb	Halbi (デバナギリ)
hne	チャットティサルギ (デバナギリ)
hni	Hani
hoc	Ho (Devanagiri)
hr	クロアチア語
hsb	上ソルビアン
ht	ハイチ語
hu	ハンガリー語
ia	インターリングア
id	インドネシア語
is	アイスランド語
it	イタリア語
iu	Inuktitut (ラテン)
ja	日本語
jv	ジャワ語
kaa	Kara-Kalpak (ラテン)
kaa-cyrl	Kara-Kalpak (キリル)
kac	Kachin (ラテン)
kea	Kabuverdianu
kfq	Korku
kha	Khasi
kk-cyrl	カザフ語 (キリル)
kk-latn	カザフ語 (ラテン)
kl	グリーンランド語
klr	Khaling
kmj	マルト (デバナギリ)
ko	韓国語
kos	コスレアーン
kpy	Koryak
krc	Karachay-Balkar
kru	Kurukh (Devanagiri)
ksh	Ripuarian
ku-arab	クルド語 (アラビア語)
ku-latn	クルド語 (ラテン)
kum	Kumyk (キリル)
kw	コーンウォール語
ky	Kyrgyz (キリル)
la	ラテン語
lb	ルクセンブルク語
lkt	ラコタ
lt	リトアニア語
mi	マオリ語
mn	モンゴル語 (キリル)
mr	マラーティー語
ms	マレー語 (ラテン)
mt	マルタ語
mww	モンドー語 (ラテン)
myv	Erzya (キリル)
nap	ナポリ語
nb	ノルウェー語
ne	ネパール語
niu	ニウエアン
nl	オランダ語
no	ノルウェー語
nog	Nogay
oc	Occitan
os	オセット語
pa	パンジャブ語 (アラビア語)
pl	ポーランド語
prs	ダリー語
ps	パシュトー語
pt	ポルトガル語
quc	K'iche'
rab	チャムリング
rm	ロマンシュ語
ro	ルーマニア語
ru	ロシア語
sa	サンスクリット語 (デバナギリ)
sat	サンタリ (デバナギリ)
sck	Sadri (Devanagiri)
sco	スコットランド語
sk	スロバキア語
sl	スロベニア語
sm	サモア語 (ラテン)
sma	南サーミ
sme	北サーミ語 (ラテン)
smj	Lule Sami
smn	いなりさみ
sms	Skolt Sami
so	ソマリア語 (アラビア語)
sq	アルバニア語
sr	セルビア語 (ラテン)
sr-Cyrl	セルビア語 (キリル)
sr-Latn	セルビア語 (ラテン)
srx	サーマウリ (デバナギリ)
sv	スウェーデン語
sw	Swahili (ラテン)
tet	Tetum
tg	タジク語 (キリル)
thf	Thangmi
tk	トルクメン語 (ラテン)
to	トンガ語
tr	トルコ語
tt	タタール語 (ラテン)
tyv	Tuvan
ug	ウイグル語 (アラビア語)
unk	不明 (すべて)
ur	ウルドゥ語
uz	ウズベク語 (ラテン)
uz-arab	ウズベク語 (アラビア語)
uz-cyrl	ウズベク語 (キリル)
vo	Volapük
wae	Walser
xnr	カングリ (デバナギリ)
xsr	Sherpa (Devanagiri)
yua	ユカテック マヤ
za	荘
zh-Hans	簡体字中国語
zh-Hant	繁体字中国語
zu	ズールー語

OutputFieldMappingEntry

Object

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

名前	型	説明
name	string	スキルによって定義された出力の名前。
targetName	string	出力のターゲット名。 これは省略可能であり、既定では名前になります。

PIIDetectionSkill

Object

Text Analytics API を使用して、入力テキストから個人情報を抽出し、それをマスクするオプションを提供します。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.PIIDetectionSkill	スキルの種類を指定する URI フラグメント。
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

列挙

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

値	説明
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" の形式です。

SearchIndexerIndexProjections

Object

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

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

SearchIndexerIndexProjectionSelector

Object

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

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

SearchIndexerIndexProjectionsParameters

Object

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

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

SearchIndexerKnowledgeStore

Object

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

名前	型	説明
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 File Storage へのプロジェクション。
objects	SearchIndexerKnowledgeStoreObjectProjectionSelector[]	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: CognitiveServicesAccountKey DefaultCognitiveServicesAccount	スキルの実行時に使用する Azure AI サービスの詳細。
description	string	スキルセットの説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。 このキーは、Microsoft 以外のユーザーがスキルセット定義の暗号化を解除できないという完全な保証が必要な場合に、スキルセット定義の保存時の暗号化レベルを追加するために使用されます。 スキルセット定義を暗号化すると、常に暗号化されたままになります。 検索サービスは、このプロパティを null に設定する試行を無視します。 暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。スキルセットの定義は影響を受けません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
indexProjections	SearchIndexerIndexProjections	セカンダリ検索インデックスへの追加プロジェクションの定義。
knowledgeStore	SearchIndexerKnowledgeStore	エンリッチされたデータの Azure BLOB、テーブル、またはファイルへの追加プロジェクションの定義。
name	string	スキルセットの名前。
skills	SearchIndexerSkill[]: AzureOpenAIEmbeddingSkill[] ConditionalSkill[] CustomEntityLookupSkill[] DocumentExtractionSkill[] EntityLinkingSkill[] EntityRecognitionSkill[] EntityRecognitionSkillV3[] ImageAnalysisSkill[] KeyPhraseExtractionSkill[] LanguageDetectionSkill[] MergeSkill[] OcrSkill[] PIIDetectionSkill[] SentimentSkill[] SentimentSkillV3[] ShaperSkill[] SplitSkill[] TextTranslationSkill[] WebApiSkill[]	スキルセット内のスキルの一覧。

SearchResourceEncryptionKey

Object

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

名前	型	説明
accessCredentials	AzureActiveDirectoryApplicationCredentials	Azure Key Vault へのアクセスに使用されるオプションの Azure Active Directory 資格情報。 代わりにマネージド ID を使用する場合は必要ありません。
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可能性があります。

SentimentSkill

Object

このスキルは非推奨です。 V3 を使用します。代わりに SentimentSkill。

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

SentimentSkillLanguage

列挙

廃止。 SentimentSkill で入力テキストに対してサポートされている言語コード。

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

SentimentSkillV3

Object

Text Analytics API を使用して、非構造化テキストを評価し、各レコードに対して、文とドキュメント レベルでサービスによって検出された最高の信頼度スコアに基づいてセンチメント ラベル ("負"、"ニュートラル"、"肯定的"など) を提供します。

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

SplitSkill

Object

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

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.SplitSkill	スキルの種類を指定する URI フラグメント。
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	ボスニア語
cs	チェコ語
da	デンマーク語
de	ドイツ語
en	英語
es	スペイン語
et	エストニア語
fi	フィンランド語
fr	フランス語
he	ヘブライ語
hi	ヒンディー語
hr	クロアチア語
hu	ハンガリー語
id	インドネシア語
is	アイスランド語
it	イタリア語
ja	日本語
ko	韓国語
lv	ラトビア語
nb	ノルウェー語
nl	オランダ語
pl	ポーランド語
pt	ポルトガル語 (ポルトガル)
pt-br	ポルトガル語 (ブラジル)
ru	ロシア語
sk	スロバキア語
sl	スロベニア語
sr	セルビア語
sv	スウェーデン語
tr	トルコ語
ur	ウルドゥ語
zh	中国語 (簡体字)

TextSplitMode

列挙

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

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

TextTranslationSkill

Object

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

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.TranslationSkill	スキルの種類を指定する URI フラグメント。
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	アラビア語
bg	ブルガリア語
bn	バングラ
bs	ボスニア語 (ラテン)
ca	カタロニア語
cs	チェコ語
cy	ウェールズ語
da	デンマーク語
de	ドイツ語
el	ギリシャ語
en	英語
es	スペイン語
et	エストニア語
fa	ペルシャ語
fi	フィンランド語
fil	フィリピノ語
fj	フィジー語
fr	フランス語
ga	アイルランド語
he	ヘブライ語
hi	ヒンディー語
hr	クロアチア語
ht	ハイチ語
hu	ハンガリー語
id	インドネシア語
is	アイスランド語
it	イタリア語
ja	日本語
kn	カナラ語
ko	韓国語
lt	リトアニア語
lv	ラトビア語
mg	マダガスカル語
mi	マオリ語
ml	マラヤラム語
ms	マレー語
mt	マルタ語
mww	モング・ドー
nb	ノルウェー語
nl	オランダ語
otq	ケレタロ大富
pa	パンジャブ語
pl	ポーランド語
pt	ポルトガル語
pt-PT	ポルトガル語 (ポルトガル)
pt-br	ポルトガル語 (ブラジル)
ro	ルーマニア語
ru	ロシア語
sk	スロバキア語
sl	スロベニア語
sm	サモア語
sr-Cyrl	セルビア語 (キリル)
sr-Latn	セルビア語 (ラテン)
sv	スウェーデン語
sw	スワヒリ語
ta	タミール語
te	テルグ語
th	タイ語
tlh	Klingon
tlh-Latn	Klingon (ラテン文字)
tlh-Piqd	Klingon (Klingon スクリプト)
to	トンガ語
tr	トルコ語
ty	タヒチ
uk	ウクライナ語
ur	ウルドゥ語
vi	ベトナム語
yua	ユカテック マヤ
yue	広東語 (繁体字)
zh-Hans	簡体字中国語
zh-Hant	繁体字中国語

VisualFeature

列挙

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

値	説明
adult	成人ユーザーとして認識されるビジュアル機能。
brands	商用ブランドとして認識されるビジュアル機能。
categories	カテゴリ。
description	形容。
faces	人の顔として認識されるビジュアル機能。
objects	オブジェクトとして認識されるビジュアル機能。
tags	タグ。

WebApiSkill

Object

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

名前	型	説明
@odata.type	string: #Microsoft.Skills.Custom.WebApiSkill	スキルの種類を指定する URI フラグメント。
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。