Skillsets - Create

服務:

Search Service

API 版本:

2023-10-01-Preview

在搜尋服務中建立新的技能集。

POST {endpoint}/skillsets?api-version=2023-10-01-Preview

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	搜尋服務的端點 URL。
api-version	query	True	string	用戶端 API 版本。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string uuid	使用要求傳送的追蹤標識碼，以協助偵錯。

要求本文

名稱	必要	類型	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[] AmlSkill[] AzureOpenAIEmbeddingSkill[]	技能集中的技能清單。
@odata.etag		string	技能集的 ETag。
cognitiveServices		CognitiveServicesAccount: DefaultCognitiveServicesAccount CognitiveServicesAccountKey	執行技能時所要使用的 Azure AI 服務詳細數據。
description		string	技能集的描述。
encryptionKey		SearchResourceEncryptionKey	您在 Azure 金鑰保存庫 中建立的加密金鑰描述。 當您想要完全保證即使 Microsoft 也無法解密技能集定義時，此密鑰可用來為您的技能集定義提供額外的待用加密層級。 加密技能集定義之後，它一律會保持加密狀態。 搜尋服務會忽略將此屬性設定為 Null 的嘗試。 如果您想要輪替加密金鑰，您可以視需要變更此屬性;您的技能集定義不會受到影響。 使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於在 2019 年 1 月 1 日或之後建立的付費服務。
indexProjections		SearchIndexerIndexProjections	次要搜尋索引 (對次要搜尋索引的定義) 。
knowledgeStore		SearchIndexerKnowledgeStore	擴充數據的 Azure Blob、數據表或檔案的其他投影定義。

回應

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

範例

SearchServiceCreateSkillset

範例要求

HTTP

POST https://myservice.search.windows.net/skillsets?api-version=2023-10-01-Preview

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

範例回覆

狀態碼:

201

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

定義

名稱	Description
AmlSkill	AML 技能可讓您使用自訂 Azure Machine Learning (AML) 模型來擴充 AI 擴充。 在 AML 模型定型並部署後，AML 技能就會將其整合到 AI 擴充中。
AzureActiveDirectoryApplicationCredentials	為搜尋服務建立之已註冊應用程式的認證，用於驗證存取儲存在 Azure 金鑰保存庫 中的加密密鑰。
AzureOpenAIEmbeddingSkill	可讓您使用 Azure OpenAI 資源為指定的文字輸入產生向量內嵌。
CognitiveServicesAccountKey	附加至技能集之 Azure AI 服務資源的多重區域帳戶密鑰。
ConditionalSkill	技能，可讓需要布爾運算的案例來判斷要指派給輸出的數據。
CustomEntity	物件，包含所找到相符專案的相關信息，以及相關的元數據。
CustomEntityAlias	複雜物件，可用來指定根實體名稱的替代拼字或同義字。
CustomEntityLookupSkill	技能會從自定義、使用者定義的單字和片語清單中尋找文字。
CustomEntityLookupSkillLanguage	CustomEntityLookupSkill 支援輸入文字的語言代碼。
DefaultCognitiveServicesAccount	空白物件，表示技能集的預設 Azure AI 服務資源。
DocumentExtractionSkill	從擴充管線內的檔案擷取內容的技能。
EntityCategory	字串，表示要傳回的實體類別。
EntityLinkingSkill	使用 文字分析 API，從文字中擷取連結的實體。
EntityRecognitionSkill	此技能已被取代。 使用 V3。EntityRecognitionSkill 改為。
EntityRecognitionSkillLanguage	已取代。 EntityRecognitionSkill 支援輸入文字的語言代碼。
EntityRecognitionSkillV3	使用 文字分析 API，從文字擷取不同類型的實體。
ImageAnalysisSkill	分析影像檔案的技能。 它會根據影像內容擷取一組豐富的視覺功能。
ImageAnalysisSkillLanguage	ImageAnalysisSkill 所支援輸入的語言代碼。
ImageDetail	字串，表示要傳回哪些網域特定詳細數據。
IndexProjectionMode	定義與索引器其餘部分相關的索引投影行為。
InputFieldMappingEntry	技能的輸入欄位對應。
KeyPhraseExtractionSkill	使用文字分析進行關鍵片語擷取的技能。
KeyPhraseExtractionSkillLanguage	KeyPhraseExtractionSkill所支援輸入文字的語言代碼。
LanguageDetectionSkill	一種技能，可偵測輸入文字的語言，並針對要求上提交的每份文件報告單一語言代碼。 語言程式代碼會與分數配對，指出分析的信賴度。
LineEnding	定義字元序列，以在 OCR 技能辨識的文字行之間使用。 預設值為 「space」。
MergeSkill	將兩個或多個字串合併成單一統一字串的技能，其中選擇性的用戶定義分隔符會分隔每個元件元件。
OcrSkill	從圖像檔擷取文字的技能。
OcrSkillLanguage	OcrSkill 所支援輸入的語言代碼。
OutputFieldMappingEntry	技能的輸出欄位對應。
PIIDetectionSkill	使用 文字分析 API，從輸入文字擷取個人資訊，並提供遮罩選項。
PIIDetectionSkillMaskingMode	字串，指出用來遮罩輸入文字中偵測到的個人資訊的maskingMode。
SearchError	描述 API 的錯誤狀況。
SearchIndexerDataNoneIdentity	清除資料源的識別屬性。
SearchIndexerDataUserAssignedIdentity	指定要使用之數據源的身分識別。
SearchIndexerIndexProjections	對次要搜尋索引的其他投影定義。
SearchIndexerIndexProjectionSelector	要儲存在指定搜尋索引中的數據描述。
SearchIndexerIndexProjectionsParameters	索引投影特定組態屬性的字典。 每個名稱都是特定屬性的名稱。 每個值都必須是基本類型。
SearchIndexerKnowledgeStore	擴充數據的 Azure Blob、數據表或檔案的其他投影定義。
SearchIndexerKnowledgeStoreFileProjectionSelector	要儲存在 Azure 檔案儲存體 中的數據投影定義。
SearchIndexerKnowledgeStoreObjectProjectionSelector	要儲存在 Azure Blob 中的數據投影定義。
SearchIndexerKnowledgeStoreParameters	知識存放區特定組態屬性的字典。 每個名稱都是特定屬性的名稱。 每個值都必須是基本類型。
SearchIndexerKnowledgeStoreProjection	各種投影選取器的容器物件。
SearchIndexerKnowledgeStoreTableProjectionSelector	要儲存在 Azure 數據表中的數據描述。
SearchIndexerSkillset	技能清單。
SearchResourceEncryptionKey	Azure 中客戶管理的加密金鑰 金鑰保存庫。 您建立和管理的金鑰可用來加密或解密待用數據，例如索引和同義字對應。
SentimentSkill	此技能已被取代。 使用 V3。請改用 SentimentSkill。
SentimentSkillLanguage	已取代。 SentimentSkill 支援輸入文字的語言代碼。
SentimentSkillV3	使用 文字分析 API 評估非結構化文字，並針對每個記錄提供情感卷標 (，例如「負面」、「中性」和「正面」) ，根據服務在句子和檔層級找到的最高信賴分數。
ShaperSkill	調整輸出的技能。 它會建立複雜類型來支持複合字段 (也稱為多部分字段) 。
SplitSkill	將字串分割成文字區塊的技能。
SplitSkillLanguage	SplitSkill 支援輸入文字的語言代碼。
TextSplitMode	值，表示要執行的分割模式。
TextTranslationSkill	將文字從一種語言翻譯成另一種語言的技能。
TextTranslationSkillLanguage	TextTranslationSkill 支援輸入文字的語言代碼。
VisualFeature	字串，表示要傳回哪些視覺功能類型。
WebApiSkill	可呼叫 Web API 端點的技能，可讓您藉由呼叫自定義程式代碼來擴充技能集。

AmlSkill

AML 技能可讓您使用自訂 Azure Machine Learning (AML) 模型來擴充 AI 擴充。 在 AML 模型定型並部署後，AML 技能就會將其整合到 AI 擴充中。

名稱	類型	Description
@odata.type	string: #Microsoft.Skills.Custom.AmlSkill	指定技能類型的 URI 片段。
context	string	表示作業發生的層級，例如檔根目錄或文件內容 (，例如 /document 或 /document/content) 。 預設值為 /document。
degreeOfParallelism	integer	(選擇性) 指定時，表示索引子將對您提供的端點平行發出的呼叫數目。 如果您的端點因要求負載過高而失敗，您可以降低此值；如果端點能夠接受更多要求，且您想要提升索引子的效能，則可以提高此值。 若未設定，將會使用預設值 0.5。 degreeOfParallelism 最高可設定為 10，最低為 1。
description	string	描述技能的描述，描述技能的輸入、輸出和使用方式。
inputs	InputFieldMappingEntry[]	技能的輸入可以是源數據集中的數據行，或是上游技能的輸出。
key	string	(金鑰驗證需要) AML 服務的金鑰。
name	string	技能的名稱，可唯一識別技能集內的技能。 在技能陣列中，沒有定義名稱的技能會指定其以1為基底索引的預設名稱，前面加上字元'#'。
outputs	OutputFieldMappingEntry[]	技能的輸出是搜尋索引中的字段，或可供另一個技能作為輸入的值。
region	string	(權杖驗證的選用項目)。 AML 服務部署所在的區域。
resourceId	string	(權杖驗證需要)。 AML 服務的 Azure Resource Manager 資源識別碼。 其格式應為 subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}。
timeout	string	(選擇性) 指定時，表示進行 API 呼叫的 http 用戶端逾時。
uri	string	(無驗證或金鑰驗證需要) JSON 承載將傳送到的 AML 服務的評分 URI。 僅允許 https URI 配置。

AzureActiveDirectoryApplicationCredentials

為搜尋服務建立之已註冊應用程式的認證，用於驗證存取儲存在 Azure 金鑰保存庫 中的加密密鑰。

名稱	類型	Description
applicationId	string	AAD 應用程式識別碼，授與加密待用數據時所要使用的 Azure 金鑰保存庫 所需訪問許可權。 應用程式標識碼不應與 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	描述技能的描述，描述技能的輸入、輸出和使用方式。
inputs	InputFieldMappingEntry[]	技能的輸入可以是源數據集中的數據行，或是上游技能的輸出。
name	string	技能的名稱，可唯一識別技能集內的技能。 在技能陣列中，沒有定義名稱的技能會指定其以1為基底索引的預設名稱，前面加上字元'#'。
outputs	OutputFieldMappingEntry[]	技能的輸出是搜尋索引中的字段，或可供另一個技能作為輸入的值。
resourceUri	string	Azure OpenAI 資源的資源 URI。

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	變更此實體的預設模糊編輯距離值。 這可以用來變更所有別名 fuzzyEditDistance 值的預設值。
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	簡體中文
zh-Hant	string	繁體中文

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[]	技能的輸出是搜尋索引中的字段，或是另一個技能可當作輸入取用的值。

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	Hebrew
hi	string	Hindi
hr	string	克羅埃西亞文
hu	string	匈牙利文
id	string	印尼文
it	string	義大利文
ja	string	日文
kk	string	哈薩克文
ko	string	韓文
lt	string	立陶宛文
lv	string	拉脫維亞文
mk	string	馬其頓文
ms	string	馬來文 (馬來西亞)
nb	string	挪威文 (巴克摩)
nl	string	荷蘭文
pl	string	波蘭文
prs	string	達利文
pt	string	葡萄牙文 (葡萄牙)
pt-BR	string	葡萄牙文 (巴西)
pt-PT	string	葡萄牙文 (葡萄牙)
ro	string	羅馬尼亞文
ru	string	俄文
sk	string	斯洛伐克文
sl	string	斯洛維尼亞文
sr-Cyrl	string	塞爾維亞文 (斯拉夫 RS)
sr-Latn	string	塞爾維亞文 (拉丁 RS)
sv	string	瑞典文
th	string	泰文
tr	string	土耳其文
uk	string	烏克蘭文
vi	string	越南文
zh	string	簡體中文
zh-Hans	string	簡體中文
zh-Hant	string	繁體中文

ImageDetail

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

名稱	類型	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	阿瓦德文 - 印度文 (梵文字母)
az	string	亞塞拜然文 (拉丁)
be	string	白俄羅斯文 (斯拉夫文和拉丁文)
be-cyrl	string	白俄羅斯文 (斯拉夫)
be-latn	string	白俄羅斯文 (拉丁)
bfy	string	巴哥里文
bfz	string	馬哈蘇帕哈里文 (梵文字母)
bg	string	保加利亞文
bgc	string	哈里亞納文
bho	string	博杰普爾文 - 印地文 (梵文字母)
bi	string	比斯拉馬文
bns	string	Bundeli
br	string	布列塔尼文
bra	string	Brajbha
brx	string	霍文 (梵文字母)
bs	string	波士尼亞文 (拉丁)
bua	string	布里亞特文 (斯拉夫)
ca	string	卡達隆尼亞文
ceb	string	宿霧文
ch	string	查莫羅文
cnr-cyrl	string	蒙特內哥羅文 (斯拉夫)
cnr-latn	string	蒙特內哥羅文 (拉丁)
co	string	科西嘉文
crh	string	克里米亞韃靼文 (拉丁)
cs	string	捷克文
csb	string	卡舒比文
cy	string	威爾斯文
da	string	丹麥文
de	string	德文
dhi	string	狄摩文 (梵文字母)
doi	string	多格拉文 (梵文字母)
dsb	string	下索布文
el	string	希臘文
en	string	英文
es	string	西班牙文
et	string	愛沙尼亞文
eu	string	巴斯克文
fa	string	波斯文
fi	string	芬蘭文
fil	string	菲律賓文
fj	string	斐濟文
fo	string	法羅文
fr	string	法文
fur	string	Frulian
fy	string	西弗里西亞文
ga	string	愛爾蘭文
gag	string	加告茲文 (拉丁)
gd	string	蘇格蘭蓋爾文
gil	string	吉里巴斯文
gl	string	加里斯亞文
gon	string	貢德文 (梵文字母)
gv	string	曼島文
gvr	string	古隆文 (梵文字母)
haw	string	夏威夷文
hi	string	Hindi
hlb	string	亥比文 (梵文字母)
hne	string	恰蒂斯加爾文 (梵文字母)
hni	string	哈尼文
hoc	string	Ho (Devanagiri)
hr	string	克羅埃西亞文
hsb	string	上索布文
ht	string	海地克裏奧爾文
hu	string	匈牙利文
ia	string	人工國際語
id	string	印尼文
is	string	冰島文
it	string	義大利文
iu	string	依奴提圖特文 (拉丁)
ja	string	日文
jv	string	爪哇文
kaa	string	卡拉卡爾帕克文 (拉丁)
kaa-cyrl	string	卡拉卡爾帕克文 (斯拉夫)
kac	string	克欽文 (拉丁)
kea	string	維德角文
kfq	string	科爾庫文
kha	string	卡西文
kk-cyrl	string	哈薩克文 (斯拉夫)
kk-latn	string	哈薩克文 (拉丁)
kl	string	格陵蘭文
klr	string	哈林文
kmj	string	馬爾托文 (梵文字母)
ko	string	韓文
kos	string	科斯雷文
kpy	string	科里亞克文
krc	string	卡拉恰伊巴爾卡爾文
kru	string	庫魯克文 (梵文字母)
ksh	string	利普里安文
ku-arab	string	庫德文 (阿拉伯文)
ku-latn	string	庫德文 (拉丁)
kum	string	庫梅克文 (斯拉夫)
kw	string	康沃耳文
ky	string	吉爾吉斯文 (斯拉夫)
la	string	拉丁文
lb	string	盧森堡文
lkt	string	拉科塔文
lt	string	立陶宛文
mi	string	毛利文
mn	string	蒙古文 (斯拉夫)
mr	string	馬拉地文
ms	string	馬來文 (拉丁)
mt	string	馬爾他文
mww	string	白苗文 (拉丁)
myv	string	厄爾茲亞文 (斯拉夫)
nap	string	那不勒斯文
nb	string	挪威文
ne	string	尼泊爾文
niu	string	紐埃文
nl	string	荷蘭文
no	string	挪威文
nog	string	諾蓋文
oc	string	奧克西坦文
os	string	奧塞提文
pa	string	旁遮普文 (阿拉伯)
pl	string	波蘭文
prs	string	達利文
ps	string	普什圖文
pt	string	葡萄牙文
quc	string	基切文
rab	string	查姆靈文
rm	string	羅曼斯文
ro	string	羅馬尼亞文
ru	string	俄文
sa	string	Sanskrit (Devanagiri)
sat	string	(Devanagiri)
sck	string	薩德里文 (梵文字母)
sco	string	蘇格蘭文
sk	string	斯洛伐克文
sl	string	斯洛維尼亞文
sm	string	薩摩亞文 (拉丁)
sma	string	南薩米文
sme	string	北薩米文 (拉丁)
smj	string	魯勒薩米文
smn	string	伊納里薩米文
sms	string	斯科特薩米文
so	string	索馬利文 (阿拉伯)
sq	string	阿爾巴尼亞文
sr	string	塞爾維亞文 (拉丁)
sr-Cyrl	string	塞爾維亞文 (斯拉夫)
sr-Latn	string	塞爾維亞文 (拉丁)
srx	string	西爾毛利文 (梵文字母)
sv	string	瑞典文
sw	string	史瓦希里文 (拉丁)
tet	string	德頓文
tg	string	塔吉克文 (斯拉夫)
thf	string	塔米文
tk	string	土庫曼文 (拉丁)
to	string	東加文
tr	string	土耳其文
tt	string	韃靼文 (拉丁)
tyv	string	圖瓦文
ug	string	維吾爾文 (阿拉伯)
unk	string	未知 (所有)
ur	string	烏都文
uz	string	烏茲別克文 (拉丁)
uz-arab	string	烏茲別克文 (阿拉伯文)
uz-cyrl	string	烏茲別克文 (斯拉夫)
vo	string	沃拉普克文
wae	string	瓦瑟文
xnr	string	康格里文 (梵文字母)
xsr	string	夏爾巴文 (梵文字母)
yua	string	猶加敦馬雅文
za	string	壯文
zh-Hans	string	簡體中文
zh-Hant	string	繁體中文
zu	string	祖魯文

OutputFieldMappingEntry

技能的輸出欄位對應。

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

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。

SearchError

描述 API 的錯誤狀況。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	SearchError[]	導致此錯誤之特定錯誤的詳細數據陣列。
message	string	人類可讀取的錯誤表示法。

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-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
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	撰寫知識存放區投影時，用於連線到 Azure 記憶體的使用者指派受控識別。 如果 連接字串 指出 (ResourceId) 的身分識別，而且未指定，則會使用系統指派的受控識別。 在索引器的更新上，如果未指定身分識別，該值會保持不變。 如果設定為 「none」 則會清除此屬性的值。
parameters	SearchIndexerKnowledgeStoreParameters	知識存放區特定組態屬性的字典。 每個名稱都是特定屬性的名稱。 每個值都必須是基本類型。
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 容器。

SearchIndexerKnowledgeStoreParameters

知識存放區特定組態屬性的字典。 每個名稱都是特定屬性的名稱。 每個值都必須是基本類型。

名稱	類型	預設值	Description
synthesizeGeneratedKeyName	boolean	False	如果尚未產生投影，是否應該合成產生的索引鍵名稱。

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 金鑰保存庫 中建立的加密金鑰描述。 當您想要完全保證即使 Microsoft 也無法解密技能集定義時，此密鑰可用來為您的技能集定義提供額外的待用加密層級。 加密技能集定義之後，它一律會保持加密狀態。 搜尋服務會忽略將此屬性設定為 Null 的嘗試。 如果您想要輪替加密金鑰，您可以視需要變更此屬性;您的技能集定義不會受到影響。 使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於在 2019 年 1 月 1 日或之後建立的付費服務。
indexProjections	SearchIndexerIndexProjections	次要搜尋索引 (對次要搜尋索引的定義) 。
knowledgeStore	SearchIndexerKnowledgeStore	擴充數據的 Azure Blob、數據表或檔案的其他投影定義。
name	string	技能集的名稱。
skills	SearchIndexerSkill[]: AmlSkill[] AzureOpenAIEmbeddingSkill[] ConditionalSkill[] CustomEntityLookupSkill[] DocumentExtractionSkill[] EntityLinkingSkill[] EntityRecognitionSkill[] EntityRecognitionSkillV3[] ImageAnalysisSkill[] KeyPhraseExtractionSkill[] LanguageDetectionSkill[] MergeSkill[] OcrSkill[] PIIDetectionSkill[] SentimentSkill[] SentimentSkillV3[] ShaperSkill[] SplitSkill[] TextTranslationSkill[] WebApiSkill[]	技能集中的技能清單。

SearchResourceEncryptionKey

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

名稱	類型	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	用於存取 Azure 金鑰保存庫 的選擇性 Azure Active Directory 認證。 若改用受控識別，則不需要。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	要用於此加密金鑰的明確受控識別。 如果未指定，且存取認證屬性為 Null，則會使用系統指派的受控識別。 更新資源時，如果未指定明確的身分識別，則會維持不變。 如果指定了 「none」 則會清除此屬性的值。
keyVaultKeyName	string	用來加密待用數據的 Azure 金鑰保存庫 金鑰名稱。
keyVaultKeyVersion	string	用來加密待用數據的 Azure 金鑰保存庫 金鑰版本。
keyVaultUri	string	Azure 金鑰保存庫 的 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	Hebrew
hi	string	Hindi
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	Hebrew
hi	string	Hindi
hr	string	克羅埃西亞文
ht	string	海地克裏奧爾文
hu	string	匈牙利文
id	string	印尼文
is	string	冰島文
it	string	義大利文
ja	string	日文
kn	string	坎那達文
ko	string	韓文
lt	string	立陶宛文
lv	string	拉脫維亞文
mg	string	馬達加斯加文
mi	string	毛利文
ml	string	馬來亞拉姆文
ms	string	馬來文
mt	string	馬爾他文
mww	string	白苗文
nb	string	挪威文
nl	string	荷蘭文
otq	string	奎雷塔洛歐多米文
pa	string	旁遮普文
pl	string	波蘭文
pt	string	葡萄牙文
pt-PT	string	葡萄牙文 (葡萄牙)
pt-br	string	葡萄牙文 (巴西)
ro	string	羅馬尼亞文
ru	string	俄文
sk	string	斯洛伐克文
sl	string	斯洛維尼亞文
sm	string	薩摩亞文
sr-Cyrl	string	塞爾維亞文 (斯拉夫)
sr-Latn	string	塞爾維亞文 (拉丁)
sv	string	瑞典文
sw	string	史瓦希里文
ta	string	坦米爾文
te	string	泰盧固文
th	string	泰文
tlh	string	克林貢文
tlh-Latn	string	Klingon (拉丁腳本)
tlh-Piqd	string	Klingon (Klingon 腳本)
to	string	東加文
tr	string	土耳其文
ty	string	大溪地文
uk	string	烏克蘭文
ur	string	烏都文
vi	string	越南文
yua	string	猶加敦馬雅文
yue	string	粵語 (繁體中文)
zh-Hans	string	簡體中文
zh-Hant	string	繁體中文

VisualFeature

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

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