次の方法で共有


Skillsets - Get

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

GET {endpoint}/skillsets('{skillsetName}')?api-version=2025-09-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://stableexampleservice.search.windows.net/skillsets('myskillset')?api-version=2025-09-01

応答のサンプル

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "myskillset",
  "description": "Skillset for extracting entities and more",
  "skills": [
    {
      "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
      "name": "skill2",
      "context": "/document",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "countryHint",
          "source": "/document/countryHint",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "languageCode",
          "targetName": "languageCode"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.SplitSkill",
      "name": "skill3",
      "context": "/document",
      "defaultLanguageCode": "en",
      "textSplitMode": "pages",
      "maximumPageLength": 4000,
      "pageOverlapLength": 0,
      "maximumPagesToTake": 0,
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "textItems",
          "targetName": "pages"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
      "name": "skill4",
      "context": "/document/pages/*",
      "defaultLanguageCode": "en",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "keyPhrases",
          "targetName": "keyPhrases"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
      "name": "skill5",
      "context": "/document",
      "uri": "https://contoso.example.org/",
      "httpMethod": "POST",
      "timeout": "PT5S",
      "batchSize": 1000,
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "customresult",
          "targetName": "result"
        }
      ],
      "httpHeaders": {}
    },
    {
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill",
      "context": "/document",
      "outputMode": "oneToMany",
      "markdownHeaderDepth": "h3",
      "outputFormat": "markdown",
      "extractionOptions": [],
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "markdown_document",
          "targetName": "markdown_document"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill#2",
      "context": "/document",
      "outputMode": "oneToMany",
      "outputFormat": "text",
      "extractionOptions": [
        "images",
        "locationMetadata"
      ],
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "text_sections",
          "targetName": "text_sections"
        },
        {
          "name": "normalized_images",
          "targetName": "normalized_images"
        }
      ],
      "chunkingProperties": {
        "unit": "characters",
        "maximumLength": 500,
        "overlapLength": 50
      }
    }
  ]
}

定義

名前 説明
AzureActiveDirectoryApplicationCredentials

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

AzureOpenAIEmbeddingSkill

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

AzureOpenAIModelName

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

CognitiveServicesAccountKey

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

ConditionalSkill

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

CustomEntity

見つかった一致に関する情報と、関連するメタデータを含むオブジェクト。

CustomEntityAlias

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

CustomEntityLookupSkill

スキルは、ユーザー定義の単語およびフレーズのカスタム・リストからテキストを検索します。

CustomEntityLookupSkillLanguage

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

DefaultCognitiveServicesAccount

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

DocumentExtractionSkill

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

DocumentIntelligenceLayoutSkill

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

DocumentIntelligenceLayoutSkillChunkingProperties

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

DocumentIntelligenceLayoutSkillChunkingUnit

チャンク単位のカーディナリティを制御します。 デフォルトは「characters」です。

DocumentIntelligenceLayoutSkillExtractionOptions

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

DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

マークダウン出力のヘッダーの深さ。 デフォルトは h6 です。

DocumentIntelligenceLayoutSkillOutputFormat

出力形式のカーディナリティを制御します。 デフォルトは「markdown」です。

DocumentIntelligenceLayoutSkillOutputMode

スキルによって生成される出力のカーディナリティを制御します。 デフォルトは「oneToMany」です。

EntityCategory

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

EntityLinkingSkill

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

EntityRecognitionSkill

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

EntityRecognitionSkillLanguage

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

EntityRecognitionSkillV3

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

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

ImageAnalysisSkill

画像ファイルを分析するスキル。 画像コンテンツに基づいて、豊富な視覚的特徴セットを抽出します。

ImageAnalysisSkillLanguage

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

ImageDetail

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

IndexProjectionMode

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

InputFieldMappingEntry

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

KeyPhraseExtractionSkill

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

KeyPhraseExtractionSkillLanguage

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

LanguageDetectionSkill

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

LineEnding

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

MergeSkill

2つ以上の文字列を1つの統合文字列にマージするためのスキルで、オプションのユーザー定義区切り文字で各コンポーネント・パーツを区切る。

OcrSkill

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

OcrSkillLanguage

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

OutputFieldMappingEntry

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

PIIDetectionSkill

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

PIIDetectionSkillMaskingMode

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

SearchIndexerDataNoneIdentity

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

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

Deprecated. 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 (int32)

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

inputs

InputFieldMappingEntry[]

スキルの入力は、ソース・データ・セットの列、またはアップストリーム・スキルの出力である可能性があります。

modelName

AzureOpenAIModelName

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

name

string

スキルセット内で一意に識別するスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスのデフォルト名が与えられ、接頭辞に文字「#」が付けられます。

outputs

OutputFieldMappingEntry[]

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

resourceUri

string (uri)

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

AzureOpenAIModelName

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

説明
text-embedding-ada-002
text-embedding-3-large
text-embedding-3-small

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 (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

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

名前 説明
accentSensitive

boolean

エイリアスがアクセントを区別するかどうかを判断します。

caseSensitive

boolean

エイリアスで大文字と小文字が区別されるかどうかを判断します。

fuzzyEditDistance

integer (int32)

エイリアスのあいまい編集距離を決定します。

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

globalDefaultCaseSensitive

boolean

CaseSensitive のグローバル フラグ。 CaseSensitive が CustomEntity に設定されていない場合、この値は既定値になります。

globalDefaultFuzzyEditDistance

integer (int32)

FuzzyEditDistanceのグローバルフラグ。 FuzzyEditDistance が CustomEntity に設定されていない場合、この値が既定値になります。

inlineEntitiesDefinition

CustomEntity[]

インライン CustomEntity 定義。

inputs

InputFieldMappingEntry[]

スキルの入力は、ソース・データ・セットの列、またはアップストリーム・スキルの出力である可能性があります。

name

string

スキルセット内で一意に識別するスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスのデフォルト名が与えられ、接頭辞に文字「#」が付けられます。

outputs

OutputFieldMappingEntry[]

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

CustomEntityLookupSkillLanguage

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

説明
da

デンマーク語

de

ドイツ語

en

英語

es

スペイン語

fi

フィンランド語

fr

フランス語

it

イタリア語

ko

韓国語

pt

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。 定義されていない場合は「デフォルト」に設定されます。

DocumentIntelligenceLayoutSkill

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

名前 規定値 説明
@odata.type string:

#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill

スキルのタイプを指定するURIフラグメント。

chunkingProperties

DocumentIntelligenceLayoutSkillChunkingProperties

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

context

string

ドキュメントルートやドキュメントコンテンツ (/document や /document/content など) など、操作が実行されるレベルを表します。 デフォルトは /document です。

description

string

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

extractionOptions

DocumentIntelligenceLayoutSkillExtractionOptions[]

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

inputs

InputFieldMappingEntry[]

スキルの入力は、ソース・データ・セットの列、またはアップストリーム・スキルの出力である可能性があります。

markdownHeaderDepth

DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

h6

マークダウン出力のヘッダーの深さ。 デフォルトは h6 です。

name

string

スキルセット内で一意に識別するスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスのデフォルト名が与えられ、接頭辞に文字「#」が付けられます。

outputFormat

DocumentIntelligenceLayoutSkillOutputFormat

markdown

出力形式のカーディナリティを制御します。 デフォルトは「markdown」です。

outputMode

DocumentIntelligenceLayoutSkillOutputMode

oneToMany

スキルによって生成される出力のカーディナリティを制御します。 デフォルトは「oneToMany」です。

outputs

OutputFieldMappingEntry[]

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

DocumentIntelligenceLayoutSkillChunkingProperties

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

名前 規定値 説明
maximumLength

integer (int32)

チャンクの最大長(文字数)。 既定値は 500 です。

overlapLength

integer (int32)

2 つのテキスト チャンク間で指定されるオーバーラップの長さ。 既定値は 0 です。

unit

DocumentIntelligenceLayoutSkillChunkingUnit

characters

チャンクの単位。

DocumentIntelligenceLayoutSkillChunkingUnit

チャンク単位のカーディナリティを制御します。 デフォルトは「characters」です。

説明
characters

チャンクを文字で指定します。

DocumentIntelligenceLayoutSkillExtractionOptions

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

説明
images

ドキュメントから画像コンテンツを抽出するように指定します。

locationMetadata

場所のメタデータをドキュメントから抽出するように指定します。

DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

マークダウン出力のヘッダーの深さ。 デフォルトは h6 です。

説明
h1

ヘッダー レベル 1。

h2

ヘッダーレベル 2。

h3

ヘッダーレベル3。

h4

ヘッダーレベル 4。

h5

ヘッダーレベル5。

h6

ヘッダーレベル6。

DocumentIntelligenceLayoutSkillOutputFormat

出力形式のカーディナリティを制御します。 デフォルトは「markdown」です。

説明
text

出力の形式をテキストとして指定します。

markdown

出力の形式をマークダウンとして指定します。

DocumentIntelligenceLayoutSkillOutputMode

スキルによって生成される出力のカーディナリティを制御します。 デフォルトは「oneToMany」です。

説明
oneToMany

出力を「oneToMany」として解析するように指定します。

EntityCategory

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

説明
___location

物理的な場所を記述するエンティティ。

organization

組織を記述するエンティティ。

person

人を記述するエンティティ。

quantity

数量を記述するエンティティ。

datetime

日付と時刻を記述するエンティティ。

url

URL を記述するエンティティ。

email

電子メール アドレスを記述するエンティティ。

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 (double)

minimum: 0
maximum: 1

信頼度スコアが指定された値よりも大きいエンティティのみを含めるために使用される 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 に設定すると、定義済みの型の 1 つに準拠していないエンティティは表示されません。

inputs

InputFieldMappingEntry[]

スキルの入力は、ソース・データ・セットの列、またはアップストリーム・スキルの出力である可能性があります。

minimumPrecision

number (double)

信頼度スコアが指定された値よりも大きいエンティティのみを含めるために使用される 0 から 1 までの値。 設定されていない場合 (デフォルト)、または明示的に null に設定されている場合、すべてのエンティティが含まれます。

name

string

スキルセット内で一意に識別するスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスのデフォルト名が与えられ、接頭辞に文字「#」が付けられます。

outputs

OutputFieldMappingEntry[]

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

EntityRecognitionSkillLanguage

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

説明
ar

アラビア語

cs

チェコ語

zh-Hans

中国語 (簡体字)

zh-Hant

Chinese-Traditional

da

デンマーク語

nl

オランダ語

en

英語

fi

フィンランド語

fr

フランス語

de

ドイツ語

el

ギリシャ語

hu

Hungarian

it

イタリア語

ja

日本語

ko

韓国語

no

ノルウェー語(ボクマール)

pl

ポーランド語

pt-PT

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

pt-BR

ポルトガル語 (ブラジル)

ru

ロシア語

es

スペイン語

sv

スウェーデン語

tr

トルコ語

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 (double)

minimum: 0
maximum: 1

信頼度スコアが指定された値よりも大きいエンティティのみを含めるために使用される 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

アラビア語

az

アゼルバイジャン語

bg

ブルガリア語

bs

ボスニア語 (ラテン)

ca

カタロニア語

cs

チェコ語

cy

Welsh

da

デンマーク語

de

ドイツ語

el

ギリシャ語

en

英語

es

スペイン語

et

Estonian

eu

バスク語

fi

フィンランド語

fr

フランス語

ga

Irish

gl

ガリシア語

he

Hebrew

hi

Hindi

hr

Croatian

hu

Hungarian

id

Indonesian

it

イタリア語

ja

日本語

kk

Kazakh

ko

韓国語

lt

Lithuanian

lv

Latvian

mk

Macedonian

ms

マレー語 (マレーシア)

nb

ノルウェー語 (ブークモール)

nl

オランダ語

pl

ポーランド語

prs

Dari

pt-BR

ポルトガル語 (ブラジル)

pt

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

pt-PT

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

ro

Romanian

ru

ロシア語

sk

Slovak

sl

Slovenian

sr-Cyrl

セルビア語 - キリル文字 RS

sr-Latn

セルビア語 - ラテン RS

sv

スウェーデン語

th

タイ語

tr

トルコ語

uk

ウクライナ語

vi

ベトナム語

zh

簡体中国語

zh-Hans

簡体中国語

zh-Hant

中国語 (繁体字)

ImageDetail

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

説明
celebrities

有名人として認められたディテール。

landmarks

目印として認識されたディテール。

IndexProjectionMode

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

説明
skipIndexingParentDocuments

ソース ドキュメントは、インデクサーのターゲット インデックスへの書き込みからスキップされます。

includeIndexingParentDocuments

ソース ドキュメントは、インデクサーのターゲット インデックスに書き込まれます。 これはデフォルトのパターンです。

InputFieldMappingEntry

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

名前 説明
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 (int32)

返すキー フレーズの数を示す数値。 存在しない場合は、識別されたすべてのキー フレーズが返されます。

modelVersion

string

Text Analytics サービスを呼び出すときに使用するモデルのバージョン。 指定しない場合は、デフォルトで利用可能な最新のものになります。 どうしても必要な場合を除き、この値を指定しないことをお勧めします。

name

string

スキルセット内で一意に識別するスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスのデフォルト名が与えられ、接頭辞に文字「#」が付けられます。

outputs

OutputFieldMappingEntry[]

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

KeyPhraseExtractionSkillLanguage

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

説明
da

デンマーク語

nl

オランダ語

en

英語

fi

フィンランド語

fr

フランス語

de

ドイツ語

it

イタリア語

ja

日本語

ko

韓国語

no

ノルウェー語(ボクマール)

pl

ポーランド語

pt-PT

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

pt-BR

ポルトガル語 (ブラジル)

ru

ロシア語

es

スペイン語

sv

スウェーデン語

LanguageDetectionSkill

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

名前 説明
@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

行は 1 つのスペース文字で区切られます。

carriageReturn

行はキャリッジリターン ('\r') 文字で区切られます。

lineFeed

行は 1 つの改行 ('\n') 文字で区切られます。

carriageReturnLineFeed

行は、改行と改行 ('\r\n') 文字で区切られます。

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スキルによって認識されるテキスト行間で使用する文字のシーケンスを定義します。 デフォルト値は「スペース」です。

name

string

スキルセット内で一意に識別するスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスのデフォルト名が与えられ、接頭辞に文字「#」が付けられます。

outputs

OutputFieldMappingEntry[]

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

OcrSkillLanguage

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

説明
af

Afrikaans

sq

Albanian

anp

アンギカ語 (デーヴァナーガリー)

ar

アラビア語

ast

アストリア語

awa

アワディー語 (デーヴァナーガリー)

az

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

bfy

バゲーリー語

eu

バスク語

be

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

be-cyrl

ベラルーシ語 (キリル)

be-latn

ベラルーシ語 (ラテン)

bho

ボージュプリー語 (デーヴァナーガリー)

bi

ビスラマ語

brx

ボド語 (デーヴァナーガリー)

bs

ボスニア語 (ラテン)

bra

ブラジュバー語

br

ブルトン語

bg

ブルガリア語

bns

ブンデーリー語

bua

ブリヤート語 (キリル)

ca

カタロニア語

ceb

セブアノ語

rab

チャムリング語

ch

チャモロ語

hne

チャッティースガリー語 (デーヴァナーガリー)

zh-Hans

簡体中国語

zh-Hant

中国語 (繁体字)

kw

コーンウォール語

co

コルシカ語

crh

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

hr

Croatian

cs

チェコ語

da

デンマーク語

prs

Dari

dhi

ディマール語 (デーヴァナーガリー)

doi

ドーグリー語 (デーヴァナーガリー)

nl

オランダ語

en

英語

myv

エルジャ語 (キリル)

et

Estonian

fo

フェロー語

fj

フィジー語

fil

Filipino

fi

フィンランド語

fr

フランス語

fur

フルリアン

gag

ガガウズ語 (ラテン)

gl

ガリシア語

de

ドイツ語

gil

キリバス語

gon

ゴーンディー語 (デーヴァナーガリー)

el

ギリシャ語

kl

グリーンランド語

gvr

グルン語 (デーヴァナーガリー)

ht

ハイチ クレオール語

hlb

ハルビ語 (デーヴァナーガリー)

hni

ハニ語

bgc

ハリヤーンウィー語

haw

ハワイ語

hi

Hindi

mww

ミャオ語 (ラテン)

hoc

ホー(デーヴァナギリ)

hu

Hungarian

is

Icelandic

smn

イナリ サーミ語

id

Indonesian

ia

インターリングア

iu

イヌクティトット語 (ラテン)

ga

Irish

it

イタリア語

ja

日本語

Jns

ジャウンサーリー語 (デーヴァナーガリー)

jv

ジャワ文字

kea

カーボベルデ・クレオール語

kac

カチン語 (ラテン)

xnr

カーングリー語 (デーヴァナーガリー)

krc

カラチャイ バルカル語

kaa-cyrl

カラ カルパク語 (キリル)

kaa

カラ カルパク語 (ラテン)

csb

カシュビア語

kk-cyrl

カザフ語 (キリル)

kk-latn

カザフ語 (ラテン)

klr

カリン語

kha

カシ語

quc

キチェ語

ko

韓国語

kfq

コルク語

kpy

コリャーク語

kos

コスラエ語

kum

クムク語 (キリル)

ku-arab

クルド語 (アラビア文字)

ku-latn

クルド語 (ラテン文字)

kru

クルク語 (デーヴァナーガリー)

ky

キルギス語 (キリル語)

lkt

ラコタ語

la

ラテン文字

lt

Lithuanian

dsb

低地ソルブ語

smj

ルレ サーミ語

lb

Luxembourgish

bfz

マハス パハリー語 (デーヴァナーガリー)

ms

マレー語 (ラテン)

mt

Maltese

kmj

マルト語 (デーヴァナーガリー)

gv

マン語

mi

Maori

mr

Marathi

mn

モンゴル語 (キリル)

cnr-cyrl

モンテネグロ語 (キリル)

cnr-latn

モンテネグロ語 (ラテン)

nap

ナポリ語

ne

ネパール語

niu

ニウエ語

nog

ノガイ語

sme

北サーミ語 (ラテン)

nb

ノルウェー語

no

ノルウェー語

oc

オクシタン語

os

オセット語

ps

パシュトウ語

fa

Persian

pl

ポーランド語

pt

Portuguese

pa

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

ksh

リプアーリ語

ro

Romanian

rm

ロマンシュ語

ru

ロシア語

sck

サドリ語 (デーヴァナーガリー)

sm

サモア語 (ラテン)

sa

サンスクリット語(デーヴァナギリ)

sat

サンタリ(デーヴァナギリ)

sco

スコットランド語

gd

スコットランド・ゲール語

sr

セルビア語 (ラテン)

sr-Cyrl

セルビア語 (キリル)

sr-Latn

セルビア語 (ラテン)

xsr

シェルパ語 (デーヴァナーガリー)

srx

スルマウリ語 (デーヴァナーガリー)

sms

スコルト サーミ語

sk

Slovak

sl

Slovenian

so

ソマリ語 (アラビア語)

sma

南部サーミ語

es

スペイン語

sw

スワヒリ語 (ラテン)

sv

スウェーデン語

tg

タジク語 (キリル)

tt

タタール語 (ラテン)

tet

テトゥン語

thf

タンミ語

to

トンガ語

tr

トルコ語

tk

トルクメン語 (ラテン)

tyv

トゥヴァ語

hsb

上ソルブ語

ur

Urdu

ug

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

uz-arab

ウズベク語 (アラビア語)

uz-cyrl

ウズベク語 (キリル)

uz

ウズベク語 (ラテン)

vo

ヴォラピュク

wae

ヴァリス語

cy

Welsh

fy

西フリジア語

yua

ユカテコ語

za

チワン語

zu

ズールー語

unk

不明 (すべて)

OutputFieldMappingEntry

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

名前 説明
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' が含まれます。 デフォルトは「なし」です。

inputs

InputFieldMappingEntry[]

スキルの入力は、ソース・データ・セットの列、またはアップストリーム・スキルの出力である可能性があります。

maskingCharacter

string

maxLength: 1

maskingMode パラメーターが置換に設定されている場合にテキストをマスクするために使用される文字。 デフォルトは '*' です。

maskingMode

PIIDetectionSkillMaskingMode

入力テキストで検出された個人情報をマスキングするさまざまな方法を提供するパラメーター。 デフォルトは「なし」です。

minimumPrecision

number (double)

minimum: 0
maximum: 1

信頼度スコアが指定された値よりも大きいエンティティのみを含めるために使用される 0 から 1 までの値。 設定されていない場合 (デフォルト)、または明示的に null に設定されている場合、すべてのエンティティが含まれます。

modelVersion

string

Text Analytics サービスを呼び出すときに使用するモデルのバージョン。 指定しない場合は、デフォルトで利用可能な最新のものになります。 どうしても必要な場合を除き、この値を指定しないことをお勧めします。

name

string

スキルセット内で一意に識別するスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスのデフォルト名が与えられ、接頭辞に文字「#」が付けられます。

outputs

OutputFieldMappingEntry[]

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

piiCategories

string[]

抽出してマスクする必要がある PII エンティティ カテゴリのリスト。

PIIDetectionSkillMaskingMode

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

説明
none

マスキングは行われず、maskedText 出力は返されません。

replace

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

SearchIndexerDataNoneIdentity

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

名前 説明
@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/1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" の形式です。

SearchIndexerIndexProjections

二次検索インデックスへの追加プロジェクションの定義。

名前 説明
parameters

SearchIndexerIndexProjectionsParameters

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

selectors

SearchIndexerIndexProjectionSelector[]

2 次検索インデックスに対して実行されるプロジェクションのリスト。

SearchIndexerIndexProjectionSelector

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

名前 説明
mappings

InputFieldMappingEntry[]

プロジェクションのマッピング、またはターゲットインデックスのどのフィールドにどのソースをマップする必要があるか。

parentKeyFieldName

string

親ドキュメントのキー値をマップする検索インデックス内のフィールドの名前。 キー フィールドではなく、フィルター処理可能な文字列フィールドである必要があります。

sourceContext

string

プロジェクションのソースコンテキスト。 ドキュメントが複数のサブドキュメントに分割されるカーディナリティを表します。

targetIndexName

string

投影先の検索インデックスの名前。 「キーワード」アナライザーが設定されたキーフィールドが必要です。

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 テーブル ストレージへのプロジェクション。

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

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

説明
da

デンマーク語

nl

オランダ語

en

英語

fi

フィンランド語

fr

フランス語

de

ドイツ語

el

ギリシャ語

it

イタリア語

no

ノルウェー語(ボクマール)

pl

ポーランド語

pt-PT

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

ru

ロシア語

es

スペイン語

sv

スウェーデン語

tr

トルコ語

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 (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

Amharic

bs

Bosnian

cs

チェコ語

da

デンマーク語

de

ドイツ語

en

英語

es

スペイン語

et

Estonian

fi

フィンランド語

fr

フランス語

he

Hebrew

hi

Hindi

hr

Croatian

hu

Hungarian

id

Indonesian

is

Icelandic

it

イタリア語

ja

日本語

ko

韓国語

lv

Latvian

nb

ノルウェー語

nl

オランダ語

pl

ポーランド語

pt

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

pt-br

ポルトガル語 (ブラジル)

ru

ロシア語

sk

Slovak

sl

Slovenian

sr

Serbian

sv

スウェーデン語

tr

トルコ語

ur

Urdu

zh

簡体中国語

TextSplitMode

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

説明
pages

テキストを個々のページに分割します。

sentences

テキストを個々の文に分割します。

TextTranslationSkill

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

名前 説明
@odata.type string:

#Microsoft.Skills.Text.TranslationSkill

スキルのタイプを指定するURIフラグメント。

context

string

ドキュメントルートやドキュメントコンテンツ (/document や /document/content など) など、操作が実行されるレベルを表します。 デフォルトは /document です。

defaultFromLanguageCode

TextTranslationSkillLanguage

送信元言語を明示的に指定していないドキュメントのドキュメントを翻訳する言語コード。

defaultToLanguageCode

TextTranslationSkillLanguage

宛先言語を明示的に指定していないドキュメントのドキュメントを翻訳する言語コード。

description

string

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

inputs

InputFieldMappingEntry[]

スキルの入力は、ソース・データ・セットの列、またはアップストリーム・スキルの出力である可能性があります。

name

string

スキルセット内で一意に識別するスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスのデフォルト名が与えられ、接頭辞に文字「#」が付けられます。

outputs

OutputFieldMappingEntry[]

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

suggestedFrom

TextTranslationSkillLanguage

fromLanguageCode 入力も defaultFromLanguageCode パラメーターも指定されておらず、自動言語検出が失敗した場合に、ドキュメントを翻訳する言語コード。 既定値は en です。

TextTranslationSkillLanguage

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

説明
af

Afrikaans

ar

アラビア語

bn

ベンガル語

bs

ボスニア語 (ラテン)

bg

ブルガリア語

yue

広東語 (繁体字)

ca

カタロニア語

zh-Hans

簡体中国語

zh-Hant

中国語 (繁体字)

hr

Croatian

cs

チェコ語

da

デンマーク語

nl

オランダ語

en

英語

et

Estonian

fj

フィジー語

fil

Filipino

fi

フィンランド語

fr

フランス語

de

ドイツ語

el

ギリシャ語

ht

ハイチ クレオール語

he

Hebrew

hi

Hindi

mww

フモン語 (ドー)

hu

Hungarian

is

Icelandic

id

Indonesian

it

イタリア語

ja

日本語

sw

Kiswahili

tlh

クリンゴン語

tlh-Latn

クリンゴン語(ラテン文字)

tlh-Piqd

クリンゴン語(クリンゴン文字)

ko

韓国語

lv

Latvian

lt

Lithuanian

mg

マダガスカル語

ms

Malay

mt

Maltese

nb

ノルウェー語

fa

Persian

pl

ポーランド語

pt

Portuguese

pt-br

ポルトガル語 (ブラジル)

pt-PT

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

otq

ケレタロオトミ語

ro

Romanian

ru

ロシア語

sm

サモア語

sr-Cyrl

セルビア語 (キリル)

sr-Latn

セルビア語 (ラテン)

sk

Slovak

sl

Slovenian

es

スペイン語

sv

スウェーデン語

ty

タヒチ語

ta

Tamil

te

Telugu

th

タイ語

to

トンガ語

tr

トルコ語

uk

ウクライナ語

ur

Urdu

vi

ベトナム語

cy

Welsh

yua

ユカテコ語

ga

Irish

kn

Kannada

mi

Maori

ml

Malayalam

pa

Punjabi

VisualFeature

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

説明
adult

成人として認識される視覚的特徴。

brands

商業ブランドとして認識されているビジュアル機能。

categories

カテゴリ。

description

Description.

faces

人の顔として認識される視覚的特徴。

objects

オブジェクトとして認識される視覚的特徴。

tags

タグ。

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 (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。