Skillsets - Create Or Update

服務:

Search Service

API 版本:

2024-07-01

在搜尋服務中建立新的技能集，或在技能集已經存在時更新技能集。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	搜尋服務的端點 URL。
skillsetName	path	True	string	要建立或更新之技能集的名稱。
api-version	query	True	string	用戶端 API 版本。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string uuid	隨要求一起傳送的追蹤標識碼，以協助偵錯。
If-Match		string	定義 If-Match 條件。 只有在伺服器上的 ETag 符合此值時，才會執行此作業。
If-None-Match		string	定義 If-None-Match 條件。 只有在伺服器上的 ETag 不符合此值時，才會執行此作業。
Prefer	True	string	針對 HTTP PUT 要求，指示服務在成功時傳回已建立/更新的資源。

要求本文

名稱	必要	類型	Description
name	True	string	技能集的名稱。
skills	True	SearchIndexerSkill[]: ConditionalSkill[] KeyPhraseExtractionSkill[] OcrSkill[] ImageAnalysisSkill[] LanguageDetectionSkill[] ShaperSkill[] MergeSkill[] EntityRecognitionSkill[] SentimentSkill[] SentimentSkillV3[] EntityLinkingSkill[] EntityRecognitionSkillV3[] PIIDetectionSkill[] SplitSkill[] CustomEntityLookupSkill[] TextTranslationSkill[] DocumentExtractionSkill[] WebApiSkill[] AzureOpenAIEmbeddingSkill[]	技能集中的技能清單。
@odata.etag		string	技能集的 ETag。
cognitiveServices		CognitiveServicesAccount: DefaultCognitiveServicesAccount CognitiveServicesAccountKey	執行技能時要使用的 Azure AI 服務詳細數據。
description		string	技能集的描述。
encryptionKey		SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。 當您想要完整保證沒有人，甚至Microsoft，都可以解密技能集定義時，此密鑰可用來為您的技能集定義提供額外的待用加密層級。 加密技能集定義之後，一律會保持加密狀態。 搜尋服務會忽略將此屬性設定為 null 的嘗試。 如果您想要輪替加密金鑰，您可以視需要變更此屬性;您的技能集定義不會受到影響。 使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
indexProjections		SearchIndexerIndexProjections	對次要搜尋索引的其他投影定義。
knowledgeStore		SearchIndexerKnowledgeStore	對 Azure Blob、數據表或檔案定義擴充數據的其他投影。

回應

名稱	類型	Description
200 OK	SearchIndexerSkillset	技能集已成功更新。
201 Created	SearchIndexerSkillset	已成功建立技能集。
Other Status Codes	ErrorResponse	錯誤回應。

範例

SearchServiceCreateOrUpdateSkillset

範例要求

HTTP

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


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

範例回覆

狀態碼:

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": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": null
  }
}

狀態碼:

201

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

定義

名稱	Description
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	使用文字分析 API，從文字擷取連結的實體。
EntityRecognitionSkill	此技能已被取代。 使用 V3。請改為 EntityRecognitionSkill。
EntityRecognitionSkillLanguage	荒廢的。 EntityRecognitionSkill 支援輸入文字的語言代碼。
EntityRecognitionSkillV3	使用文字分析 API，從文字擷取不同類型的實體。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
ImageAnalysisSkill	分析影像檔案的技能。 它會根據影像內容擷取一組豐富的視覺功能。
ImageAnalysisSkillLanguage	ImageAnalysisSkill 所支援輸入的語言代碼。
ImageDetail	字串，指出要傳回哪些網域特定詳細數據。
IndexProjectionMode	定義與索引器其餘部分相關的索引投影行為。
InputFieldMappingEntry	技能的輸入欄位對應。
KeyPhraseExtractionSkill	使用文字分析進行關鍵片語擷取的技能。
KeyPhraseExtractionSkillLanguage	KeyPhraseExtractionSkill 支援輸入文字的語言代碼。
LanguageDetectionSkill	一種技能，可偵測輸入文字的語言，並報告要求上提交之每份檔的單一語言代碼。 語言代碼會與分數配對，指出分析的信心。
LineEnding	定義字元序列，以在 OCR 技能辨識的文字行之間使用。 預設值為 「space」。
MergeSkill	將兩個或多個字串合併成單一統一字串的技能，選擇性的使用者定義分隔符會分隔每個元件元件元件。
OcrSkill	從圖像檔擷取文字的技能。
OcrSkillLanguage	OcrSkill 所支援輸入的語言代碼。
OutputFieldMappingEntry	技能的輸出欄位對應。
PIIDetectionSkill	使用文字分析 API，從輸入文字擷取個人資訊，並提供遮罩選項。
PIIDetectionSkillMaskingMode	字串，指出用來遮罩輸入文字中偵測到的個人資訊的maskingMode。
SearchIndexerDataNoneIdentity	清除資料源的識別屬性。
SearchIndexerDataUserAssignedIdentity	指定要使用之數據源的身分識別。
SearchIndexerIndexProjections	對次要搜尋索引進行其他投影的定義。
SearchIndexerIndexProjectionSelector	要儲存在指定搜尋索引中的數據描述。
SearchIndexerIndexProjectionsParameters	索引投影特定組態屬性的字典。 每個名稱都是特定屬性的名稱。 每個值都必須是基本類型。
SearchIndexerKnowledgeStore	定義擴充數據之 azure Blob、數據表或檔案的其他投影。
SearchIndexerKnowledgeStoreFileProjectionSelector	要儲存在 Azure 檔案記憶體中的數據投影定義。
SearchIndexerKnowledgeStoreObjectProjectionSelector	要儲存在 Azure Blob 中的數據投影定義。
SearchIndexerKnowledgeStoreProjection	各種投影選取器的容器物件。
SearchIndexerKnowledgeStoreTableProjectionSelector	描述要儲存在 Azure 數據表中的數據。
SearchIndexerSkillset	技能清單。
SearchResourceEncryptionKey	Azure Key Vault 中客戶管理的加密密鑰。 您建立和管理的金鑰可用來加密或解密待用數據，例如索引和同義字對應。
SentimentSkill	此技能已被取代。 使用 V3。相反地，SentimentSkill。
SentimentSkillLanguage	荒廢的。 SentimentSkill 支援輸入文字的語言代碼。
SentimentSkillV3	使用文字分析 API，評估非結構化文字，並針對每個記錄提供情感卷標（例如「負面」、「中性」和「正面」），以服務在句子和檔層級找到的最高信賴分數為基礎。
ShaperSkill	重新調整輸出的技能。 它會建立複雜類型來支持複合欄位（也稱為多部分欄位）。
SplitSkill	將字串分割成文字區塊的技能。
SplitSkillLanguage	SplitSkill 支援輸入文字的語言代碼。
TextSplitMode	值，表示要執行的分割模式。
TextTranslationSkill	將文字從一種語言翻譯成另一種語言的技能。
TextTranslationSkillLanguage	TextTranslationSkill 支援輸入文字的語言代碼。
VisualFeature	字串，表示要傳回的視覺功能類型。
WebApiSkill	可呼叫 Web API 端點的技能，可讓您藉由呼叫自定義程式代碼來擴充技能集。

AzureActiveDirectoryApplicationCredentials

為搜尋服務建立之已註冊應用程式的認證，用於對儲存在 Azure Key Vault 中的加密密鑰進行驗證存取。

名稱	類型	Description
applicationId	string	AAD 應用程式識別碼，已將待用數據加密時要使用的 Azure Key Vault 所需訪問許可權授與。 應用程式標識碼不應與 AAD 應用程式的物件標識元混淆。
applicationSecret	string	指定 AAD 應用程式的驗證金鑰。

AzureOpenAIEmbeddingSkill

可讓您使用 Azure OpenAI 資源為指定的文字輸入產生向量內嵌。

名稱	類型	Description
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	指定技能類型的 URI 片段。
apiKey	string	所指定 Azure OpenAI 資源的 API 金鑰。
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	用於輸出連線的使用者指派受控識別。
context	string	代表作業發生的層級，例如檔根目錄或文件內容（例如 /document 或 /document/content）。 預設值為 /document。
deploymentId	string	指定資源上 Azure OpenAI 模型部署的識別碼。
description	string	描述技能的描述，描述技能的輸入、輸出和使用方式。
dimensions	integer	產生的輸出內嵌應具有的維度數目。 只有文字內嵌-3 和更新版本的模型才支援。
inputs	InputFieldMappingEntry[]	技能的輸入可以是源數據集中的數據行，或上游技能的輸出。
modelName	AzureOpenAIModelName	在提供的 deploymentId 路徑上部署的內嵌模型名稱。
name	string	技能的名稱，可唯一識別技能集內的技能。 未定義名稱的技能將會在技能數位中指定其以 1 起始索引的預設名稱，前面加上字元 『#』。
outputs	OutputFieldMappingEntry[]	技能的輸出是搜尋索引中的字段，或是另一個技能可作為輸入的值。
resourceUri	string	Azure OpenAI 資源的資源 URI。

AzureOpenAIModelName

將呼叫的 Azure Open AI 模型名稱。

名稱	類型	Description
text-embedding-3-large	string
text-embedding-3-small	string
text-embedding-ada-002	string

CognitiveServicesAccountKey

連結至技能集的 Azure AI 服務資源多重區域帳戶密鑰。

名稱	類型	Description
@odata.type	string: #Microsoft.Azure.Search.CognitiveServicesByKey	URI 片段，指定連結至技能集的 Azure AI 服務資源類型。
description	string	附加至技能集的 Azure AI 服務資源描述。
key	string	用來布建連結至技能集的 Azure AI 服務資源密鑰。

ConditionalSkill

一種技能，可讓需要布爾運算的案例，以判斷要指派給輸出的數據。

名稱	類型	Description
@odata.type	string: #Microsoft.Skills.Util.ConditionalSkill	指定技能類型的 URI 片段。
context	string	代表作業發生的層級，例如檔根目錄或文件內容（例如 /document 或 /document/content）。 預設值為 /document。
description	string	描述技能的描述，描述技能的輸入、輸出和使用方式。
inputs	InputFieldMappingEntry[]	技能的輸入可以是源數據集中的數據行，或上游技能的輸出。
name	string	技能的名稱，可唯一識別技能集內的技能。 未定義名稱的技能將會在技能數位中指定其以 1 起始索引的預設名稱，前面加上字元 『#』。
outputs	OutputFieldMappingEntry[]	技能的輸出是搜尋索引中的字段，或是另一個技能可作為輸入的值。

CustomEntity

物件，其中包含找到之相符專案的相關信息，以及相關的元數據。

名稱	類型	Description
accentSensitive	boolean	默認值為 false。 布爾值，表示與實體名稱的比較是否應該區分腔調字。
aliases	CustomEntityAlias[]	複雜物件的陣列，可用來指定根實體名稱的替代拼字或同義字。
caseSensitive	boolean	默認值為 false。 布爾值，表示與實體名稱的比較是否應該區分字元大小寫。 「Microsoft」的範例不區分大小寫比對可能是：microsoft、microSoft、MICROSOFT。
defaultAccentSensitive	boolean	變更此實體的預設腔調敏感度值。 它可用來變更所有別名的預設值不區分腔調值。
defaultCaseSensitive	boolean	變更此實體的預設區分大小寫值。 它可用來變更所有別名 caseSensitive 值的預設值。
defaultFuzzyEditDistance	integer	變更此實體的預設模糊編輯距離值。 它可以用來變更所有別名模糊EditDistance 值的預設值。
description	string	此欄位可用來做為與相符文字相關之自定義元數據的傳遞。 此欄位的值會顯示在其技能輸出中其實體的每個相符專案。
fuzzyEditDistance	integer	預設值為 0。 最大值 5。 表示仍會與實體名稱相符的可接受字元數目。 會傳回任何指定相符專案的最小可能模糊。 例如，如果編輯距離設定為 3，“Windows10” 仍會比對 “Windows”、“Windows10” 和 “Windows 7”。 當區分大小寫設為 false 時，大小寫差異不會計入模糊容錯，否則為 。
id	string	此欄位可用來做為與相符文字相關之自定義元數據的傳遞。 此欄位的值會顯示在其技能輸出中其實體的每個相符專案。
name	string	最上層實體描述元。 技能輸出中的相符專案會依此名稱分組，且應該代表所找到文字的「正規化」形式。
subtype	string	此欄位可用來做為與相符文字相關之自定義元數據的傳遞。 此欄位的值會顯示在其技能輸出中其實體的每個相符專案。
type	string	此欄位可用來做為與相符文字相關之自定義元數據的傳遞。 此欄位的值會顯示在其技能輸出中其實體的每個相符專案。

CustomEntityAlias

複雜物件，可用來指定根實體名稱的替代拼字或同義字。

名稱	類型	Description
accentSensitive	boolean	判斷別名是否區分腔調字。
caseSensitive	boolean	判斷別名是否區分大小寫。
fuzzyEditDistance	integer	判斷別名的模糊編輯距離。
text	string	別名的文字。

CustomEntityLookupSkill

技能會從自定義的使用者定義單字和片語清單尋找文字。

名稱	類型	Description
@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 支援輸入文字的語言代碼。

名稱	類型	Description
da	string	丹麥文
de	string	德語
en	string	英語
es	string	西班牙文
fi	string	芬蘭文
fr	string	法語
it	string	義大利語
ko	string	朝鮮語
pt	string	葡萄牙語

DefaultCognitiveServicesAccount

空的 物件，表示技能集的預設 Azure AI 服務資源。

名稱	類型	Description
@odata.type	string: #Microsoft.Azure.Search.DefaultCognitiveServices	URI 片段，指定連結至技能集的 Azure AI 服務資源類型。
description	string	附加至技能集的 Azure AI 服務資源描述。

DocumentExtractionSkill

從擴充管線內的檔案擷取內容的技能。

名稱	類型	Description
@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

字串，指出要傳回哪些實體類別。

名稱	類型	Description
datetime	string	描述日期和時間的實體。
email	string	描述電子郵件地址的實體。
location	string	描述實體位置的實體。
organization	string	描述組織的實體。
person	string	描述人員的實體。
quantity	string	描述數量的實體。
url	string	描述 URL 的實體。

EntityLinkingSkill

使用文字分析 API，從文字擷取連結的實體。

名稱	類型	Description
@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	呼叫文字分析服務時要使用的模型版本。 如果未指定，則會預設為最新的可用。 除非絕對必要，否則建議您不要指定此值。
name	string	技能的名稱，可唯一識別技能集內的技能。 未定義名稱的技能將會在技能數位中指定其以 1 起始索引的預設名稱，前面加上字元 『#』。
outputs	OutputFieldMappingEntry[]	技能的輸出是搜尋索引中的字段，或是另一個技能可作為輸入的值。

EntityRecognitionSkill

此技能已被取代。 使用 V3。請改為 EntityRecognitionSkill。

名稱	類型	Description
@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 支援輸入文字的語言代碼。

名稱	類型	Description
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

使用文字分析 API，從文字擷取不同類型的實體。

名稱	類型	Description
@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	呼叫文字分析 API 時要使用的模型版本。 如果未指定，則會預設為最新的可用。 除非絕對必要，否則建議您不要指定此值。
name	string	技能的名稱，可唯一識別技能集內的技能。 未定義名稱的技能將會在技能數位中指定其以 1 起始索引的預設名稱，前面加上字元 『#』。
outputs	OutputFieldMappingEntry[]	技能的輸出是搜尋索引中的字段，或是另一個技能可作為輸入的值。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

ImageAnalysisSkill

分析影像檔案的技能。 它會根據影像內容擷取一組豐富的視覺功能。

名稱	類型	Description
@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 所支援輸入的語言代碼。

名稱	類型	Description
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

字串，指出要傳回哪些網域特定詳細數據。

名稱	類型	Description
celebrities	string	辨識為名人的詳細數據。
landmarks	string	辨識為地標的詳細數據。

IndexProjectionMode

定義與索引器其餘部分相關的索引投影行為。

名稱	類型	Description
includeIndexingParentDocuments	string	源檔會寫入索引器的目標索引。 這是預設模式。
skipIndexingParentDocuments	string	源檔將會略過，無法寫入索引器的目標索引。

InputFieldMappingEntry

技能的輸入欄位對應。

名稱	類型	Description
inputs	InputFieldMappingEntry[]	建立複雜型別時所使用的遞歸輸入。
name	string	輸入的名稱。
source	string	輸入的來源。
sourceContext	string	用於選取遞歸輸入的來源內容。

KeyPhraseExtractionSkill

使用文字分析進行關鍵片語擷取的技能。

名稱	類型	Description
@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	呼叫文字分析服務時要使用的模型版本。 如果未指定，則會預設為最新的可用。 除非絕對必要，否則建議您不要指定此值。
name	string	技能的名稱，可唯一識別技能集內的技能。 未定義名稱的技能將會在技能數位中指定其以 1 起始索引的預設名稱，前面加上字元 『#』。
outputs	OutputFieldMappingEntry[]	技能的輸出是搜尋索引中的字段，或是另一個技能可作為輸入的值。

KeyPhraseExtractionSkillLanguage

KeyPhraseExtractionSkill 支援輸入文字的語言代碼。

名稱	類型	Description
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

一種技能，可偵測輸入文字的語言，並報告要求上提交之每份檔的單一語言代碼。 語言代碼會與分數配對，指出分析的信心。

名稱	類型	Description
@odata.type	string: #Microsoft.Skills.Text.LanguageDetectionSkill	指定技能類型的 URI 片段。
context	string	代表作業發生的層級，例如檔根目錄或文件內容（例如 /document 或 /document/content）。 預設值為 /document。
defaultCountryHint	string	如果國家/地區代碼無法釐清語言，則為語言偵測模型的提示。
description	string	描述技能的描述，描述技能的輸入、輸出和使用方式。
inputs	InputFieldMappingEntry[]	技能的輸入可以是源數據集中的數據行，或上游技能的輸出。
modelVersion	string	呼叫文字分析服務時要使用的模型版本。 如果未指定，則會預設為最新的可用。 除非絕對必要，否則建議您不要指定此值。
name	string	技能的名稱，可唯一識別技能集內的技能。 未定義名稱的技能將會在技能數位中指定其以 1 起始索引的預設名稱，前面加上字元 『#』。
outputs	OutputFieldMappingEntry[]	技能的輸出是搜尋索引中的字段，或是另一個技能可作為輸入的值。

LineEnding

定義字元序列，以在 OCR 技能辨識的文字行之間使用。 預設值為 「space」。

名稱	類型	Description
carriageReturn	string	行是以歸位字元分隔（'\r'） 字元。
carriageReturnLineFeed	string	行會以歸位字元和換行字元分隔 （'\r\n'） 字元。
lineFeed	string	行是以單行摘要分隔（'\n'） 字元。
space	string	行會以單一空格符分隔。

MergeSkill

將兩個或多個字串合併成單一統一字串的技能，選擇性的使用者定義分隔符會分隔每個元件元件元件。

名稱	類型	預設值	Description
@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

從圖像檔擷取文字的技能。

名稱	類型	預設值	Description
@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 所支援輸入的語言代碼。

名稱	類型	Description
Jns	string	詹薩里 （德瓦納吉里）
af	string	南非荷蘭文
anp	string	安吉卡（德瓦納吉里）
ar	string	阿拉伯文
ast	string	阿斯圖里亞斯語
awa	string	Awadhi-Hindi （德瓦納吉里）
az	string	亞塞拜然文（拉丁文）
be	string	白俄羅斯文（斯拉夫文和拉丁文）
be-cyrl	string	白俄羅斯文（斯拉夫）
be-latn	string	白俄羅斯文（拉丁文）
bfy	string	巴蓋利
bfz	string	馬哈蘇·帕哈裡（德瓦納吉里）
bg	string	保加利亞文
bgc	string	哈揚維
bho	string	Bhojpuri-Hindi （德瓦納吉里）
bi	string	Bislama
bns	string	邦德利
br	string	布列塔尼文
bra	string	Brajbha
brx	string	博多（德瓦納吉里）
bs	string	波士尼亞拉丁文
bua	string	伯里亞特 （斯拉夫）
ca	string	加泰隆語
ceb	string	Cebuano
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	弗魯利安
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	Hani
hoc	string	何（德瓦納吉里）
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	卡欽（拉丁）
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	庫魯克（德瓦納吉里）
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	Nogay
oc	string	奧克語
os	string	Ossetic
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	薩德里（德瓦納吉里）
sco	string	低地蘇格蘭語
sk	string	斯洛伐克語
sl	string	斯洛維尼亞文
sm	string	薩摩亞文（拉丁）
sma	string	南薩米文
sme	string	北薩米 （拉丁）
smj	string	Lule Sami
smn	string	Inari Sami
sms	string	Skolt Sami
so	string	索馬里（阿拉伯文）
sq	string	阿爾巴尼亞文
sr	string	塞爾維亞文（拉丁文）
sr-Cyrl	string	塞爾維亞文 （斯里爾文）
sr-Latn	string	塞爾維亞文（拉丁文）
srx	string	蘇爾馬里（德瓦納吉里）
sv	string	瑞典文
sw	string	斯瓦希里文 （拉丁）
tet	string	德頓語
tg	string	塔吉克文 （斯拉夫）
thf	string	Thangmi
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	Volapük
wae	string	Walser
xnr	string	康里（德瓦納吉里）
xsr	string	謝爾帕（德瓦納吉里）
yua	string	Yucatec Maya
za	string	壯語
zh-Hans	string	簡體中文
zh-Hant	string	繁體中文
zu	string	祖魯語

OutputFieldMappingEntry

技能的輸出欄位對應。

名稱	類型	Description
name	string	技能所定義的輸出名稱。
targetName	string	輸出的目標名稱。 這是選擇性的，預設為 name。

PIIDetectionSkill

使用文字分析 API，從輸入文字擷取個人資訊，並提供遮罩選項。

名稱	類型	Description
@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	如果 maskingMode 參數設定為取代，則用來遮罩文字的字元。 預設值為 『*』。
maskingMode	PIIDetectionSkillMaskingMode	參數，提供各種方式來遮罩輸入文字中偵測到的個人資訊。 預設值為 『none』。
minimumPrecision	number	介於 0 到 1 之間的值，僅包含信賴分數大於指定值的實體。 如果未設定 （預設值），或明確設定為 null，則會包含所有實體。
modelVersion	string	呼叫文字分析服務時要使用的模型版本。 如果未指定，則會預設為最新的可用。 除非絕對必要，否則建議您不要指定此值。
name	string	技能的名稱，可唯一識別技能集內的技能。 未定義名稱的技能將會在技能數位中指定其以 1 起始索引的預設名稱，前面加上字元 『#』。
outputs	OutputFieldMappingEntry[]	技能的輸出是搜尋索引中的字段，或是另一個技能可作為輸入的值。
piiCategories	string[]	應擷取和遮罩的 PII 實體類別清單。

PIIDetectionSkillMaskingMode

字串，指出用來遮罩輸入文字中偵測到的個人資訊的maskingMode。

名稱	類型	Description
none	string	不會發生遮罩，而且不會傳回maskedText輸出。
replace	string	將偵測到的實體取代為maskingCharacter 參數中指定的字元。 字元會重複至偵測到實體的長度，讓位移正確地對應至輸入文字和輸出 maskedText。

SearchIndexerDataNoneIdentity

清除資料源的識別屬性。

名稱	類型	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	指定身分識別類型的 URI 片段。

SearchIndexerDataUserAssignedIdentity

指定要使用之數據源的身分識別。

名稱	類型	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	指定身分識別類型的 URI 片段。
userAssignedIdentity	string	使用者指派受控識別的完整 Azure 資源標識符，通常格式為 “/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId”。

SearchIndexerIndexProjections

對次要搜尋索引進行其他投影的定義。

名稱	類型	Description
parameters	SearchIndexerIndexProjectionsParameters	索引投影特定組態屬性的字典。 每個名稱都是特定屬性的名稱。 每個值都必須是基本類型。
selectors	SearchIndexerIndexProjectionSelector[]	要對次要搜尋索引執行的投影清單。

SearchIndexerIndexProjectionSelector

要儲存在指定搜尋索引中的數據描述。

名稱	類型	Description
mappings	InputFieldMappingEntry[]	投影的對應，或來源應該對應至目標索引中的哪個欄位。
parentKeyFieldName	string	搜尋索引中要對應父檔的索引鍵值之功能變數名稱。 必須是可篩選的字串字段，而非索引鍵欄位。
sourceContext	string	投影的來源內容。 表示檔將分割成多個子檔的基數。
targetIndexName	string	要投影的搜尋索引名稱。 必須具有已設定 『keyword』 分析器的索引鍵欄位。

SearchIndexerIndexProjectionsParameters

索引投影特定組態屬性的字典。 每個名稱都是特定屬性的名稱。 每個值都必須是基本類型。

名稱	類型	Description
projectionMode	IndexProjectionMode	定義與索引器其餘部分相關的索引投影行為。

SearchIndexerKnowledgeStore

定義擴充數據之 azure Blob、數據表或檔案的其他投影。

名稱	類型	Description
projections	SearchIndexerKnowledgeStoreProjection[]	在編製索引期間要執行的其他投影清單。
storageConnectionString	string	記憶體帳戶投影的連接字串將會儲存在 中。

SearchIndexerKnowledgeStoreFileProjectionSelector

要儲存在 Azure 檔案記憶體中的數據投影定義。

名稱	類型	Description
generatedKeyName	string	要儲存投影的已產生索引鍵名稱。
inputs	InputFieldMappingEntry[]	複雜投影的巢狀輸入。
referenceKeyName	string	不同投影的參考索引鍵名稱。
source	string	源數據至專案。
sourceContext	string	複雜投影的來源內容。
storageContainer	string	要儲存投影的 Blob 容器。

SearchIndexerKnowledgeStoreObjectProjectionSelector

要儲存在 Azure Blob 中的數據投影定義。

名稱	類型	Description
generatedKeyName	string	要儲存投影的已產生索引鍵名稱。
inputs	InputFieldMappingEntry[]	複雜投影的巢狀輸入。
referenceKeyName	string	不同投影的參考索引鍵名稱。
source	string	源數據至專案。
sourceContext	string	複雜投影的來源內容。
storageContainer	string	要儲存投影的 Blob 容器。

SearchIndexerKnowledgeStoreProjection

各種投影選取器的容器物件。

名稱	類型	Description
files	SearchIndexerKnowledgeStoreFileProjectionSelector[]	投影至 Azure 檔案記憶體。
objects	SearchIndexerKnowledgeStoreObjectProjectionSelector[]	對 Azure Blob 記憶體的投影。
tables	SearchIndexerKnowledgeStoreTableProjectionSelector[]	投影至 Azure 資料表記憶體。

SearchIndexerKnowledgeStoreTableProjectionSelector

描述要儲存在 Azure 數據表中的數據。

名稱	類型	Description
generatedKeyName	string	要儲存投影的已產生索引鍵名稱。
inputs	InputFieldMappingEntry[]	複雜投影的巢狀輸入。
referenceKeyName	string	不同投影的參考索引鍵名稱。
source	string	源數據至專案。
sourceContext	string	複雜投影的來源內容。
tableName	string	要儲存投影數據的 Azure 資料表名稱。

SearchIndexerSkillset

技能清單。

名稱	類型	Description
@odata.etag	string	技能集的 ETag。
cognitiveServices	CognitiveServicesAccount: CognitiveServicesAccountKey DefaultCognitiveServicesAccount	執行技能時要使用的 Azure AI 服務詳細數據。
description	string	技能集的描述。
encryptionKey	SearchResourceEncryptionKey	您在 Azure Key Vault 中建立的加密金鑰描述。 當您想要完整保證沒有人，甚至Microsoft，都可以解密技能集定義時，此密鑰可用來為您的技能集定義提供額外的待用加密層級。 加密技能集定義之後，一律會保持加密狀態。 搜尋服務會忽略將此屬性設定為 null 的嘗試。 如果您想要輪替加密金鑰，您可以視需要變更此屬性;您的技能集定義不會受到影響。 使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
indexProjections	SearchIndexerIndexProjections	對次要搜尋索引的其他投影定義。
knowledgeStore	SearchIndexerKnowledgeStore	對 Azure Blob、數據表或檔案定義擴充數據的其他投影。
name	string	技能集的名稱。
skills	SearchIndexerSkill[]: AzureOpenAIEmbeddingSkill[] ConditionalSkill[] CustomEntityLookupSkill[] DocumentExtractionSkill[] EntityLinkingSkill[] EntityRecognitionSkill[] EntityRecognitionSkillV3[] ImageAnalysisSkill[] KeyPhraseExtractionSkill[] LanguageDetectionSkill[] MergeSkill[] OcrSkill[] PIIDetectionSkill[] SentimentSkill[] SentimentSkillV3[] ShaperSkill[] SplitSkill[] TextTranslationSkill[] WebApiSkill[]	技能集中的技能清單。

SearchResourceEncryptionKey

Azure Key Vault 中客戶管理的加密密鑰。 您建立和管理的金鑰可用來加密或解密待用數據，例如索引和同義字對應。

名稱	類型	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	用來存取 Azure Key Vault 的選擇性 Azure Active Directory 認證。 如果改用受控識別，則不需要。
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。

名稱	類型	Description
@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 支援輸入文字的語言代碼。

名稱	類型	Description
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

使用文字分析 API，評估非結構化文字，並針對每個記錄提供情感卷標（例如「負面」、「中性」和「正面」），以服務在句子和檔層級找到的最高信賴分數為基礎。

名稱	類型	預設值	Description
@odata.type	string: #Microsoft.Skills.Text.V3.SentimentSkill		指定技能類型的 URI 片段。
context	string		代表作業發生的層級，例如檔根目錄或文件內容（例如 /document 或 /document/content）。 預設值為 /document。
defaultLanguageCode	string		值，指出要使用的語言程序代碼。 預設值為 en。
description	string		描述技能的描述，描述技能的輸入、輸出和使用方式。
includeOpinionMining	boolean	False	如果設定為 true，技能輸出會包含文字分析中用於意見採礦的資訊，也就是目標（名詞或動詞）及其相關評量（形容詞）在文字中。 默認值為 false。
inputs	InputFieldMappingEntry[]		技能的輸入可以是源數據集中的數據行，或上游技能的輸出。
modelVersion	string		呼叫文字分析服務時要使用的模型版本。 如果未指定，則會預設為最新的可用。 除非絕對必要，否則建議您不要指定此值。
name	string		技能的名稱，可唯一識別技能集內的技能。 未定義名稱的技能將會在技能數位中指定其以 1 起始索引的預設名稱，前面加上字元 『#』。
outputs	OutputFieldMappingEntry[]		技能的輸出是搜尋索引中的字段，或是另一個技能可作為輸入的值。

ShaperSkill

重新調整輸出的技能。 它會建立複雜類型來支持複合欄位（也稱為多部分欄位）。

名稱	類型	Description
@odata.type	string: #Microsoft.Skills.Util.ShaperSkill	指定技能類型的 URI 片段。
context	string	代表作業發生的層級，例如檔根目錄或文件內容（例如 /document 或 /document/content）。 預設值為 /document。
description	string	描述技能的描述，描述技能的輸入、輸出和使用方式。
inputs	InputFieldMappingEntry[]	技能的輸入可以是源數據集中的數據行，或上游技能的輸出。
name	string	技能的名稱，可唯一識別技能集內的技能。 未定義名稱的技能將會在技能數位中指定其以 1 起始索引的預設名稱，前面加上字元 『#』。
outputs	OutputFieldMappingEntry[]	技能的輸出是搜尋索引中的字段，或是另一個技能可作為輸入的值。

SplitSkill

將字串分割成文字區塊的技能。

名稱	類型	Description
@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 支援輸入文字的語言代碼。

名稱	類型	Description
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

值，表示要執行的分割模式。

名稱	類型	Description
pages	string	將文字分割成個別頁面。
sentences	string	將文字分割成個別句子。

TextTranslationSkill

將文字從一種語言翻譯成另一種語言的技能。

名稱	類型	Description
@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 支援輸入文字的語言代碼。

名稱	類型	Description
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	克林貢 （拉丁劇本）
tlh-Piqd	string	克林貢 （克林貢腳本）
to	string	湯加語
tr	string	土耳其文
ty	string	大溪 地
uk	string	烏克蘭文
ur	string	烏都語
vi	string	越南文
yua	string	Yucatec Maya
yue	string	粵語（傳統）
zh-Hans	string	簡體中文
zh-Hant	string	繁體中文

VisualFeature

字串，表示要傳回的視覺功能類型。

名稱	類型	Description
adult	string	辨識為成人的視覺特徵。
brands	string	辨識為商業品牌的視覺功能。
categories	string	類別。
description	string	描述。
faces	string	辨識為人臉的視覺功能。
objects	string	辨識為對象的視覺功能。
tags	string	標籤。

WebApiSkill

可呼叫 Web API 端點的技能，可讓您藉由呼叫自定義程式代碼來擴充技能集。

名稱	類型	Description
@odata.type	string: #Microsoft.Skills.Custom.WebApiSkill	指定技能類型的 URI 片段。
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	用於輸出連線的使用者指派受控識別。 如果提供 authResourceId 且未指定，則會使用系統指派的受控識別。 在索引器更新時，如果未指定身分識別，該值會維持不變。 如果設定為 「none」 則會清除此屬性的值。
authResourceId	string	適用於連線至 Azure 函式中外部程式代碼的自定義技能，或提供轉換的一些其他應用程式。 當函式或應用程式向 Azure Active Directory 註冊時，此值應該是為該函式或應用程式所建立的應用程式識別碼。 指定時，自定義技能會使用搜尋服務的受控標識碼（系統或使用者指派）和函式或應用程式的存取令牌，使用此值作為建立存取令牌範圍的資源標識符，聯機到函式或應用程式的函式或應用程式。
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。