你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Skillsets - Create Or Update

Service:

Search Service

API Version:

2023-10-01-Preview

在搜索服务中创建新的技能组，或者更新技能组（如果已存在）。

PUT {endpoint}/skillsets('{skillsetName}')?api-version=2023-10-01-Preview

With optional parameters:

PUT {endpoint}/skillsets('{skillsetName}')?api-version=2023-10-01-Preview&ignoreResetRequirements={ignoreResetRequirements}&disableCacheReprocessingChangeDetection={disableCacheReprocessingChangeDetection}

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	搜索服务的终结点 URL。
skillsetName	path	True	string	要创建或更新的技能组的名称。
api-version	query	True	string	客户端 API 版本。
disableCacheReprocessingChangeDetection	query		boolean	禁用缓存重新处理更改检测。
ignoreResetRequirements	query		boolean	忽略缓存重置要求。

请求头

名称	必需	类型	说明
x-ms-client-request-id		string uuid	随请求一起发送以帮助调试的跟踪 ID。
If-Match		string	定义 If-Match 条件。 仅当服务器上的 ETag 与此值匹配时，才会执行该操作。
If-None-Match		string	定义 If-None-Match 条件。 仅当服务器上的 ETag 与此值不匹配时，才会执行该操作。
Prefer	True	string	对于 HTTP PUT 请求，指示服务在成功时返回创建/更新的资源。

请求正文

名称	必需	类型	说明
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	定义辅助搜索索引的其他投影 (es) 。
knowledgeStore		SearchIndexerKnowledgeStore	定义扩充数据的 Azure Blob、表或文件的其他投影。

响应

名称	类型	说明
200 OK	SearchIndexerSkillset	技能组已成功更新。
201 Created	SearchIndexerSkillset	已成功创建技能组。
Other Status Codes	SearchError	错误响应。

示例

SearchServiceCreateOrUpdateSkillset

Sample Request

HTTP

PUT https://myservice.search.windows.net/skillsets('demoskillset')?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": {}
    }
  ],
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": null
  }
}

Sample Response

Status code:

200

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

Status code:

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": null
  }
}

定义

名称	说明
AmlSkill	通过 AML 技能，可以使用自定义 Azure 机器学习 (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。情绪技能相反。
SentimentSkillLanguage	已弃用。 SentimentSkill 支持的输入文本的语言代码。
SentimentSkillV3	使用 文本分析 API 评估非结构化文本，并针对每个记录，根据服务在句子和文档级别找到的最高置信度分数，提供“负面”、“中性”和“积极”) 等 (情绪标签。
ShaperSkill	用于重塑输出的技能。 它创建一个复杂类型以支持复合字段 (也称为多部分字段) 。
SplitSkill	将字符串拆分为文本块的技能。
SplitSkillLanguage	SplitSkill 支持的输入文本的语言代码。
TextSplitMode	一个 值，该值指示要执行的拆分模式。
TextTranslationSkill	将文本从一种语言翻译到另一种语言的技能。
TextTranslationSkillLanguage	TextTranslationSkill 支持的输入文本的语言代码。
VisualFeature	指示要返回的视觉特征类型的字符串。
WebApiSkill	一种可以调用 Web API 终结点的技能，允许你通过调用自定义代码来扩展技能集。

AmlSkill

通过 AML 技能，可以使用自定义 Azure 机器学习 (AML) 模型来扩展 AI 扩充。 在训练和部署 AML 模型后，AML 技能即可将其集成到 AI 扩充中。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Custom.AmlSkill	指定技能类型的 URI 片段。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
degreeOfParallelism	integer	（可选）如果指定了此值，则指示索引器将对你提供的终结点进行的并行调用数。 如果终结点在请求负载过高的情况下失败，则可以减小此值；如果终结点能够接受更多请求并且希望提高索引器的性能，则可以增大此值。 如果未设置，则将使用默认值 5。 可以为 degreeOfParallelism 设置的最大值为 10，最小值为 1。
description	string	技能的说明，描述技能的输入、输出和用法。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
key	string	（密钥身份验证需要）AML 服务的密钥。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。
region	string	（对于令牌身份验证可选）。 AML 服务部署到的区域。
resourceId	string	（令牌身份验证需要）。 AML 服务的 Azure 资源管理器资源 ID。 它的格式应如下所示：subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}。
timeout	string	（可选）如果指定，表明执行 API 调用的 http 客户端的超时值。
uri	string	（不进行身份验证或密钥身份验证需要）JSON 有效负载将发送到的 AML 服务的评分 URI。 仅支持 https URI 方案。

AzureActiveDirectoryApplicationCredentials

为搜索服务创建的已注册应用程序的凭据，用于对 Azure 密钥保管库中存储的加密密钥的身份验证访问。

名称	类型	说明
applicationId	string	一个 AAD 应用程序 ID，该 ID 授予了对 Azure 密钥保管库所需的访问权限，该权限将在加密静态数据时使用。 应用程序 ID 不应与 AAD 应用程序的对象 ID 混淆。
applicationSecret	string	指定 AAD 应用程序的身份验证密钥。

AzureOpenAIEmbeddingSkill

允许使用 Azure OpenAI 资源为给定文本输入生成矢量嵌入。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	指定技能类型的 URI 片段。
apiKey	string	指定 Azure OpenAI 资源的 API 密钥。
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	用于出站连接的用户分配的托管标识。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
deploymentId	string	指定资源上 Azure OpenAI 模型部署的 ID。
description	string	技能的说明，描述技能的输入、输出和用法。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。
resourceUri	string	Azure OpenAI 资源的资源 URI。

CognitiveServicesAccountKey

附加到技能组的 Azure AI 服务资源的多区域帐户密钥。

名称	类型	说明
@odata.type	string: #Microsoft.Azure.Search.CognitiveServicesByKey	指定附加到技能组的 Azure AI 服务资源类型的 URI 片段。
description	string	附加到技能组的 Azure AI 服务资源的说明。
key	string	用于预配附加到技能组的 Azure AI 服务资源的密钥。

ConditionalSkill

一种技能，使需要布尔运算来确定要分配给输出的数据的方案。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Util.ConditionalSkill	指定技能类型的 URI 片段。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
description	string	技能的说明，描述技能的输入、输出和用法。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。

CustomEntity

一个 对象，该对象包含有关找到的匹配项和相关元数据的信息。

名称	类型	说明
accentSensitive	boolean	默认为 false。 指示与实体名称的比较是否应区分重音的布尔值。
aliases	CustomEntityAlias[]	复杂对象的数组，可用于指定根实体名称的替代拼写或同义词。
caseSensitive	boolean	默认为 false。 一个布尔值，表示在与实体名称进行比较时是否应区分字符大小写。 “Microsoft”不区分大小写的示例匹配项可以是：microsoft、microSoft、MICROSOFT。
defaultAccentSensitive	boolean	更改此实体的默认重音敏感度值。 它用于更改所有别名 accentSensitive 值的默认值。
defaultCaseSensitive	boolean	更改此实体的默认区分大小写值。 它用于更改所有别名 caseSensitive 值的默认值。
defaultFuzzyEditDistance	integer	更改此实体的默认模糊编辑距离值。 它可用于更改所有别名 fuzzyEditDistance 值的默认值。
description	string	此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。
fuzzyEditDistance	integer	默认值为 0。 最大值为 5。 表示仍看作与实体名称匹配的可接受分歧字符数。 将返回任意给定匹配项的最小可能模糊匹配数。 例如，如果编辑距离设置为 3，则“Windows10”仍将匹配“Windows”、“Windows10”和“Windows 7”。 如果区分大小写设置为 false，则大小写差异不会计入模糊匹配容差；否则会计入。
id	string	此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。
name	string	顶级实体描述符。 技能输出中的匹配项将按此名称分组，此名称应表示所找到的文本的“规范化”形式。
subtype	string	此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。
type	string	此字段可用作有关匹配文本 () 的自定义元数据的传递。 此字段的值将连同其在技能输出中的实体的每个匹配项一起显示。

CustomEntityAlias

一个复杂对象，可用于指定根实体名称的替代拼写或同义词。

名称	类型	说明
accentSensitive	boolean	确定别名是否区分重音。
caseSensitive	boolean	确定别名是否区分大小写。
fuzzyEditDistance	integer	确定别名的模糊编辑距离。
text	string	别名的文本。

CustomEntityLookupSkill

技能从用户定义的自定义字词和短语列表中查找文本。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Text.CustomEntityLookupSkill	指定技能类型的 URI 片段。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
defaultLanguageCode	CustomEntityLookupSkillLanguage	一个值，该值指示要使用的语言代码。 默认为 en。
description	string	技能的说明，描述技能的输入、输出和用法。
entitiesDefinitionUri	string	JSON 或 CSV 文件的路径，该文件包含要匹配的所有目标文本。 此实体定义在索引器运行开始时读取。 索引器运行期间对此文件的任何更新在后续运行之前不会生效。 必须可以通过 HTTPS 访问此配置。
globalDefaultAccentSensitive	boolean	AccentSensitive 的全局标志。 如果未在 CustomEntity 中设置 AccentSensitive，则此值将是默认值。
globalDefaultCaseSensitive	boolean	CaseSensitive 的全局标志。 如果未在 CustomEntity 中设置 CaseSensitive，此值将是默认值。
globalDefaultFuzzyEditDistance	integer	FuzzyEditDistance 的全局标志。 如果未在 CustomEntity 中设置 FuzzyEditDistance，则此值将是默认值。
inlineEntitiesDefinition	CustomEntity[]	内联 CustomEntity 定义。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。

CustomEntityLookupSkillLanguage

CustomEntityLookupSkill 支持的输入文本的语言代码。

名称	类型	说明
da	string	丹麦语
de	string	德语
en	string	英语
es	string	西班牙语
fi	string	芬兰语
fr	string	法语
it	string	意大利语
ko	string	朝鲜语
pt	string	葡萄牙语

DefaultCognitiveServicesAccount

一个空对象，表示技能组的默认 Azure AI 服务资源。

名称	类型	说明
@odata.type	string: #Microsoft.Azure.Search.DefaultCognitiveServices	指定附加到技能组的 Azure AI 服务资源类型的 URI 片段。
description	string	附加到技能组的 Azure AI 服务资源的说明。

DocumentExtractionSkill

一种技能，用于从扩充管道中的文件中提取内容。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Util.DocumentExtractionSkill	指定技能类型的 URI 片段。
configuration	object	技能配置字典。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
dataToExtract	string	要为技能提取的数据类型。 如果未定义，则将设置为“contentAndMetadata”。
description	string	技能的说明，描述技能的输入、输出和用法。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。
parsingMode	string	技能的 parsingMode。 如果未定义，则将设置为“default”。

EntityCategory

一个字符串，指示要返回的实体类别。

名称	类型	说明
datetime	string	描述日期和时间的实体。
email	string	描述电子邮件地址的实体。
location	string	描述物理位置的实体。
organization	string	描述组织的实体。
person	string	描述人员的实体。
quantity	string	描述数量的实体。
url	string	描述 URL 的实体。

EntityLinkingSkill

使用 文本分析 API 从文本中提取链接实体。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Text.V3.EntityLinkingSkill	指定技能类型的 URI 片段。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
defaultLanguageCode	string	一个值，该值指示要使用的语言代码。 默认为 en。
description	string	技能的说明，描述技能的输入、输出和用法。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
minimumPrecision	number	介于 0 和 1 之间的值，用于仅包含置信度分数大于指定值的实体。 如果未设置 (默认) ，或者显式设置为 null，则将包含所有实体。
modelVersion	string	调用 文本分析 服务时要使用的模型版本。 如果未指定，将默认为最新可用版本。 建议不要指定此值，除非绝对必要。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。

EntityRecognitionSkill

此技能已弃用。 使用 V3。改为 EntityRecognitionSkill。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Text.EntityRecognitionSkill	指定技能类型的 URI 片段。
categories	EntityCategory[]	应提取的实体类别的列表。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
defaultLanguageCode	EntityRecognitionSkillLanguage	一个值，该值指示要使用的语言代码。 默认为 en。
description	string	技能的说明，描述技能的输入、输出和用法。
includeTypelessEntities	boolean	确定是否包括已知但不符合预定义类型的实体。 如果未将此配置 (默认) 、设置为 null 或设置为 false，则不会显示不符合预定义类型之一的实体。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
minimumPrecision	number	介于 0 和 1 之间的值，用于仅包含置信度分数大于指定值的实体。 如果未设置 (默认) ，或者显式设置为 null，则将包含所有实体。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。

EntityRecognitionSkillLanguage

已弃用。 EntityRecognitionSkill 支持的输入文本的语言代码。

名称	类型	说明
ar	string	阿拉伯语
cs	string	捷克语
da	string	丹麦语
de	string	德语
el	string	希腊语
en	string	英语
es	string	西班牙语
fi	string	芬兰语
fr	string	法语
hu	string	匈牙利语
it	string	意大利语
ja	string	日语
ko	string	韩语
nl	string	荷兰语
no	string	挪威语 (博克马尔语)
pl	string	波兰语
pt-BR	string	葡萄牙语（巴西）
pt-PT	string	葡萄牙语(葡萄牙)
ru	string	俄语
sv	string	瑞典语
tr	string	土耳其语
zh-Hans	string	简体中文
zh-Hant	string	繁体中文

EntityRecognitionSkillV3

使用 文本分析 API 从文本中提取不同类型的实体。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Text.V3.EntityRecognitionSkill	指定技能类型的 URI 片段。
categories	string[]	应提取的实体类别的列表。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
defaultLanguageCode	string	一个值，该值指示要使用的语言代码。 默认为 en。
description	string	技能的说明，描述技能的输入、输出和用法。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
minimumPrecision	number	介于 0 和 1 之间的值，用于仅包含置信度分数大于指定值的实体。 如果未设置 (默认) ，或者显式设置为 null，则将包含所有实体。
modelVersion	string	调用 文本分析 API 时要使用的模型版本。 如果未指定，将默认为最新可用版本。 建议不要指定此值，除非绝对必要。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。

ImageAnalysisSkill

分析图像文件的技能。 它基于图像内容提取一组丰富的视觉特征。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Vision.ImageAnalysisSkill	指定技能类型的 URI 片段。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
defaultLanguageCode	ImageAnalysisSkillLanguage	一个值，该值指示要使用的语言代码。 默认为 en。
description	string	技能的说明，描述技能的输入、输出和用法。
details	ImageDetail[]	一个字符串，指示要返回哪些特定于域的详细信息。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。
visualFeatures	VisualFeature[]	视觉特征列表。

ImageAnalysisSkillLanguage

ImageAnalysisSkill 支持输入的语言代码。

名称	类型	说明
ar	string	阿拉伯语
az	string	阿塞拜疆语
bg	string	保加利亚语
bs	string	波斯尼亚语（拉丁语系）
ca	string	加泰罗尼亚语
cs	string	捷克语
cy	string	威尔士语
da	string	丹麦语
de	string	德语
el	string	希腊语
en	string	英语
es	string	西班牙语
et	string	爱沙尼亚语
eu	string	巴斯克语
fi	string	芬兰语
fr	string	法语
ga	string	爱尔兰语
gl	string	加利西亚语
he	string	希伯来语
hi	string	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	塞尔维亚语 - 西里尔语
sr-Latn	string	塞尔维亚语 - 拉丁语
sv	string	瑞典语
th	string	泰语
tr	string	土耳其语
uk	string	乌克兰语
vi	string	越南语
zh	string	简体中文
zh-Hans	string	简体中文
zh-Hant	string	中文(繁体)

ImageDetail

一个字符串，指示要返回哪些特定于域的详细信息。

名称	类型	说明
celebrities	string	识别为名人的详细信息。
landmarks	string	识别为地标的详细信息。

IndexProjectionMode

定义相对于索引器其余部分的索引投影的行为。

名称	类型	说明
includeIndexingParentDocuments	string	源文档将写入索引器的目标索引中。 这是默认模式。
skipIndexingParentDocuments	string	源文档将跳过写入索引器的目标索引。

InputFieldMappingEntry

技能的输入字段映射。

名称	类型	说明
inputs	InputFieldMappingEntry[]	创建复杂类型时使用的递归输入。
name	string	输入的名称。
source	string	输入的源。
sourceContext	string	用于选择递归输入的源上下文。

KeyPhraseExtractionSkill

使用文本分析提取关键短语的技能。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Text.KeyPhraseExtractionSkill	指定技能类型的 URI 片段。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
defaultLanguageCode	KeyPhraseExtractionSkillLanguage	一个值，该值指示要使用的语言代码。 默认为 en。
description	string	技能的说明，描述技能的输入、输出和用法。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
maxKeyPhraseCount	integer	一个数字，指示要返回的关键短语数。 如果不存在，将返回所有标识的关键短语。
modelVersion	string	调用 文本分析 服务时要使用的模型版本。 如果未指定，将默认为最新可用版本。 建议不要指定此值，除非绝对必要。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。

KeyPhraseExtractionSkillLanguage

KeyPhraseExtractionSkill 支持的输入文本的语言代码。

名称	类型	说明
da	string	丹麦语
de	string	德语
en	string	英语
es	string	西班牙语
fi	string	芬兰语
fr	string	法语
it	string	意大利语
ja	string	日语
ko	string	韩语
nl	string	荷兰语
no	string	挪威语 (博克马尔语)
pl	string	波兰语
pt-BR	string	葡萄牙语（巴西）
pt-PT	string	葡萄牙语(葡萄牙)
ru	string	俄语
sv	string	瑞典语

LanguageDetectionSkill

一种技能，用于检测输入文本的语言，并为请求中提交的每个文档报告单个语言代码。 语言代码与指示分析置信度分数配对。

名称	类型	说明
@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”。

名称	类型	说明
carriageReturn	string	行由回车符 ('\r') 字符分隔。
carriageReturnLineFeed	string	行由回车符和换行符分隔 ('\r\n') 字符。
lineFeed	string	行由单个换行符 ('\n') 字符分隔。
space	string	行由单个空格字符分隔。

MergeSkill

一种技能，用于将两个或多个字符串合并为单个统一字符串，并使用可选的用户定义的分隔符分隔每个组件部分。

名称	类型	默认值	说明
@odata.type	string: #Microsoft.Skills.Text.MergeSkill		指定技能类型的 URI 片段。
context	string		表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
description	string		技能的说明，描述技能的输入、输出和用法。
inputs	InputFieldMappingEntry[]		技能的输入可以是源数据集中的列，也可以是上游技能的输出。
insertPostTag	string		标记指示合并文本的末尾。 默认情况下，标记是一个空白区域。
insertPreTag	string		标记指示合并文本的开头。 默认情况下，标记是一个空白区域。
name	string		在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]		技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。

OcrSkill

一种从图像文件中提取文本的技能。

名称	类型	默认值	说明
@odata.type	string: #Microsoft.Skills.Vision.OcrSkill		指定技能类型的 URI 片段。
context	string		表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
defaultLanguageCode	OcrSkillLanguage		一个值，该值指示要使用的语言代码。 默认为 en。
description	string		技能的说明，描述技能的输入、输出和用法。
detectOrientation	boolean	False	一个值，该值指示打开或不打开方向检测。 默认值为 false。
inputs	InputFieldMappingEntry[]		技能的输入可以是源数据集中的列，也可以是上游技能的输出。
lineEnding	LineEnding		定义要在 OCR 技能识别的文本行之间使用的字符序列。 默认值为“space”。
name	string		在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]		技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。

OcrSkillLanguage

OcrSkill 输入支持的语言代码。

名称	类型	说明
Jns	string	贾恩萨里语（天城文）
af	string	南非荷兰语
anp	string	昂加语（天城文）
ar	string	阿拉伯语
ast	string	阿斯图里亚斯语
awa	string	阿瓦德语-印地语（天城文）
az	string	阿塞拜疆语(拉丁语)
be	string	白俄罗斯 (西里尔文和拉丁文)
be-cyrl	string	白俄罗斯语(西里尔语)
be-latn	string	白俄罗斯语(拉丁语)
bfy	string	巴格里语
bfz	string	玛哈苏帕哈里（天城文）
bg	string	保加利亚语
bgc	string	哈里亚维
bho	string	博杰普尔语-印地语（天城文）
bi	string	比斯拉马语
bns	string	本德利语
br	string	布列塔尼语
bra	string	布拉伊巴语
brx	string	博多语（天城文）
bs	string	波斯尼亚语（拉丁语系）
bua	string	布里亚特语(西里尔语)
ca	string	加泰罗尼亚语
ceb	string	宿雾语
ch	string	查莫罗语
cnr-cyrl	string	蒙特内哥罗语(西里尔语)
cnr-latn	string	蒙特内哥罗语(拉丁语)
co	string	柯西嘉语
crh	string	克里米亚鞑靼语（拉丁语）
cs	string	捷克语
csb	string	卡舒比语
cy	string	威尔士语
da	string	丹麦语
de	string	德语
dhi	string	迪马尔语（天城文）
doi	string	多格拉语（天城文）
dsb	string	下索布语
el	string	希腊语
en	string	英语
es	string	西班牙语
et	string	爱沙尼亚语
eu	string	巴斯克语
fa	string	波斯语
fi	string	芬兰语
fil	string	菲律宾语
fj	string	斐济语
fo	string	法罗语
fr	string	法语
fur	string	弗鲁里安语
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	霍· (·德瓦纳吉里·)
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	梵文 (德瓦纳吉里)
sat	string	桑塔利 (德瓦纳吉里)
sck	string	萨德里语（天城文）
sco	string	苏格兰语
sk	string	斯洛伐克语
sl	string	斯洛文尼亚语
sm	string	萨摩亚语(拉丁语)
sma	string	南萨米语
sme	string	北萨米语(拉丁语)
smj	string	律勒萨米语
smn	string	伊纳里萨米语
sms	string	斯科特萨米语
so	string	索马里语（阿拉伯语）
sq	string	阿尔巴尼亚语
sr	string	塞尔维亚语（拉丁）
sr-Cyrl	string	塞尔维亚语（西里尔）
sr-Latn	string	塞尔维亚语（拉丁）
srx	string	西尔毛里语（天城文）
sv	string	瑞典语
sw	string	斯瓦希里语（拉丁语）
tet	string	德顿语
tg	string	塔吉克语(西里尔文)
thf	string	汤米语
tk	string	土库曼语(拉丁语)
to	string	汤加语
tr	string	土耳其语
tt	string	鞑靼语（拉丁语）
tyv	string	图瓦语
ug	string	维吾尔语（阿拉伯语）
unk	string	未知 (所有)
ur	string	乌尔都语
uz	string	乌兹别克语(拉丁文)
uz-arab	string	乌兹别克语（阿拉伯语）
uz-cyrl	string	乌兹别克语(西里尔文)
vo	string	沃拉普克语
wae	string	瓦尔瑟语
xnr	string	康格里语（天城文）
xsr	string	夏尔巴语（天城文）
yua	string	尤卡坦玛雅语
za	string	壮语
zh-Hans	string	简体中文
zh-Hant	string	中文(繁体)
zu	string	祖鲁语

OutputFieldMappingEntry

技能的输出字段映射。

名称	类型	说明
name	string	技能定义的输出的名称。
targetName	string	输出的目标名称。 它是可选的，默认为 name。

PIIDetectionSkill

使用 文本分析 API，从输入文本中提取个人信息，并提供屏蔽信息的选项。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Text.PIIDetectionSkill	指定技能类型的 URI 片段。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
defaultLanguageCode	string	一个值，该值指示要使用的语言代码。 默认为 en。
description	string	技能的说明，描述技能的输入、输出和用法。
domain	string	如果指定，则会将 PII 域设置为仅包含实体类别的子集。 可能的值包括：“phi”、“none”。 默认值为“none”。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
maskingCharacter	string	如果 maskingMode 参数设置为替换，则用于屏蔽文本的字符。 默认值为“*”。
maskingMode	PIIDetectionSkillMaskingMode	一个参数，提供各种方法来屏蔽在输入文本中检测到的个人信息。 默认值为“none”。
minimumPrecision	number	介于 0 和 1 之间的值，用于仅包含置信度分数大于指定值的实体。 如果未设置 (默认) ，或者显式设置为 null，则将包含所有实体。
modelVersion	string	调用 文本分析 服务时要使用的模型版本。 如果未指定，将默认为最新可用版本。 建议不要指定此值，除非绝对必要。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。
piiCategories	string[]	应提取和屏蔽的 PII 实体类别列表。

PIIDetectionSkillMaskingMode

一个字符串，指示用于屏蔽输入文本中检测到的个人信息的 maskingMode。

名称	类型	说明
none	string	不会发生掩码，并且不会返回 maskedText 输出。
replace	string	将检测到的实体替换为 maskingCharacter 参数中给定的字符。 字符将重复到检测到的实体的长度，以便偏移量正确对应于输入文本和输出 maskedText。

SearchError

描述 API 的错误条件。

名称	类型	说明
code	string	服务器定义的一组错误代码中的一个。
details	SearchError[]	有关导致此项报告错误的特定错误的详细信息数组。
message	string	错误的用户可读表示形式。

SearchIndexerDataNoneIdentity

清除数据源的标识属性。

名称	类型	说明
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	指定标识类型的 URI 片段。

SearchIndexerDataUserAssignedIdentity

指定要使用的数据源的标识。

名称	类型	说明
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	指定标识类型的 URI 片段。
userAssignedIdentity	string	用户分配托管标识的完全限定的 Azure 资源 ID 通常采用“/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId”格式，应已分配给搜索服务。

SearchIndexerIndexProjections

定义辅助搜索索引的其他投影。

名称	类型	说明
parameters	SearchIndexerIndexProjectionsParameters	索引投影特定配置属性的字典。 每个名称都是特定属性的名称。 每个值都必须是基元类型。
selectors	SearchIndexerIndexProjectionSelector[]	要对辅助搜索索引执行的投影列表。

SearchIndexerIndexProjectionSelector

在指定的搜索索引中存储哪些数据的说明。

名称	类型	说明
mappings	InputFieldMappingEntry[]	投影的映射，或者应将哪个源映射到目标索引中的哪个字段。
parentKeyFieldName	string	搜索索引中要将父文档的键值映射到的字段的名称。 必须是可筛选的字符串字段，而不是键字段。
sourceContext	string	投影的源上下文。 表示将文档拆分为多个子文档的基数。
targetIndexName	string	要投影到的搜索索引的名称。 必须具有具有“关键字 (keyword) ”分析器集的键字段。

SearchIndexerIndexProjectionsParameters

索引投影特定配置属性的字典。 每个名称都是特定属性的名称。 每个值都必须是基元类型。

名称	类型	说明
projectionMode	IndexProjectionMode	定义索引投影相对于索引器其余部分的行为。

SearchIndexerKnowledgeStore

定义扩充数据的 Azure Blob、表或文件的其他投影。

名称	类型	说明
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	编写知识存储投影时用于连接到 Azure 存储的用户分配的托管标识。 如果连接字符串指示 ResourceId) (标识，并且未指定，则使用系统分配的托管标识。 更新索引器时，如果标识未指定，则该值保持不变。 如果设置为“none”，则清除此属性的值。
parameters	SearchIndexerKnowledgeStoreParameters	特定于知识存储的配置属性的字典。 每个名称都是特定属性的名称。 每个值都必须是基元类型。
projections	SearchIndexerKnowledgeStoreProjection[]	索引编制期间要执行的其他投影的列表。
storageConnectionString	string	存储帐户投影连接字符串将存储在 中。

SearchIndexerKnowledgeStoreFileProjectionSelector

要存储在 Azure 文件存储 中的数据的投影定义。

名称	类型	说明
generatedKeyName	string	要存储投影的生成密钥的名称。
inputs	InputFieldMappingEntry[]	复杂投影的嵌套输入。
referenceKeyName	string	不同投影的引用键的名称。
source	string	要投影的源数据。
sourceContext	string	复杂投影的源上下文。
storageContainer	string	要存储投影的 Blob 容器。

SearchIndexerKnowledgeStoreObjectProjectionSelector

要存储在 Azure Blob 中的数据的投影定义。

名称	类型	说明
generatedKeyName	string	要存储投影的生成密钥的名称。
inputs	InputFieldMappingEntry[]	复杂投影的嵌套输入。
referenceKeyName	string	不同投影的引用键的名称。
source	string	要投影的源数据。
sourceContext	string	复杂投影的源上下文。
storageContainer	string	要存储投影的 Blob 容器。

SearchIndexerKnowledgeStoreParameters

特定于知识存储的配置属性的字典。 每个名称都是特定属性的名称。 每个值都必须是基元类型。

名称	类型	默认值	说明
synthesizeGeneratedKeyName	boolean	False	投影是否应合成生成的键名称（如果不存在）。

SearchIndexerKnowledgeStoreProjection

各种投影选择器的容器对象。

名称	类型	说明
files	SearchIndexerKnowledgeStoreFileProjectionSelector[]	投影到 Azure 文件存储。
objects	SearchIndexerKnowledgeStoreObjectProjectionSelector[]	投影到 Azure Blob 存储。
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: CognitiveServicesAccountKey DefaultCognitiveServicesAccount	有关运行技能时要使用的 Azure AI 服务的详细信息。
description	string	技能组的说明。
encryptionKey	SearchResourceEncryptionKey	在 Azure 密钥保管库 中创建的加密密钥的说明。 当你希望完全保证没有人（甚至 Microsoft）无法解密技能组定义时，此密钥用于为技能组定义提供额外的静态加密级别。 加密技能组定义后，该定义将始终保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果要轮换加密密钥，可以根据需要更改此属性;技能组定义将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于 2019 年 1 月 1 日或之后创建的付费服务。
indexProjections	SearchIndexerIndexProjections	定义辅助搜索索引的其他投影 (es) 。
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 密钥保管库中客户管理的加密密钥。 创建和管理的密钥可用于加密或解密静态数据，例如索引和同义词映射。

名称	类型	说明
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。情绪技能相反。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Text.SentimentSkill	指定技能类型的 URI 片段。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
defaultLanguageCode	SentimentSkillLanguage	一个值，该值指示要使用的语言代码。 默认为 en。
description	string	技能的说明，描述技能的输入、输出和用法。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。

SentimentSkillLanguage

已弃用。 SentimentSkill 支持的输入文本的语言代码。

名称	类型	说明
da	string	丹麦语
de	string	德语
el	string	希腊语
en	string	英语
es	string	西班牙语
fi	string	芬兰语
fr	string	法语
it	string	意大利语
nl	string	荷兰语
no	string	挪威语 (博克马尔语)
pl	string	波兰语
pt-PT	string	葡萄牙语（葡萄牙）
ru	string	俄语
sv	string	瑞典语
tr	string	土耳其语

SentimentSkillV3

使用 文本分析 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，则技能输出将包含用于观点挖掘文本分析的信息，即 (名词或动词) 及其相关评估 (文本中的形容词) 。 默认值为 false。
inputs	InputFieldMappingEntry[]		技能的输入可以是源数据集中的列，也可以是上游技能的输出。
modelVersion	string		调用 文本分析 服务时要使用的模型版本。 如果未指定，将默认为最新可用版本。 建议不要指定此值，除非绝对必要。
name	string		在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]		技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。

ShaperSkill

用于重塑输出的技能。 它创建一个复杂类型以支持复合字段 (也称为多部分字段) 。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Util.ShaperSkill	指定技能类型的 URI 片段。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
description	string	技能的说明，描述技能的输入、输出和用法。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。

SplitSkill

将字符串拆分为文本块的技能。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Text.SplitSkill	指定技能类型的 URI 片段。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
defaultLanguageCode	SplitSkillLanguage	一个值，该值指示要使用的语言代码。 默认为 en。
description	string	技能的说明，描述技能的输入、输出和用法。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
maximumPageLength	integer	所需的最大页长度。 默认值为 10000。
maximumPagesToTake	integer	仅当 textSplitMode 设置为“pages”时适用。 如果指定，SplitSkill 将在处理第一个“maximumPagesToTake”页面后停止拆分，以便在每个文档只需要几个初始页面时提高性能。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。
pageOverlapLength	integer	仅当 textSplitMode 设置为“pages”时适用。 如果指定，第 n+1 个区块将从第 n 个区块的末尾开始以此数量的字符/令牌开头。
textSplitMode	TextSplitMode	指示要执行的拆分模式的值。

SplitSkillLanguage

SplitSkill 支持的输入文本的语言代码。

名称	类型	说明
am	string	阿姆哈拉语
bs	string	波斯尼亚语
cs	string	捷克语
da	string	丹麦语
de	string	德语
en	string	英语
es	string	西班牙语
et	string	爱沙尼亚语
fi	string	芬兰语
fr	string	法语
he	string	希伯来语
hi	string	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

一个 值，该值指示要执行的拆分模式。

名称	类型	说明
pages	string	将文本拆分为单独的页面。
sentences	string	将文本拆分为单独的句子。

TextTranslationSkill

将文本从一种语言翻译到另一种语言的技能。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Text.TranslationSkill	指定技能类型的 URI 片段。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
defaultFromLanguageCode	TextTranslationSkillLanguage	对于未显式指定 from 语言的文档，要从中翻译文档的语言代码。
defaultToLanguageCode	TextTranslationSkillLanguage	对于未显式指定语言的文档，用于将文档转换为的语言代码。
description	string	技能的说明，描述技能的输入、输出和用法。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。
suggestedFrom	TextTranslationSkillLanguage	当未提供 fromLanguageCode 输入和 defaultFromLanguageCode 参数且自动语言检测失败时，要从中翻译文档的语言代码。 默认为 en。

TextTranslationSkillLanguage

TextTranslationSkill 支持的输入文本的语言代码。

名称	类型	说明
af	string	南非荷兰语
ar	string	阿拉伯语
bg	string	保加利亚语
bn	string	Bangla
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	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	克林贡语 (拉丁语脚本)
tlh-Piqd	string	Klingon (Klingon 脚本)
to	string	汤加语
tr	string	土耳其语
ty	string	塔希提语
uk	string	乌克兰语
ur	string	乌尔都语
vi	string	越南语
yua	string	尤卡坦玛雅语
yue	string	粤语(繁体)
zh-Hans	string	简体中文
zh-Hant	string	中文(繁体)

VisualFeature

指示要返回的视觉特征类型的字符串。

名称	类型	说明
adult	string	识别为成人的视觉特征。
brands	string	识别为商业品牌的视觉特征。
categories	string	类别。
description	string	说明。
faces	string	识别为人脸的视觉特征。
objects	string	识别为对象的视觉特征。
tags	string	标记。

WebApiSkill

一种可以调用 Web API 终结点的技能，允许你通过调用自定义代码来扩展技能集。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Custom.WebApiSkill	指定技能类型的 URI 片段。
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	用于出站连接的用户分配的托管标识。 如果提供了 authResourceId 但未指定，则使用系统分配的托管标识。 更新索引器时，如果标识未指定，则该值保持不变。 如果设置为“none”，则清除此属性的值。
authResourceId	string	适用于连接到 Azure 函数中的外部代码或提供转换的其他某些应用程序的自定义技能。 此值应该是在向 Azure Active Directory 注册函数或应用时为其创建的应用程序 ID。 指定后，自定义技能使用托管 ID 连接到函数或应用， (系统或用户分配的搜索服务) 以及函数或应用的访问令牌，使用此值作为资源 ID 来创建访问令牌的范围。
batchSize	integer	指示文档数的所需批大小。
context	string	表示执行操作的级别，例如文档根或文档内容 (例如 /document 或 /document/content) 。 默认值为 /document。
degreeOfParallelism	integer	如果设置，则表示可以对 Web API 进行的并行调用数。
description	string	技能的说明，描述技能的输入、输出和用法。
httpHeaders	object	发出 http 请求所需的标头。
httpMethod	string	http 请求的 方法。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
name	string	在技能集中唯一标识技能的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是另一个技能可以用作输入的值。
timeout	string	请求的所需超时。 默认值为 30 秒。
uri	string	Web API 的 URL。