Skillsets - Get

  • リファレンス
サービス:
Search Service
API バージョン:
2024-07-01

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

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

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

要求のサンプル

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

応答のサンプル

状態コード:
200 
{
  "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": "myKeyName",
    "keyVaultKeyVersion": "myKeyVersion",
    "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

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:

送信接続に使用されるユーザー割り当てマネージド ID。
context

string

ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。 既定値は /document です。
deploymentId

string

指定されたリソースに対する Azure OpenAI モデルデプロイの ID。
description

string

スキルの入力、出力、および使用方法を記述するスキルの説明。
dimensions

integer

結果の出力埋め込みで必要なディメンションの数。 text-embedding-3 以降のモデルでのみサポートされます。
inputs

InputFieldMappingEntry[]

スキルの入力には、ソース データ セット内の列、またはアップストリーム スキルの出力を指定できます。
modelName

AzureOpenAIModelName

指定された deploymentId パスにデプロイされる埋め込みモデルの名前。
name

string

スキルセット内で一意に識別されるスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs

OutputFieldMappingEntry[]

スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。
resourceUri

string

Azure OpenAI リソースのリソース URI。

AzureOpenAIModelName

呼び出される Azure Open AI モデル名。

名前 型 説明
text-embedding-3-large

string

text-embedding-3-small

string

text-embedding-ada-002

string

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 のグローバル フラグ。 CustomEntity で CaseSensitive が設定されていない場合、この値は既定値になります。
globalDefaultFuzzyEditDistance

integer

FuzzyEditDistance のグローバル フラグ。 CustomEntity で FuzzyEditDistance が設定されていない場合、この値は既定値になります。
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

ポルトガル語

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

組織を記述するエンティティ。
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

ノルウェー語 (ブークマル)
pl

string

ポーランド語
pt-BR

string

ポルトガル語 (ブラジル)
pt-PT

string

ポルトガル語 (ポルトガル)
ru

string

ロシア語
sv

string

スウェーデン語
tr

string

トルコ語
zh-Hans

string

Chinese-Simplified
zh-Hant

string

Chinese-Traditional

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

エラー オブジェクト。

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

Portuguese-Portugal
pt-BR

string

Portuguese-Brazil
pt-PT

string

Portuguese-Portugal
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

ノルウェー語 (ブークマル)
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

Angika (Devanagiri)
ar

string

アラビア語
ast

string

アストゥリアス
awa

string

Awadhi-Hindi (デバナギリ)
az

string

アゼルバイジャン語 (ラテン)
be

string

ベラルーシ語 (キリル文字とラテン文字)
be-cyrl

string

ベラルーシ語 (キリル)
be-latn

string

ベラルーシ語 (ラテン)
bfy

string

Bagheli
bfz

string

マハース・パハリ (デバナギリ)
bg

string

ブルガリア語
bgc

string

Haryanvi
bho

string

Bhojpuri-Hindi (デバナギリ)
bi

string

ビスラマ
bns

string

Bundeli
br

string

ブルトン語
bra

string

Brajbha
brx

string

Bodo (Devanagiri)
bs

string

ボスニア語 (ラテン)
bua

string

Buryat (キリル)
ca

string

カタロニア語
ceb

string

セブアノ
ch

string

チャモロ
cnr-cyrl

string

モンテネグリン (キリル)
cnr-latn

string

モンテネグリン (ラテン)
co

string

コルシカ
crh

string

クリミアタタール語 (ラテン)
cs

string

チェコ語
csb

string

Kashubian
cy

string

ウェールズ語
da

string

デンマーク語
de

string

ドイツ語
dhi

string

Dhimal (Devanagiri)
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

Gilbertese
gl

string

ガリシア語
gon

string

ゴンディ (デバナギリ)
gv

string

マンクス
gvr

string

Gurung (Devanagiri)
haw

string

ハワイ語
hi

string

ヒンディー語
hlb

string

Halbi (デバナギリ)
hne

string

チャットティサルギ (デバナギリ)
hni

string

Hani
hoc

string

Ho (Devanagiri)
hr

string

クロアチア語
hsb

string

上ソルビアン
ht

string

ハイチ語
hu

string

ハンガリー語
ia

string

インターリングア
id

string

インドネシア語
is

string

アイスランド語
it

string

イタリア語
iu

string

Inuktitut (ラテン)
ja

string

日本語
jv

string

ジャワ語
kaa

string

Kara-Kalpak (ラテン)
kaa-cyrl

string

Kara-Kalpak (キリル)
kac

string

Kachin (ラテン)
kea

string

Kabuverdianu
kfq

string

Korku
kha

string

Khasi
kk-cyrl

string

カザフ語 (キリル)
kk-latn

string

カザフ語 (ラテン)
kl

string

グリーンランド語
klr

string

Khaling
kmj

string

マルト (デバナギリ)
ko

string

韓国語
kos

string

コスレアーン
kpy

string

Koryak
krc

string

Karachay-Balkar
kru

string

Kurukh (Devanagiri)
ksh

string

Ripuarian
ku-arab

string

クルド語 (アラビア語)
ku-latn

string

クルド語 (ラテン)
kum

string

Kumyk (キリル)
kw

string

コーンウォール語
ky

string

Kyrgyz (キリル)
la

string

ラテン語
lb

string

ルクセンブルク語
lkt

string

ラコタ
lt

string

リトアニア語
mi

string

マオリ語
mn

string

モンゴル語 (キリル)
mr

string

マラーティー語
ms

string

マレー語 (ラテン)
mt

string

マルタ語
mww

string

モンドー語 (ラテン)
myv

string

Erzya (キリル)
nap

string

ナポリ語
nb

string

ノルウェー語
ne

string

ネパール語
niu

string

ニウエアン
nl

string

オランダ語
no

string

ノルウェー語
nog

string

Nogay
oc

string

Occitan
os

string

オセット語
pa

string

パンジャブ語 (アラビア語)
pl

string

ポーランド語
prs

string

ダリー語
ps

string

パシュトー語
pt

string

ポルトガル語
quc

string

K'iche'
rab

string

チャムリング
rm

string

ロマンシュ語
ro

string

ルーマニア語
ru

string

ロシア語
sa

string

サンスクリット語 (デバナギリ)
sat

string

サンタリ (デバナギリ)
sck

string

Sadri (Devanagiri)
sco

string

スコットランド語
sk

string

スロバキア語
sl

string

スロベニア語
sm

string

サモア語 (ラテン)
sma

string

南サーミ
sme

string

北サーミ語 (ラテン)
smj

string

Lule Sami
smn

string

いなりさみ
sms

string

Skolt Sami
so

string

ソマリア語 (アラビア語)
sq

string

アルバニア語
sr

string

セルビア語 (ラテン)
sr-Cyrl

string

セルビア語 (キリル)
sr-Latn

string

セルビア語 (ラテン)
srx

string

サーマウリ (デバナギリ)
sv

string

スウェーデン語
sw

string

Swahili (ラテン)
tet

string

Tetum
tg

string

タジク語 (キリル)
thf

string

Thangmi
tk

string

トルクメン語 (ラテン)
to

string

トンガ語
tr

string

トルコ語
tt

string

タタール語 (ラテン)
tyv

string

Tuvan
ug

string

ウイグル語 (アラビア語)
unk

string

不明 (すべて)
ur

string

ウルドゥ語
uz

string

ウズベク語 (ラテン)
uz-arab

string

ウズベク語 (アラビア語)
uz-cyrl

string

ウズベク語 (キリル)
vo

string

Volapük
wae

string

Walser
xnr

string

カングリ (デバナギリ)
xsr

string

Sherpa (Devanagiri)
yua

string

ユカテック マヤ
za

string

荘
zh-Hans

string

簡体字中国語
zh-Hant

string

繁体字中国語
zu

string

ズールー語

OutputFieldMappingEntry

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

名前 型 説明
name

string

スキルによって定義された出力の名前。
targetName

string

出力のターゲット名。 これは省略可能であり、既定では名前になります。

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

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

名前 型 説明
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-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、テーブル、またはファイルへの追加プロジェクションの定義。

名前 型 説明
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 コンテナー。

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:

スキルの実行時に使用する Azure AI サービスの詳細。
description

string

スキルセットの説明。
encryptionKey

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 このキーは、Microsoft 以外のユーザーがスキルセット定義の暗号化を解除できないという完全な保証が必要な場合に、スキルセット定義の保存時の暗号化レベルを追加するために使用されます。 スキルセット定義を暗号化すると、常に暗号化されたままになります。 検索サービスは、このプロパティを null に設定する試行を無視します。 暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。スキルセットの定義は影響を受けません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
indexProjections

SearchIndexerIndexProjections

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

SearchIndexerKnowledgeStore

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

string

スキルセットの名前。
skills SearchIndexerSkill[]:

スキルセット内のスキルの一覧。

SearchResourceEncryptionKey

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

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

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

Klingon
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:

送信接続に使用されるユーザー割り当てマネージド 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。