Skillsets - Get

リファレンス

サービス:: Search Service

API バージョン:: 2024-03-01-Preview

検索サービスのスキルセットを取得します。

GET {endpoint}/skillsets('{skillsetName}')?api-version=2024-03-01-Preview

URI パラメーター

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

要求ヘッダー

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

応答

名前	型	説明
200 OK	SearchIndexerSkillset	スキルセットが正常に返されます。
Other Status Codes	ErrorResponse	エラー応答。

例

SearchServiceGetSkillset

要求のサンプル

HTTP

GET https://myservice.search.windows.net/skillsets('demoskillset')?api-version=2024-03-01-Preview

応答のサンプル

状態コード:: 200

{
  "name": "demoskillset",
  "description": "Extract entities, detect language and extract key-phrases",
  "skills": [
    {
      "@odata.type": "#Microsoft.Skills.Text.V3.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": "myKeyName",
    "keyVaultKeyVersion": "myKeyVersion",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": null
    }
  }
}

定義

名前	説明
AmlSkill	AML スキルを使用すると、カスタム Azure Machine Learning (AML) モデルを使用して AI エンリッチメントを拡張できます。 AML モデルがトレーニングされてデプロイされると、AML スキルによって AI エンリッチメントに統合されます。
AzureActiveDirectoryApplicationCredentials	Azure Key Vaultに格納されている暗号化キーへの認証済みアクセスに使用される、検索サービス用に作成された登録済みアプリケーションの資格情報。
AzureOpenAIEmbeddingSkill	Azure OpenAI リソースを使用して、特定のテキスト入力のベクター埋め込みを生成できます。
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	入力テキストで検出された個人情報をマスクするために使用する maskingMode を示す文字列。
SearchIndexerDataNoneIdentity	データソースの ID プロパティをクリアします。
SearchIndexerDataUserAssignedIdentity	使用するデータソースの ID を指定します。
SearchIndexerIndexProjections	セカンダリ検索インデックスへの追加プロジェクションの定義。
SearchIndexerIndexProjectionSelector	指定された検索インデックスに格納するデータの説明。
SearchIndexerIndexProjectionsParameters	インデックスプロジェクション固有の構成プロパティのディクショナリ。各名前は、特定のプロパティの名前です。各値はプリミティブ型である必要があります。
SearchIndexerKnowledgeStore	エンリッチされたデータの Azure BLOB、テーブル、またはファイルへの追加のプロジェクションの定義。
SearchIndexerKnowledgeStoreFileProjectionSelector	Azure Filesに格納するデータのプロジェクション定義。
SearchIndexerKnowledgeStoreObjectProjectionSelector	Azure BLOB に格納するデータのプロジェクション定義。
SearchIndexerKnowledgeStoreParameters	ナレッジストア固有の構成プロパティのディクショナリ。各名前は、特定のプロパティの名前です。各値はプリミティブ型である必要があります。
SearchIndexerKnowledgeStoreProjection	さまざまなプロジェクションセレクターのコンテナーオブジェクト。
SearchIndexerKnowledgeStoreTableProjectionSelector	Azure テーブルに格納するデータの説明。
SearchIndexerSkillset	スキルの一覧。
SearchResourceEncryptionKey	Azure Key Vaultのカスタマーマネージド暗号化キー。作成および管理するキーは、インデックスやシノニムマップなどの保存データの暗号化または暗号化解除に使用できます。
SentimentSkill	このスキルは非推奨です。 V3 を使用します。代わりに SentimentSkill。
SentimentSkillLanguage	非推奨になりました。 SentimentSkill による入力テキストでサポートされる言語コード。
SentimentSkillV3	Text Analytics API を使用して、非構造化テキストを評価し、各レコードに対して、文とドキュメントレベルでサービスによって見つかった最高の信頼度スコアに基づいてセンチメントラベル ("negative"、"neutral"、"positive" など) を提供します。
ShaperSkill	出力を再作成するためのスキル。複合フィールド (マルチパートフィールドとも呼ばれます) をサポートする複合型を作成します。
SplitSkill	文字列をテキストのチャンクに分割するスキル。
SplitSkillLanguage	SplitSkill で入力テキストに対してサポートされている言語コード。
TextSplitMode	実行する分割モードを示す値。
TextTranslationSkill	ある言語から別の言語にテキストを翻訳するスキル。
TextTranslationSkillLanguage	TextTranslationSkill で入力テキストに対してサポートされている言語コード。
VisualFeature	返すビジュアル機能の種類を示す文字列。
WebApiSkill	Web API エンドポイントを呼び出すことができるスキル。カスタムコードを呼び出すことでスキルセットを拡張できます。

AmlSkill

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

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

AzureActiveDirectoryApplicationCredentials

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

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

AzureOpenAIEmbeddingSkill

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	スキルの入力、出力、使用状況を記述するスキルの説明。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
name	string	スキルセット内で一意に識別するスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付き、先頭に文字 '#' が付けられます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールド、または別のスキルによる入力として使用できる値のいずれかです。
resourceUri	string	Azure OpenAI リソースのリソース URI。

CognitiveServicesAccountKey

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

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

ConditionalSkill

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

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

CustomEntity

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

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

CustomEntityAlias

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

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

CustomEntityLookupSkill

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

名前	型	説明
@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 のグローバルフラグ。 CaseSensitive が CustomEntity で設定されていない場合、この値は既定値になります。
globalDefaultFuzzyEditDistance	integer	FuzzyEditDistance のグローバルフラグ。 FuzzyEditDistance が CustomEntity で設定されていない場合、この値は既定値になります。
inlineEntitiesDefinition	CustomEntity[]	インライン CustomEntity 定義。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
name	string	スキルセット内で一意に識別するスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付き、先頭に文字 '#' が付けられます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールド、または別のスキルによる入力として使用できる値のいずれかです。

CustomEntityLookupSkillLanguage

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

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

DefaultCognitiveServicesAccount

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

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

DocumentExtractionSkill

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

名前	型	説明
@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	string	日付と時刻を記述するエンティティ。
email	string	電子メールアドレスを記述するエンティティ。
location	string	物理的な場所を記述するエンティティ。
organization	string	organizationを記述するエンティティ。
person	string	人物を記述するエンティティ。
quantity	string	数量を記述するエンティティ。
url	string	URL を記述するエンティティ。

EntityLinkingSkill

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	信頼度スコアが指定された値より大きいエンティティのみを含めるために使用される 0 ~ 1 の値。設定されていない場合 (既定値)、または明示的に null に設定されている場合は、すべてのエンティティが含まれます。
modelVersion	string	Text Analytics サービスを呼び出すときに使用するモデルのバージョン。指定しない場合、既定では利用可能な最新のものになります。絶対に必要な場合以外は、この値を指定しないことをお勧めします。
name	string	スキルセット内で一意に識別するスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付き、先頭に文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールド、または別のスキルによる入力として使用できる値のいずれかです。

EntityRecognitionSkill

このスキルは非推奨です。 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	信頼度スコアが指定された値より大きいエンティティのみを含めるために使用される 0 ~ 1 の値。設定されていない場合 (既定値)、または明示的に null に設定されている場合は、すべてのエンティティが含まれます。
name	string	スキルセット内で一意に識別するスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付き、先頭に文字 '#' が付きます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックスのフィールドか、別のスキルによる入力として使用できる値です。

EntityRecognitionSkillLanguage

非推奨になりました。 EntityRecognitionSkill で入力テキストに対してサポートされている言語コード。

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

EntityRecognitionSkillV3

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	信頼度スコアが指定された値より大きいエンティティのみを含めるために使用される 0 ~ 1 の値。設定されていない場合 (既定値)、または明示的に null に設定されている場合は、すべてのエンティティが含まれます。
modelVersion	string	Text Analytics API を呼び出すときに使用するモデルのバージョン。指定しない場合、既定では利用可能な最新のものになります。絶対に必要な場合以外は、この値を指定しないことをお勧めします。
name	string	スキルセット内で一意に識別するスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付き、先頭に文字 '#' が付けられます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールド、または別のスキルによる入力として使用できる値のいずれかです。

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

ImageAnalysisSkill

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

名前	型	説明
@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	string	アラビア語
az	string	アゼルバイジャン語
bg	string	ブルガリア語
bs	string	ボスニア語 (ラテン)
ca	string	カタロニア語
cs	string	チェコ語
cy	string	ウェールズ語
da	string	デンマーク語
de	string	ドイツ語
el	string	ギリシャ語
en	string	英語
es	string	スペイン語
et	string	エストニア語
eu	string	バスク語
fi	string	フィンランド語
fr	string	フランス語
ga	string	アイルランド語
gl	string	ガリシア語
he	string	ヘブライ語
hi	string	ヒンディー語
hr	string	クロアチア語
hu	string	ハンガリー語
id	string	インドネシア語
it	string	イタリア語
ja	string	日本語
kk	string	カザフ語
ko	string	韓国語
lt	string	リトアニア語
lv	string	ラトビア語
mk	string	マケドニア語
ms	string	マレー語 (マレーシア)
nb	string	ノルウェー語 (ブークモール)
nl	string	オランダ語
pl	string	ポーランド語
prs	string	ダリー語
pt	string	ポルトガル語 (ポルトガル)
pt-BR	string	ポルトガル語 (ブラジル)
pt-PT	string	ポルトガル語 (ポルトガル)
ro	string	ルーマニア語
ru	string	ロシア語
sk	string	スロバキア語
sl	string	スロベニア語
sr-Cyrl	string	セルビア語 - キリル文字 RS
sr-Latn	string	セルビア語 - ラテン RS
sv	string	スウェーデン語
th	string	タイ語
tr	string	トルコ語
uk	string	ウクライナ語
vi	string	ベトナム語
zh	string	簡体中国語
zh-Hans	string	簡体中国語
zh-Hant	string	中国語 (繁体字)

ImageDetail

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

名前	型	説明
celebrities	string	有名人として認識される詳細。
landmarks	string	ランドマークとして認識される詳細。

IndexProjectionMode

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

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

InputFieldMappingEntry

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

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

KeyPhraseExtractionSkill

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

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

KeyPhraseExtractionSkillLanguage

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

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

LanguageDetectionSkill

入力テキストの言語を検出し、要求で送信されたすべてのドキュメントに対して 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	string	行は復帰 ('\r') 文字で区切られます。
carriageReturnLineFeed	string	行はキャリッジリターンと改行 ('\r\n') 文字で区切られます。
lineFeed	string	行は、1 つの改行 ('\n') 文字で区切られます。
space	string	行は 1 つの空白文字で区切られます。

MergeSkill

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

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

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

OutputFieldMappingEntry

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

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

PIIDetectionSkill

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	maskMode パラメーターが置換に設定されている場合にテキストをマスクするために使用される文字。既定値は '*' です。
maskingMode	PIIDetectionSkillMaskingMode	入力テキスト内で検出された個人情報をマスクするためのさまざまな方法を提供するパラメーター。既定値は 'none' です。
minimumPrecision	number	信頼度スコアが指定された値より大きいエンティティのみを含めるために使用される 0 ~ 1 の値。設定されていない場合 (既定値)、または明示的に null に設定されている場合は、すべてのエンティティが含まれます。
modelVersion	string	Text Analytics サービスを呼び出すときに使用するモデルのバージョン。指定しない場合、既定では利用可能な最新のものになります。絶対に必要な場合以外は、この値を指定しないことをお勧めします。
name	string	スキルセット内で一意に識別するスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付き、先頭に文字 '#' が付けられます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールド、または別のスキルによる入力として使用できる値のいずれかです。
piiCategories	string[]	抽出してマスクする必要がある PII エンティティカテゴリの一覧。

PIIDetectionSkillMaskingMode

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

名前	型	説明
none	string	マスクは発生せず、maskedText 出力は返されません。
replace	string	検出されたエンティティを、maskingCharacter パラメーターで指定された文字に置き換えます。文字は、入力テキストと出力 maskedText の両方に正しく対応するように、検出されたエンティティの長さに繰り返されます。

SearchIndexerDataNoneIdentity

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

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

SearchIndexerDataUserAssignedIdentity

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

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	ID の種類を指定する URI フラグメント。
userAssignedIdentity	string	通常、ユーザー割り当てマネージド ID の完全修飾 Azure リソース ID は、検索サービスに割り当てられている必要がある "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" という形式です。

SearchIndexerIndexProjections

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

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

SearchIndexerIndexProjectionSelector

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

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

SearchIndexerIndexProjectionsParameters

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

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

SearchIndexerKnowledgeStore

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

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

SearchIndexerKnowledgeStoreFileProjectionSelector

Azure Filesに格納するデータのプロジェクション定義。

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

SearchIndexerKnowledgeStoreObjectProjectionSelector

Azure BLOB に格納するデータのプロジェクション定義。

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

SearchIndexerKnowledgeStoreParameters

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

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

SearchIndexerKnowledgeStoreProjection

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

名前	型	説明
files	SearchIndexerKnowledgeStoreFileProjectionSelector[]	Azure File Storage へのプロジェクション。
objects	SearchIndexerKnowledgeStoreObjectProjectionSelector[]	Azure Blob Storage へのプロジェクション。
tables	SearchIndexerKnowledgeStoreTableProjectionSelector[]	Azure Table Storage へのプロジェクション。

SearchIndexerKnowledgeStoreTableProjectionSelector

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

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

SearchIndexerSkillset

スキルの一覧。

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

SearchResourceEncryptionKey

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

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

SentimentSkill

このスキルは非推奨です。 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	string	デンマーク語
de	string	ドイツ語
el	string	ギリシャ語
en	string	英語
es	string	スペイン語
fi	string	フィンランド語
fr	string	フランス語
it	string	イタリア語
nl	string	オランダ語
no	string	ノルウェー語 (ボクマール)
pl	string	ポーランド語
pt-PT	string	ポルトガル語 (ポルトガル)
ru	string	ロシア語
sv	string	スウェーデン語
tr	string	トルコ語

SentimentSkillV3

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

名前	型	規定値	説明
@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

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

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

SplitSkill

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

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.SplitSkill	スキルの種類を指定する URI フラグメント。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が実行されるレベルを表します。既定値は /document です。
defaultLanguageCode	SplitSkillLanguage	使用する言語コードを示す値。既定値は `en` です。
description	string	スキルの入力、出力、使用状況を記述するスキルの説明。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
maximumPageLength	integer	必要な最大ページ長。既定値は 10000 です。
maximumPagesToTake	integer	textSplitMode が 'pages' に設定されている場合にのみ適用されます。指定した場合、SplitSkill は最初の "maximumPagesToTake" ページの処理後に分割を中止し、各ドキュメントから必要な初期ページが少数の場合にパフォーマンスを向上させます。
name	string	スキルセット内で一意に識別するスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付き、先頭に文字 '#' が付けられます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールド、または別のスキルによる入力として使用できる値のいずれかです。
pageOverlapLength	integer	textSplitMode が 'pages' に設定されている場合にのみ適用されます。指定した場合、n + 1 番目のチャンクは、n 番目のチャンクの末尾からこの数の文字/トークンで始まります。
textSplitMode	TextSplitMode	実行する分割モードを示す値。

SplitSkillLanguage

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

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

TextSplitMode

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

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

TextTranslationSkill

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

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

VisualFeature

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

名前	型	説明
adult	string	成人として認識される視覚機能。
brands	string	商用ブランドとして認識されるビジュアル機能。
categories	string	カテゴリ。
description	string	説明
faces	string	人の顔として認識されるビジュアル機能。
objects	string	オブジェクトとして認識されるビジュアル機能。
tags	string	タグ。

WebApiSkill

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	ドキュメントの数を示す目的のバッチサイズ。
context	string	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が実行されるレベルを表します。既定値は /document です。
degreeOfParallelism	integer	設定されている場合、Web API に対して実行できる並列呼び出しの数。
description	string	スキルの入力、出力、使用状況を記述するスキルの説明。
httpHeaders	object	http 要求を行うために必要なヘッダー。
httpMethod	string	http 要求のメソッド。
inputs	InputFieldMappingEntry[]	スキルの入力には、ソースデータセット内の列、またはアップストリームスキルの出力を指定できます。
name	string	スキルセット内で一意に識別するスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付き、先頭に文字 '#' が付けられます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックス内のフィールド、または別のスキルによる入力として使用できる値のいずれかです。
timeout	string	要求に必要なタイムアウト。既定値は 30 秒です。
uri	string	Web API の URL。

次の方法で共有