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

Skillsets - Get

服务:: Search Service

API 版本:: 2025-09-01

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

GET {endpoint}/skillsets('{skillsetName}')?api-version=2025-09-01

URI 参数

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

请求头

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

响应

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

示例

SearchServiceGetSkillset

示例请求

HTTP

GET https://stableexampleservice.search.windows.net/skillsets('myskillset')?api-version=2025-09-01

示例响应

状态代码:: 200

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

定义

名称	说明
AzureActiveDirectoryApplicationCredentials	为搜索服务创建的已注册应用程序的凭据，用于对存储在 Azure Key Vault 中的加密密钥进行身份验证访问。
AzureOpenAIEmbeddingSkill	允许使用 Azure OpenAI 资源为给定文本输入生成矢量嵌入。
AzureOpenAIModelName	将调用的 Azure Open AI 模型名称。
CognitiveServicesAccountKey	附加到技能组的 Azure AI 服务资源的多区域帐户密钥。
ConditionalSkill	一种技能，用于启用需要布尔运算来确定要分配给输出的数据的方案。
CustomEntity	包含有关找到的匹配项和相关元数据的信息的对象。
CustomEntityAlias	一个复杂对象，可用于指定根实体名称的替代拼写或同义词。
CustomEntityLookupSkill	技能从自定义的用户定义的单词和短语列表中查找文本。
CustomEntityLookupSkillLanguage	CustomEntityLookupSkill 支持的输入文本的语言代码。
DefaultCognitiveServicesAccount	表示技能组的默认 Azure AI 服务资源的空对象。
DocumentExtractionSkill	从扩充管道中的文件中提取内容的技能。
DocumentIntelligenceLayoutSkill	通过 Azure AI 服务从扩充管道中的文件中提取内容和布局信息的技能。
DocumentIntelligenceLayoutSkillChunkingProperties	控制内容分块的基数。
DocumentIntelligenceLayoutSkillChunkingUnit	控制 chunk unit 的基数。默认值为“字符”
DocumentIntelligenceLayoutSkillExtractionOptions	控制技能从文档中提取的内容的基数。
DocumentIntelligenceLayoutSkillMarkdownHeaderDepth	Markdown 输出中标头的深度。默认值为 h6。
DocumentIntelligenceLayoutSkillOutputFormat	控制输出格式的基数。默认值为“markdown”。
DocumentIntelligenceLayoutSkillOutputMode	控制技能生成的输出的基数。默认值为“oneToMany”。
EntityCategory	指示要返回的实体类别的字符串。
EntityLinkingSkill	使用文本分析 API，从文本中提取链接的实体。
EntityRecognitionSkill	此技能已弃用。使用 V3。EntityRecognitionSkill。
EntityRecognitionSkillLanguage	已弃用。 EntityRecognitionSkill支持的输入文本的语言代码。
EntityRecognitionSkillV3	使用文本分析 API，从文本中提取不同类型的实体。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ImageAnalysisSkill	分析图像文件的技能。它根据图像内容提取一组丰富的视觉特征。
ImageAnalysisSkillLanguage	ImageAnalysisSkill支持输入的语言代码。
ImageDetail	指示要返回哪些特定于域的详细信息的字符串。
IndexProjectionMode	定义索引投影相对于索引器其余部分的行为。
InputFieldMappingEntry	技能的输入字段映射。
KeyPhraseExtractionSkill	使用文本分析提取关键短语的技能。
KeyPhraseExtractionSkillLanguage	KeyPhraseExtractionSkill 支持的输入文本的语言代码。
LanguageDetectionSkill	一种技能，用于检测输入文本的语言，并为请求提交的每个文档报告单个语言代码。语言代码与指示分析置信度的分数配对。
LineEnding	定义 OCR 技能识别的文本行之间要使用的字符序列。默认值为“space”。
MergeSkill	一种将两个或多个字符串合并为单个统一字符串的技能，并带有可选的用户定义分隔符来分隔每个组件部分。
OcrSkill	从图像文件中提取文本的技能。
OcrSkillLanguage	OcrSkill支持输入的语言代码。
OutputFieldMappingEntry	技能的输出字段映射。
PIIDetectionSkill	使用文本分析 API，从输入文本中提取个人信息，并提供屏蔽文本的选项。
PIIDetectionSkillMaskingMode	一个字符串，指示要使用哪个 maskingMode 来屏蔽在输入文本中检测到的个人信息。
SearchIndexerDataNoneIdentity	清除数据源的标识属性。
SearchIndexerDataUserAssignedIdentity	指定要使用的数据源的标识。
SearchIndexerIndexProjections	定义对二级搜索索引的附加投影。
SearchIndexerIndexProjectionSelector	描述要存储在指定搜索索引中的数据。
SearchIndexerIndexProjectionsParameters	特定于索引投影的配置属性的字典。每个名称都是特定属性的名称。每个值必须是基元类型。
SearchIndexerKnowledgeStore	定义扩充数据的 Azure Blob、表或文件的其他投影。
SearchIndexerKnowledgeStoreFileProjectionSelector	要在 Azure 文件存储中存储哪些数据的投影定义。
SearchIndexerKnowledgeStoreObjectProjectionSelector	要在 Azure Blob 中存储哪些数据的投影定义。
SearchIndexerKnowledgeStoreProjection	各种投影选择器的容器对象。
SearchIndexerKnowledgeStoreTableProjectionSelector	有关要在 Azure 表中存储哪些数据的说明。
SearchIndexerSkillset	技能列表。
SearchResourceEncryptionKey	Azure Key Vault 中的客户管理的加密密钥。创建和管理的密钥可用于加密或解密静态数据，例如索引和同义词映射。
SentimentSkill	此技能已弃用。使用 V3。SentimentSkill 的 Kill。
SentimentSkillLanguage	已弃用。 SentimentSkill 支持的输入文本的语言代码。
SentimentSkillV3	使用文本分析 API，评估非结构化文本，并为每条记录提供情绪标签（例如“负面”、“中性”和“正面”），基于服务在句子和文档级别找到的最高置信度分数。
ShaperSkill	重塑输出的技能。它创建了一个复杂类型来支持复合字段（也称为多部分字段）。
SplitSkill	将字符串拆分为文本块的技能。
SplitSkillLanguage	SplitSkill 支持输入文本的语言代码。
TextSplitMode	指示要执行的拆分模式的值。
TextTranslationSkill	将文本从一种语言翻译成另一种语言的技能。
TextTranslationSkillLanguage	TextTranslationSkill 支持的输入文本的语言代码。
VisualFeature	指示要返回的视觉特征类型的字符串。
WebApiSkill	可以调用 Web API 终结点的技能，允许你通过让技能组调用自定义代码来扩展技能集。

AzureActiveDirectoryApplicationCredentials

Object

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

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

AzureOpenAIEmbeddingSkill

Object

允许使用 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	描述技能的描述，描述技能的输入、输出和用法。
dimensions	integer (int32)	生成的输出嵌入应有的维度数。仅在 text-embedding-3 及更高版本中受支持。
inputs	InputFieldMappingEntry[]	技能的输入可以是源数据集中的列，也可以是上游技能的输出。
modelName	AzureOpenAIModelName	部署在提供的 deploymentId 路径上的嵌入模型的名称。
name	string	在技能集中唯一标识它的技能的名称。未定义名称的技能将在技能数组中为其从 1 开始的索引的默认名称，前缀为字符“#”。
outputs	OutputFieldMappingEntry[]	技能的输出要么是搜索索引中的字段，要么是可作为其他技能输入使用的值。
resourceUri	string (uri)	Azure OpenAI 资源的资源 URI。

AzureOpenAIModelName

枚举

将调用的 Azure Open AI 模型名称。

值	说明
text-embedding-ada-002
text-embedding-3-large
text-embedding-3-small

CognitiveServicesAccountKey

Object

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

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

ConditionalSkill

Object

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

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

CustomEntity

Object

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

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

CustomEntityAlias

Object

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

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

CustomEntityLookupSkill

Object

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

名称	类型	说明
@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	Korean
pt	Portuguese

DefaultCognitiveServicesAccount

Object

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

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

DocumentExtractionSkill

Object

从扩充管道中的文件中提取内容的技能。

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

DocumentIntelligenceLayoutSkill

Object

通过 Azure AI 服务从扩充管道中的文件中提取内容和布局信息的技能。

名称	类型	默认值	说明
@odata.type	string: #Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill		指定技能类型的 URI 片段。
chunkingProperties	DocumentIntelligenceLayoutSkillChunkingProperties		控制内容分块的基数。
context	string		表示执行作的级别，例如文档根目录或文档内容（例如，/document 或 /document/content）。默认值为 /document。
description	string		描述技能的描述，描述技能的输入、输出和用法。
extractionOptions	DocumentIntelligenceLayoutSkillExtractionOptions[]		控制技能从文档中提取的内容的基数
inputs	InputFieldMappingEntry[]		技能的输入可以是源数据集中的列，也可以是上游技能的输出。
markdownHeaderDepth	DocumentIntelligenceLayoutSkillMarkdownHeaderDepth	h6	Markdown 输出中标头的深度。默认值为 h6。
name	string		在技能集中唯一标识它的技能的名称。未定义名称的技能将在技能数组中为其从 1 开始的索引的默认名称，前缀为字符“#”。
outputFormat	DocumentIntelligenceLayoutSkillOutputFormat	markdown	控制输出格式的基数。默认值为“markdown”。
outputMode	DocumentIntelligenceLayoutSkillOutputMode	oneToMany	控制技能生成的输出的基数。默认值为“oneToMany”。
outputs	OutputFieldMappingEntry[]		技能的输出要么是搜索索引中的字段，要么是可作为其他技能输入使用的值。

DocumentIntelligenceLayoutSkillChunkingProperties

Object

控制内容分块的基数。

名称	类型	默认值	说明
maximumLength	integer (int32)		最大块长度（以字符为单位）。默认值为 500。
overlapLength	integer (int32)		在两个文本块之间提供的重叠长度。默认为 0。
unit	DocumentIntelligenceLayoutSkillChunkingUnit	characters	块的单位。

DocumentIntelligenceLayoutSkillChunkingUnit

枚举

控制 chunk unit 的基数。默认值为“字符”

值	说明
characters	按字符指定块。

DocumentIntelligenceLayoutSkillExtractionOptions

枚举

控制技能从文档中提取的内容的基数。

值	说明
images	指定应从文档中提取图像内容。
locationMetadata	指定应从文档中提取位置元数据。

DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

枚举

Markdown 输出中标头的深度。默认值为 h6。

值	说明
h1	标头级别 1。
h2	标头级别 2。
h3	标头级别 3。
h4	标头级别 4。
h5	标头级别 5。
h6	标头级别 6。

DocumentIntelligenceLayoutSkillOutputFormat

枚举

控制输出格式的基数。默认值为“markdown”。

值	说明
text	将输出的格式指定为文本。
markdown	将输出的格式指定为 markdown。

DocumentIntelligenceLayoutSkillOutputMode

枚举

控制技能生成的输出的基数。默认值为“oneToMany”。

值	说明
oneToMany	指定输出应解析为“oneToMany”。

EntityCategory

枚举

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

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

EntityLinkingSkill

Object

使用文本分析 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

Object

此技能已弃用。使用 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	Chinese-Traditional
da	丹麦语
nl	荷兰语
en	英语
fi	芬兰语
fr	法语
de	德语
el	希腊语
hu	匈牙利语
it	意大利语
ja	日语
ko	Korean
no	挪威语（博克马尔）
pl	波兰语
pt-PT	葡萄牙语（葡萄牙）
pt-BR	葡萄牙语（巴西）
ru	Russian
es	西班牙语
sv	瑞典语
tr	土耳其语

EntityRecognitionSkillV3

Object

使用文本分析 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

Object

资源管理错误附加信息。

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

ErrorDetail

Object

错误详细信息。

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

ErrorResponse

Object

错误响应

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

ImageAnalysisSkill

Object

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

名称	类型	说明
@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	Korean
lt	立陶宛语
lv	拉脱维亚语
mk	马其顿语
ms	马来语 - 马来西亚
nb	挪威语(博克马尔语)
nl	荷兰语
pl	波兰语
prs	达里语
pt-BR	葡萄牙语 - 巴西
pt	葡萄牙语 - 葡萄牙
pt-PT	葡萄牙语 - 葡萄牙
ro	罗马尼亚语
ru	Russian
sk	斯洛伐克语
sl	斯洛文尼亚语
sr-Cyrl	塞尔维亚语 - 西里尔语
sr-Latn	塞尔维亚语 - 拉丁语
sv	瑞典语
th	泰语
tr	土耳其语
uk	乌克兰语
vi	越南语
zh	简体中文
zh-Hans	简体中文
zh-Hant	中文（繁体）

ImageDetail

枚举

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

值	说明
celebrities	细节被公认为名人。
landmarks	细节被公认为地标。

IndexProjectionMode

枚举

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

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

InputFieldMappingEntry

Object

技能的输入字段映射。

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

KeyPhraseExtractionSkill

Object

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

名称	类型	说明
@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	Korean
no	挪威语（博克马尔）
pl	波兰语
pt-PT	葡萄牙语（葡萄牙）
pt-BR	葡萄牙语（巴西）
ru	Russian
es	西班牙语
sv	瑞典语

LanguageDetectionSkill

Object

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

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

Object

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

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

Object

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

名称	类型	默认值	说明
@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	Afrikaans
sq	阿尔巴尼亚语
anp	昂加语（天城文）
ar	阿拉伯语
ast	阿斯图里亚斯语
awa	阿瓦德语-印地语（天城文）
az	阿塞拜疆语(拉丁语)
bfy	巴格里语
eu	巴斯克语
be	白俄罗斯语（西里尔文和拉丁文）
be-cyrl	白俄罗斯语(西里尔语)
be-latn	白俄罗斯语(拉丁语)
bho	博杰普尔语-印地语（天城文）
bi	比斯拉马语
brx	博多语（天城文）
bs	波斯尼亚语（拉丁语系）
bra	布拉伊巴
br	布列塔尼语
bg	保加利亚语
bns	本德利语
bua	布里亚特语(西里尔语)
ca	加泰罗尼亚语
ceb	宿雾语
rab	查姆林语
ch	查莫罗语
hne	恰蒂斯加尔希语（天城文）
zh-Hans	简体中文
zh-Hant	中文（繁体）
kw	康沃尔语
co	柯西嘉语
crh	克里米亚鞑靼语（拉丁语）
hr	克罗地亚语
cs	捷克语
da	丹麦语
prs	达里语
dhi	迪马尔语（天城文）
doi	多格拉语（天城文）
nl	荷兰语
en	英语
myv	厄尔兹亚语(西里尔语)
et	爱沙尼亚语
fo	法罗语
fj	斐济语
fil	菲律宾语
fi	芬兰语
fr	法语
fur	弗鲁连
gag	嘎嘎乌孜语(拉丁语)
gl	加利西亚语
de	德语
gil	吉尔伯特斯语
gon	贡迪语（天城文）
el	希腊语
kl	格陵兰语
gvr	古隆语（天城文）
ht	海地克里奥尔语
hlb	哈尔比语（天城文）
hni	哈尼语
bgc	哈里亚维
haw	夏威夷语
hi	印地语
mww	白苗语（拉丁语）
hoc	Ho （梵文）
hu	匈牙利语
is	Icelandic
smn	伊纳里萨米语
id	印度尼西亚语
ia	国际语
iu	因纽特语(拉丁语)
ga	爱尔兰语
it	意大利语
ja	日语
Jns	贾恩萨里语（天城文）
jv	爪哇语
kea	卡布佛得鲁语
kac	克钦语（拉丁语）
xnr	康格里语（天城文）
krc	卡巴尔达语
kaa-cyrl	卡拉卡巴克语(西里尔语)
kaa	卡拉卡巴克语(拉丁语)
csb	卡舒比语
kk-cyrl	哈萨克语(西里尔语)
kk-latn	哈萨克语(拉丁语)
klr	哈林语
kha	卡西语
quc	基切语
ko	Korean
kfq	科尔库语
kpy	科里亚克语
kos	科斯拉伊语
kum	库梅克语(西里尔语)
ku-arab	库尔德语(阿拉伯语)
ku-latn	库尔德语(拉丁语)
kru	库鲁克语（天城文）
ky	吉尔吉斯语(西里尔语)
lkt	拉科塔语
la	拉丁语
lt	立陶宛语
dsb	下索布语
smj	律勒萨米语
lb	Luxembourgish
bfz	玛哈苏帕哈里（天城文）
ms	马来语(拉丁语系)
mt	马耳他语
kmj	马尔托语（天城文）
gv	马恩岛语
mi	毛利语
mr	马拉地语
mn	蒙古语(西里尔文)
cnr-cyrl	蒙特内哥罗语(西里尔语)
cnr-latn	蒙特内哥罗语(拉丁语)
nap	那不勒斯语
ne	尼泊尔语
niu	纽埃语
nog	诺盖语
sme	北萨米语(拉丁语)
nb	挪威语
no	挪威语
oc	奥克西唐语
os	奥塞丁语
ps	普什图语
fa	波斯语
pl	波兰语
pt	Portuguese
pa	旁遮普语(阿拉伯语)
ksh	利普里安语
ro	罗马尼亚语
rm	罗曼什语
ru	Russian
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	唐米语
to	汤加语
tr	土耳其语
tk	土库曼语(拉丁语)
tyv	图瓦语
hsb	上索布语
ur	乌尔都语
ug	维吾尔语（阿拉伯语）
uz-arab	乌兹别克语（阿拉伯语）
uz-cyrl	乌兹别克语(西里尔文)
uz	乌兹别克语(拉丁语)
vo	沃拉普克语
wae	瓦尔瑟语
cy	威尔士语
fy	西弗里西亚语
yua	尤卡坦玛雅语
za	壮语
zu	祖鲁语
unk	未知（全部）

OutputFieldMappingEntry

Object

技能的输出字段映射。

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

PIIDetectionSkill

Object

使用文本分析 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 参数中给出的字符。该字符将重复到检测到的实体的长度，以便偏移量将正确对应于输入文本和输出 maskedText。

SearchIndexerDataNoneIdentity

Object

清除数据源的标识属性。

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

SearchIndexerDataUserAssignedIdentity

Object

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

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

SearchIndexerIndexProjections

Object

定义对二级搜索索引的附加投影。

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

SearchIndexerIndexProjectionSelector

Object

描述要存储在指定搜索索引中的数据。

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

SearchIndexerIndexProjectionsParameters

Object

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

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

SearchIndexerKnowledgeStore

Object

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

名称	类型	说明
projections	SearchIndexerKnowledgeStoreProjection[]	索引期间要执行的其他投影列表。
storageConnectionString	string	存储帐户投影的连接字符串将存储在其中。

SearchIndexerKnowledgeStoreFileProjectionSelector

Object

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

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

SearchIndexerKnowledgeStoreObjectProjectionSelector

Object

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

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

SearchIndexerKnowledgeStoreProjection

Object

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

名称	类型	说明
files	SearchIndexerKnowledgeStoreFileProjectionSelector[]	对 Azure 文件存储的投影。
objects	SearchIndexerKnowledgeStoreObjectProjectionSelector[]	对 Azure Blob 存储的投影。
tables	SearchIndexerKnowledgeStoreTableProjectionSelector[]	对 Azure 表存储的投影。

SearchIndexerKnowledgeStoreTableProjectionSelector

Object

有关要在 Azure 表中存储哪些数据的说明。

名称	类型	说明
generatedKeyName	string	生成的密钥的名称，用于存储投影。
inputs	InputFieldMappingEntry[]	用于复杂投影的嵌套输入。
referenceKeyName	string	不同投影的参考键的名称。
source	string	将数据源到项目。
sourceContext	string	复杂投影的源上下文。
tableName	string	要在其中存储投影数据的 Azure 表的名称。

SearchIndexerSkillset

Object

技能列表。

名称	类型	说明
@odata.etag	string	技能集的 ETag。
cognitiveServices	CognitiveServicesAccount: CognitiveServicesAccountKey DefaultCognitiveServicesAccount	有关运行技能时要使用的 Azure AI 服务的详细信息。
description	string	技能组的说明。
encryptionKey	SearchResourceEncryptionKey	在 Azure Key Vault 中创建的加密密钥的说明。当你希望完全保证没有人（甚至 Microsoft）无法解密技能组定义时，此密钥用于为技能组定义提供额外的静态加密级别。加密技能组定义后，它将始终保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果要轮换加密密钥，可以根据需要更改此属性;您的技能组合定义将不受影响。使用客户管理的密钥进行加密不适用于免费搜索服务，仅适用于 2019 年 1 月 1 日或之后创建的付费服务。
indexProjections	SearchIndexerIndexProjections	对二级检索索引的额外预测的定义。
knowledgeStore	SearchIndexerKnowledgeStore	定义扩充数据的 Azure Blob、表或文件的其他投影。
name	string	技能组的名称。
skills	SearchIndexerSkill[]: AzureOpenAIEmbeddingSkill[] ConditionalSkill[] CustomEntityLookupSkill[] DocumentExtractionSkill[] DocumentIntelligenceLayoutSkill[] EntityLinkingSkill[] EntityRecognitionSkill[] EntityRecognitionSkillV3[] ImageAnalysisSkill[] KeyPhraseExtractionSkill[] LanguageDetectionSkill[] MergeSkill[] OcrSkill[] PIIDetectionSkill[] SentimentSkill[] SentimentSkillV3[] ShaperSkill[] SplitSkill[] TextTranslationSkill[] WebApiSkill[]	技能集中的技能列表。

SearchResourceEncryptionKey

Object

Azure Key Vault 中的客户管理的加密密钥。创建和管理的密钥可用于加密或解密静态数据，例如索引和同义词映射。

名称	类型	说明
accessCredentials	AzureActiveDirectoryApplicationCredentials	用于访问 Azure Key Vault 的可选 Azure Active Directory 凭据。如果改用托管标识，则不需要。
keyVaultKeyName	string	用于加密静态数据的 Azure Key Vault 密钥的名称。
keyVaultKeyVersion	string	用于加密静态数据的 Azure Key Vault 密钥版本。
keyVaultUri	string	Azure 密钥保管库的 URI（也称为 DNS 名称），其中包含用于加密静态数据的密钥。一个示例 URI 可能是 `https://my-keyvault-name.vault.azure.net`。

SentimentSkill

Object

此技能已弃用。使用 V3。SentimentSkill 的 Kill。

名称	类型	说明
@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	Russian
es	西班牙语
sv	瑞典语
tr	土耳其语

SentimentSkillV3

Object

使用文本分析 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

Object

重塑输出的技能。它创建了一个复杂类型来支持复合字段（也称为多部分字段）。

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

SplitSkill

Object

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

名称	类型	说明
@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	Icelandic
it	意大利语
ja	日语
ko	Korean
lv	拉脱维亚语
nb	挪威语
nl	荷兰语
pl	波兰语
pt	葡萄牙语（葡萄牙）
pt-br	葡萄牙语（巴西）
ru	Russian
sk	斯洛伐克语
sl	斯洛文尼亚语
sr	塞尔维亚语
sv	瑞典语
tr	土耳其语
ur	乌尔都语
zh	中文(简体)

TextSplitMode

枚举

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

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

TextTranslationSkill

Object

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

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

TextTranslationSkillLanguage

枚举

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

值	说明
af	Afrikaans
ar	阿拉伯语
bn	孟加拉语
bs	波斯尼亚语(拉丁语系)
bg	保加利亚语
yue	粤语（繁体）
ca	加泰罗尼亚语
zh-Hans	简体中文
zh-Hant	中文（繁体）
hr	克罗地亚语
cs	捷克语
da	丹麦语
nl	荷兰语
en	英语
et	爱沙尼亚语
fj	斐济语
fil	菲律宾语
fi	芬兰语
fr	法语
de	德语
el	希腊语
ht	海地克里奥尔语
he	希伯来语
hi	印地语
mww	白苗文
hu	匈牙利语
is	Icelandic
id	印度尼西亚语
it	意大利语
ja	日语
sw	斯瓦希里语
tlh	克林贡语
tlh-Latn	克林贡语（拉丁文字）
tlh-Piqd	克林贡语（克林贡文字）
ko	Korean
lv	拉脱维亚语
lt	立陶宛语
mg	马达加斯加语
ms	马来语
mt	马耳他语
nb	挪威语
fa	波斯语
pl	波兰语
pt	Portuguese
pt-br	葡萄牙语（巴西）
pt-PT	葡萄牙语（葡萄牙）
otq	克雷塔罗奥托米语
ro	罗马尼亚语
ru	Russian
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	Description.
faces	视觉特征被识别为人脸。
objects	视觉特征被识别为对象。
tags	标签。

WebApiSkill

Object

可以调用 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。