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

Skillsets - Get

服务:: Search Service

API 版本:: 2024-03-01-Preview

检索搜索服务中的技能集。

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

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	搜索服务的终结点 URL。
skillsetName	path	True	string	要检索的技能集的名称。
api-version	query	True	string	客户端 API 版本。

请求头

名称	必需	类型	说明
x-ms-client-request-id		string (uuid)	随请求一起发送的跟踪 ID，以帮助进行调试。

响应

名称	类型	说明
200 OK	SearchIndexerSkillset	已成功返回技能集。
Other Status Codes	ErrorResponse	错误响应。

示例

SearchServiceGetSkillset

示例请求

HTTP

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

示例响应

状态代码:: 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": "myKeyName",
    "keyVaultKeyVersion": "myKeyVersion",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": null
    }
  }
}

定义

名称	说明
AmlSkill	借助 AML 技能，可以使用自定义 Azure 机器学习（AML）模型扩展 AI 扩充。训练和部署 AML 模型后，AML 技能将其集成到 AI 扩充中。
AzureActiveDirectoryApplicationCredentials	为搜索服务创建的已注册应用程序的凭据，用于对 Azure Key Vault 中存储的加密密钥进行身份验证的访问权限。
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 从文本中提取不同类型的实体。
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 中的数据的投影定义。
SearchIndexerKnowledgeStoreParameters	特定于知识存储的配置属性的字典。每个名称都是特定属性的名称。每个值都必须是基元类型。
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 终结点的技能，允许你通过调用自定义代码来扩展技能集。

AmlSkill

对象

借助 AML 技能，可以使用自定义 Azure 机器学习（AML）模型扩展 AI 扩充。训练和部署 AML 模型后，AML 技能将其集成到 AI 扩充中。

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Custom.AmlSkill	指定技能类型的 URI 片段。
context	string	表示执行操作的级别，例如文档根或文档内容（例如 /document 或 /document/content）。默认值为 /document。
degreeOfParallelism	integer (int32)	（可选）指定时，指示索引器将与提供的终结点并行执行的调用数。如果终结点在请求负载过高的情况下失败，或者如果终结点能够接受更多请求，并且希望提高索引器的性能，则可以降低此值。如果未设置，则将使用默认值 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 (duration)	（可选）如果指定，表明执行 API 调用的 http 客户端的超时值。
uri	string (uri)	（无需身份验证或密钥身份验证）要向其发送 JSON 有效负载的 AML 服务的评分 URI。仅允许 https URI 方案。

AzureActiveDirectoryApplicationCredentials

对象

为搜索服务创建的已注册应用程序的凭据，用于对 Azure Key Vault 中存储的加密密钥进行身份验证的访问权限。

名称	类型	说明
applicationId	string	向 AAD 应用程序 ID 授予对静态数据加密时要使用的 Azure Key Vault 所需的访问权限。应用程序 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 (uri)	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	更改此实体的默认重音敏感度值。它用于更改所有别名区分重音值的默认值。
defaultCaseSensitive	boolean	更改此实体的默认区分大小写值。它用于更改所有别名 caseSensitive 值的默认值。
defaultFuzzyEditDistance	integer (int32)	更改此实体的默认模糊编辑距离值。它可用于更改所有别名模糊EditDistance 值的默认值。
description	string	此字段可用作有关匹配文本的自定义元数据的传递。此字段的值将与技能输出中实体的每个匹配项一起显示。
fuzzyEditDistance	integer (int32)	默认值为 0。最大值为 5。表示仍构成与实体名称匹配的可接受不同字符数。返回任何给定匹配项的最小可能模糊。例如，如果编辑距离设置为 3，“Windows10”仍将匹配“Windows”、“Windows10”和“Windows 7”。当区分大小写设置为 false 时，大小写差异不计入模糊容忍度，否则则这样做。
id	string	此字段可用作有关匹配文本的自定义元数据的传递。此字段的值将与技能输出中实体的每个匹配项一起显示。
name	string	顶级实体描述符。技能输出中的匹配项将按此名称进行分组，它应表示所找到文本的“规范化”形式。
subtype	string	此字段可用作有关匹配文本的自定义元数据的传递。此字段的值将与技能输出中实体的每个匹配项一起显示。
type	string	此字段可用作有关匹配文本的自定义元数据的传递。此字段的值将与技能输出中实体的每个匹配项一起显示。

CustomEntityAlias

对象

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

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

CustomEntityLookupSkill

对象

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

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

CustomEntityLookupSkillLanguage

枚举

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

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

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

枚举

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

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

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 (double) minimum: 0 maximum: 1	一个介于 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 (double)	一个介于 0 和 1 之间的值，该值仅用于包含其置信度分数大于指定值的实体。如果未设置（默认值），或者显式设置为 null，则将包括所有实体。
name	string	唯一标识技能集内的技能的名称。未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，其前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出是搜索索引中的字段，或者是另一个技能可以用作输入的值。

EntityRecognitionSkillLanguage

枚举

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

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

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 (double) minimum: 0 maximum: 1	一个介于 0 和 1 之间的值，该值仅用于包含其置信度分数大于指定值的实体。如果未设置（默认值），或者显式设置为 null，则将包括所有实体。
modelVersion	string	调用文本分析 API 时要使用的模型版本。如果未指定，它将默认为最新可用。除非绝对必要，否则建议不要指定此值。
name	string	唯一标识技能集内的技能的名称。未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，其前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出是搜索索引中的字段，或者是另一个技能可以用作输入的值。

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ImageAnalysisSkill

对象

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

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

ImageAnalysisSkillLanguage

枚举

ImageAnalysisSkill 支持的输入语言代码。

值	说明
ar	阿拉伯语
az	阿塞拜疆语
bg	保加利亚语
bs	波斯尼亚拉丁语
ca	加泰隆语
cs	捷克语
cy	威尔士语
da	丹麦语
de	德语
el	希腊语
en	英语
es	西班牙语
et	爱沙尼亚语
eu	巴斯克语
fi	芬兰语
fr	法语
ga	爱尔兰语
gl	加利西亚语
he	希伯来语
hi	印地语
hr	克罗地亚语
hu	匈牙利语
id	印度尼西亚语
it	意大利语
ja	日语
kk	哈萨克语
ko	朝鲜语
lt	立陶宛语
lv	拉脱维亚语
mk	马其顿语
ms	马来西亚马来语
nb	挪威语（博克马尔）
nl	荷兰语
pl	波兰语
prs	达里语
pt-BR	葡萄牙语 - 巴西
pt	葡萄牙语 - 葡萄牙
pt-PT	葡萄牙语 - 葡萄牙
ro	罗马尼亚语
ru	俄语
sk	斯洛伐克语
sl	斯洛文尼亚语
sr-Cyrl	塞尔维亚语 - 西里尔文 RS
sr-Latn	塞尔维亚语 - 拉丁语 RS
sv	瑞典语
th	泰语
tr	土耳其语
uk	乌克兰语
vi	越南语
zh	简体中文
zh-Hans	简体中文
zh-Hant	中文（繁体）

ImageDetail

枚举

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

值	说明
celebrities	被识别为名人的详细信息。
landmarks	识别为地标的详细信息。

IndexProjectionMode

枚举

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

值	说明
skipIndexingParentDocuments	源文档将从写入索引器的目标索引中跳过。
includeIndexingParentDocuments	源文档将写入索引器的目标索引中。这是默认模式。

InputFieldMappingEntry

对象

技能的输入字段映射。

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

KeyPhraseExtractionSkill

对象

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

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

KeyPhraseExtractionSkillLanguage

枚举

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

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

LanguageDetectionSkill

对象

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

名称	类型	说明
@odata.type	string: #Microsoft.Skills.Text.LanguageDetectionSkill	指定技能类型的 URI 片段。
context	string	表示执行操作的级别，例如文档根或文档内容（例如 /document 或 /document/content）。默认值为 /document。
defaultCountryHint	string	如果语言检测模型无法消除语言歧义，则将其用作语言检测模型的提示的国家/地区代码。
description	string	描述技能的说明，描述技能的输入、输出和用法。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
modelVersion	string	调用文本分析服务时要使用的模型版本。如果未指定，它将默认为最新可用。除非绝对必要，否则建议不要指定此值。
name	string	唯一标识技能集内的技能的名称。未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，其前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出是搜索索引中的字段，或者是另一个技能可以用作输入的值。

LineEnding

枚举

定义要在 OCR 技能识别的文本行之间使用的字符序列。默认值为“space”。

值	说明
space	行由单个空格字符分隔。
carriageReturn	行由回车符（“\r”）字符分隔。
lineFeed	行由单个换行符分隔（“\n”）字符。
carriageReturnLineFeed	行由回车符和换行符（“\r\n”）字符分隔。

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 输入支持的语言代码。

值	说明
af	阿非利堪斯语
sq	阿尔巴尼亚语
anp	安吉卡（德瓦纳吉里）
ar	阿拉伯语
ast	阿斯图里亚斯语
awa	Awadhi-Hindi（德瓦纳吉里）
az	阿塞拜疆语（拉丁语）
bfy	巴格利
eu	巴斯克语
be	白俄罗斯语（西里尔语和拉丁语）
be-cyrl	白俄罗斯语（西里尔文）
be-latn	白俄罗斯语（拉丁语）
bho	Bhojpuri-Hindi（德瓦纳吉里）
bi	Bislama
brx	博多（德瓦纳吉里）
bs	波斯尼亚拉丁语
bra	Brajbha
br	布列塔尼语
bg	保加利亚语
bns	邦德利
bua	伯里亚特（西里尔文）
ca	加泰隆语
ceb	Cebuano
rab	查姆林
ch	查莫罗
hne	查蒂斯加希（德瓦纳吉里）
zh-Hans	简体中文
zh-Hant	中文（繁体）
kw	康沃尔语
co	科西肯
crh	克里米亚·塔塔尔（拉丁语）
hr	克罗地亚语
cs	捷克语
da	丹麦语
prs	达里语
dhi	迪马尔（德瓦纳吉里）
doi	Dogri （德瓦纳吉里）
nl	荷兰语
en	英语
myv	埃尔齐亚（西里尔文）
et	爱沙尼亚语
fo	法罗语
fj	斐济语
fil	菲律宾语
fi	芬兰语
fr	法语
fur	Frulian
gag	加古兹（拉丁语）
gl	加利西亚语
de	德语
gil	吉尔伯特语
gon	冈迪（德瓦纳吉里）
el	希腊语
kl	格陵兰
gvr	古隆（德瓦纳吉里）
ht	海地克里奥尔语
hlb	哈尔比（德瓦纳吉里）
hni	Hani
bgc	哈扬维
haw	夏威夷人
hi	印地语
mww	苗族道（拉丁语）
hoc	何（德瓦纳吉里）
hu	匈牙利语
is	冰岛语
smn	伊纳里萨米语
id	印度尼西亚语
ia	国际语
iu	Inuktitut （拉丁语）
ga	爱尔兰语
it	意大利语
ja	日语
Jns	贾恩萨里（德瓦纳吉里）
jv	爪哇语
kea	Kabuverdianu
kac	卡钦（拉丁语）
xnr	康里（德瓦纳吉里）
krc	Karachay-Balkar
kaa-cyrl	Kara-Kalpak（西里尔文）
kaa	Kara-Kalpak （拉丁语）
csb	卡舒比语
kk-cyrl	哈萨克语（西里尔文）
kk-latn	哈萨克语（拉丁语）
klr	Khaling
kha	Khasi
quc	K'iche'
ko	朝鲜语
kfq	Korku
kpy	Koryak
kos	Kosraean
kum	库米克（西里尔文）
ku-arab	库尔德语（阿拉伯语）
ku-latn	库尔德语（拉丁语）
kru	库鲁克（德瓦纳吉里）
ky	吉尔吉斯（西里尔文）
lkt	拉科他州
la	拉丁语
lt	立陶宛语
dsb	低地文德语
smj	律勒萨米语
lb	卢森堡语
bfz	马哈苏·帕哈里（德瓦纳吉里）
ms	马来语（拉丁语）
mt	马耳他语
kmj	马尔托（德瓦纳吉里）
gv	马恩语
mi	毛利语
mr	马拉地语
mn	蒙古语（西里尔文）
cnr-cyrl	黑山（西里尔文）
cnr-latn	黑山（拉丁语）
nap	那不勒斯的
ne	尼泊尔语
niu	纽安
nog	Nogay
sme	北萨米（拉丁语）
nb	挪威语
no	挪威语
oc	奥克语
os	Ossetic
ps	普什图语
fa	波斯语
pl	波兰语
pt	葡萄牙语
pa	旁遮普语（阿拉伯语）
ksh	里普里亚语
ro	罗马尼亚语
rm	罗曼什语
ru	俄语
sck	萨德里（德瓦纳吉里）
sm	萨摩亚语（拉丁语）
sa	圣文（德瓦纳吉里）
sat	桑塔利（德瓦纳吉里）
sco	低地蘇格蘭語
gd	苏格兰盖尔语
sr	塞尔维亚语（拉丁语）
sr-Cyrl	塞尔维亚语 (西里尔文)
sr-Latn	塞尔维亚语（拉丁语）
xsr	谢尔帕（德瓦纳吉里）
srx	西尔穆里（德瓦纳吉里）
sms	斯科特萨米语
sk	斯洛伐克语
sl	斯洛文尼亚语
so	索马里语（阿拉伯语）
sma	南萨米
es	西班牙语
sw	斯瓦希里语（拉丁语）
sv	瑞典语
tg	塔吉克语（西里尔文）
tt	塔塔尔（拉丁语）
tet	德顿语
thf	Thangmi
to	汤加语
tr	土耳其语
tk	土库曼语（拉丁语）
tyv	图万
hsb	上索布语
ur	乌尔都语
ug	维吾尔语（阿拉伯语）
uz-arab	乌兹别克语（阿拉伯语）
uz-cyrl	乌兹别克语 (西里尔文)
uz	乌兹别克语（拉丁语）
vo	Volapük
wae	Walser
cy	威尔士语
fy	西弗里西亚语
yua	尤卡坦玛雅语
za	壮语
zu	祖鲁语
unk	未知（全部）

OutputFieldMappingEntry

对象

技能的输出字段映射。

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

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 maxLength: 1	如果 maskingMode 参数设置为替换，则用于屏蔽文本的字符。默认值为“*”。
maskingMode	PIIDetectionSkillMaskingMode	一个参数，提供各种方法来屏蔽输入文本中检测到的个人信息。默认值为“none”。
minimumPrecision	number (double) minimum: 0 maximum: 1	一个介于 0 和 1 之间的值，该值仅用于包含其置信度分数大于指定值的实体。如果未设置（默认值），或者显式设置为 null，则将包括所有实体。
modelVersion	string	调用文本分析服务时要使用的模型版本。如果未指定，它将默认为最新可用。除非绝对必要，否则建议不要指定此值。
name	string	唯一标识技能集内的技能的名称。未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，其前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出是搜索索引中的字段，或者是另一个技能可以用作输入的值。
piiCategories	string[]	应提取和屏蔽的 PII 实体类别的列表。

PIIDetectionSkillMaskingMode

枚举

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

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

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/userAssignedIdentity/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 Key Vault 中创建的加密密钥。当你希望完全保证没有人（甚至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 Key Vault 中的客户管理的加密密钥。创建和管理的密钥可用于加密或解密静态数据，例如索引和同义词映射。

名称	类型	说明
accessCredentials	AzureActiveDirectoryApplicationCredentials	用于访问 Azure Key Vault 的可选 Azure Active Directory 凭据。如果改用托管标识，则不需要。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	用于此加密密钥的显式托管标识。如果未指定并且访问凭据属性为 null，则使用系统分配的托管标识。更新资源时，如果未指定显式标识，则保持不变。如果指定了“none”，则清除此属性的值。
keyVaultKeyName	string	用于加密静态数据的 Azure Key Vault 密钥的名称。
keyVaultKeyVersion	string	用于加密静态数据的 Azure Key Vault 密钥的版本。
keyVaultUri	string	Azure Key Vault 的 URI（也称为 DNS 名称），其中包含用于加密静态数据的密钥。示例 URI 可能是 `https://my-keyvault-name.vault.azure.net`。

SentimentSkill

对象

此技能已弃用。使用 V3。相反，SentimentSkill。

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

SentimentSkillLanguage

枚举

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

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

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 (int32)	所需的最大页长度。默认值为 10000。
maximumPagesToTake	integer (int32)	仅当 textSplitMode 设置为“pages”时才适用。如果指定，SplitSkill 将在处理第一个“maximumPagesToTake”页面后停止拆分，以便在每个文档只需要几个初始页面时提高性能。
name	string	唯一标识技能集内的技能的名称。未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，其前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出是搜索索引中的字段，或者是另一个技能可以用作输入的值。
pageOverlapLength	integer (int32)	仅当 textSplitMode 设置为“pages”时才适用。如果指定，则 n+1 区块将从第 n 个区块末尾开始此数量的字符/标记。
textSplitMode	TextSplitMode	一个值，指示要执行的拆分模式。

SplitSkillLanguage

枚举

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

值	说明
am	阿姆哈拉语
bs	波斯尼亚语
cs	捷克语
da	丹麦语
de	德语
en	英语
es	西班牙语
et	爱沙尼亚语
fi	芬兰语
fr	法语
he	希伯来语
hi	印地语
hr	克罗地亚语
hu	匈牙利语
id	印度尼西亚语
is	冰岛语
it	意大利语
ja	日语
ko	朝鲜语
lv	拉脱维亚语
nb	挪威语
nl	荷兰语
pl	波兰语
pt	葡萄牙语（葡萄牙）
pt-br	葡萄牙语（巴西）
ru	俄语
sk	斯洛伐克语
sl	斯洛文尼亚语
sr	塞尔维亚语
sv	瑞典语
tr	土耳其语
ur	乌尔都语
zh	中文（简体）

TextSplitMode

枚举

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

值	说明
pages	将文本拆分为单个页面。
sentences	将文本拆分为单个句子。

TextTranslationSkill

对象

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

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

TextTranslationSkillLanguage

枚举

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

值	说明
af	阿非利堪斯语
ar	阿拉伯语
bn	孟加拉语
bs	波斯尼亚语(拉丁语系)
bg	保加利亚语
yue	粤语（繁体）
ca	加泰隆语
zh-Hans	简体中文
zh-Hant	中文（繁体）
hr	克罗地亚语
cs	捷克语
da	丹麦语
nl	荷兰语
en	英语
et	爱沙尼亚语
fj	斐济语
fil	菲律宾语
fi	芬兰语
fr	法语
de	德语
el	希腊语
ht	海地克里奥尔语
he	希伯来语
hi	印地语
mww	白苗文
hu	匈牙利语
is	冰岛语
id	印度尼西亚语
it	意大利语
ja	日语
sw	斯瓦希里语
tlh	克林贡语
tlh-Latn	克林贡（拉丁文脚本）
tlh-Piqd	克林贡（克林贡脚本）
ko	朝鲜语
lv	拉脱维亚语
lt	立陶宛语
mg	马达加斯加语
ms	马来语
mt	马耳他语
nb	挪威语
fa	波斯语
pl	波兰语
pt	葡萄牙语
pt-br	葡萄牙语（巴西）
pt-PT	葡萄牙语（葡萄牙）
otq	克雷塔罗奥托米语
ro	罗马尼亚语
ru	俄语
sm	萨摩亚语
sr-Cyrl	塞尔维亚语 (西里尔文)
sr-Latn	塞尔维亚语（拉丁语）
sk	斯洛伐克语
sl	斯洛文尼亚语
es	西班牙语
sv	瑞典语
ty	塔希提语
ta	泰米尔语
te	泰卢固语
th	泰语
to	汤加语
tr	土耳其语
uk	乌克兰语
ur	乌尔都语
vi	越南语
cy	威尔士语
yua	尤卡坦玛雅语
ga	爱尔兰语
kn	卡纳拉语
mi	毛利语
ml	马拉雅拉姆语
pa	旁遮普语

VisualFeature

枚举

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

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

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 (int32)	指示文档数的所需批大小。
context	string	表示执行操作的级别，例如文档根或文档内容（例如 /document 或 /document/content）。默认值为 /document。
degreeOfParallelism	integer (int32)	如果已设置，则可以对 Web API 进行并行调用的数量。
description	string	描述技能的说明，描述技能的输入、输出和用法。
httpHeaders	object	发出 http 请求所需的标头。
httpMethod	string	http 请求的方法。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
name	string	唯一标识技能集内的技能的名称。未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称，其前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出是搜索索引中的字段，或者是另一个技能可以用作输入的值。
timeout	string (duration)	请求的所需超时。默认值为 30 秒。
uri	string	Web API 的 URL。