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

Skillsets - Create

在搜索服务中创建新的技能集。

POST {endpoint}/skillsets?api-version=2026-04-01

URI 参数

名称 必需 类型 说明
endpoint
path True

string (uri)

搜索服务的终结点 URL。

api-version
query True

string

minLength: 1

用于此操作的 API 版本。

请求头

名称 必需 类型 说明
Accept

Accept

接受(Accept)首部。

x-ms-client-request-id

string (uuid)

请求的不透明、全局唯一的客户端生成的字符串标识符。

请求正文

名称 必需 类型 说明
name True

string

技能集的名称。

skills True SearchIndexerSkill[]:

技能集中的技能列表。

@odata.etag

string

技能集的 ETag。

cognitiveServices CognitiveServicesAccount:

关于在技能运行时使用的Azure AI服务的详细信息。

description

string

技能集的说明。

encryptionKey

SearchResourceEncryptionKey

描述在 Azure 密钥保管库 中创建的加密密钥。 当你想完全确保没有人,甚至不包括Microsoft,能解密你的技能组定义时,这个密钥用于为你的技能组定义提供额外的静止加密层。 加密技能集定义后,它将始终保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果需要轮换加密密钥,可以根据需要更改此属性;技能组定义将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务,并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。

indexProjections

SearchIndexerIndexProjection

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

knowledgeStore

SearchIndexerKnowledgeStore

对丰富数据的 Azure blob、表格或文件的额外投影定义。

响应

名称 类型 说明
201 Created

SearchIndexerSkillset

请求已成功,因此创建了一个新资源。

Other Status Codes

ErrorResponse

意外的错误响应。

安全性

api-key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称 说明
https://search.azure.com/.default

示例

SearchServiceCreateSkillset

示例请求

POST https://stableexampleservice.search.windows.net/skillsets?api-version=2026-04-01


{
  "name": "tempskillset",
  "description": "Skillset for extracting entities and more",
  "skills": [
    {
      "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
      "name": "skill2",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "countryHint",
          "source": "/document/countryHint"
        }
      ],
      "outputs": [
        {
          "name": "languageCode",
          "targetName": "languageCode"
        }
      ]
    },
    {
      "textSplitMode": "pages",
      "maximumPageLength": 4000,
      "@odata.type": "#Microsoft.Skills.Text.SplitSkill",
      "name": "skill3",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "textItems",
          "targetName": "pages"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
      "name": "skill4",
      "context": "/document/pages/*",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "keyPhrases",
          "targetName": "keyPhrases"
        }
      ]
    },
    {
      "uri": "https://contoso.example.org/",
      "httpMethod": "POST",
      "timeout": "PT5S",
      "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
      "name": "skill5",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "customresult",
          "targetName": "result"
        }
      ]
    },
    {
      "outputMode": "oneToMany",
      "markdownHeaderDepth": "h3",
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill",
      "context": "/document",
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "markdown_document",
          "targetName": "markdown_document"
        }
      ]
    },
    {
      "outputFormat": "text",
      "outputMode": "oneToMany",
      "extractionOptions": [
        "images",
        "locationMetadata"
      ],
      "chunkingProperties": {
        "unit": "characters",
        "maximumLength": 500,
        "overlapLength": 50
      },
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill#2",
      "context": "/document",
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "text_sections",
          "targetName": "text_sections"
        },
        {
          "name": "normalized_images",
          "targetName": "normalized_images"
        }
      ]
    }
  ],
  "cognitiveServices": {
    "key": "myKey",
    "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com",
    "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey",
    "description": "Description of the Azure AI service resource attached to a skillset"
  },
  "@odata.etag": "0x1234568AE7E58A1"
}

示例响应

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "tempskillset",
  "description": "Skillset for extracting entities and more",
  "skills": [
    {
      "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
      "name": "skill2",
      "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",
      "textSplitMode": "pages",
      "maximumPageLength": 4000,
      "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/*",
      "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",
      "uri": "https://contoso.example.org/",
      "httpMethod": "POST",
      "timeout": "PT5S",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "customresult",
          "targetName": "result"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill",
      "context": "/document",
      "outputMode": "oneToMany",
      "markdownHeaderDepth": "h3",
      "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
      }
    }
  ],
  "cognitiveServices": {
    "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey",
    "description": "Description of the Azure AI service resource attached to a skillset",
    "key": "myKey",
    "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com"
  }
}

定义

名称 说明
Accept

接受(Accept)首部。

AIServicesAccountIdentity

一个关联技能集的 Azure AI 服务资源的多区域账户。

AIServicesAccountKey

Azure AI服务资源的账户密钥,关联到技能集,用于该资源的子域。

AzureOpenAIEmbeddingSkill

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

AzureOpenAIModelName

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

ChatCompletionCommonModelParameters

聊天完成的通用语言模型参数。 如果省略,则使用默认值。

ChatCompletionExtraParametersBehavior

规定Azure AI Foundry应如何处理“extraParameters”。 默认为“错误”。

ChatCompletionResponseFormat

确定应如何序列化语言模型的响应。 默认为“文本”。

ChatCompletionResponseFormatType

指定 LLM 应如何格式化响应。

ChatCompletionSchema

定义模型将用于构建其输出的自定义架构的对象。

ChatCompletionSchemaProperties

JSON 模式响应格式的属性。

ChatCompletionSkill

一项通过 Azure AI Foundry 的聊天完成终端调用语言模型的技能。

CognitiveServicesAccountKey

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

ConditionalSkill

一种技能,使需要布尔操作的方案能够确定要分配给输出的数据。

ContentUnderstandingSkill

一项利用 Azure AI 内容理解技术处理和提取结构化洞察的技能,使内容丰富且可搜索,从而增强文档索引和检索能力。

ContentUnderstandingSkillChunkingProperties

控制内容分块的基数。

ContentUnderstandingSkillExtractionOptions

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

CustomEntity

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

CustomEntityAlias

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

CustomEntityLookupSkill

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

CustomEntityLookupSkillLanguage

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

DefaultCognitiveServicesAccount

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

DocumentExtractionSkill

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

DocumentIntelligenceLayoutSkill

一项通过Azure AI服务从丰富流程中文件提取内容和布局信息的技能。

DocumentIntelligenceLayoutSkillChunkingProperties

控制内容分块的基数。

DocumentIntelligenceLayoutSkillExtractionOptions

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

EntityCategory

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

EntityLinkingSkill

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

EntityRecognitionSkillLanguage

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

EntityRecognitionSkillV3

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

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

所有 Azure 资源管理器 API 的通用错误响应,用于返回失败操作的错误细节。 (这也遵循 OData 错误响应格式)。

ImageAnalysisSkill

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

ImageAnalysisSkillLanguage

ImageAnalysisSkill支持输入的语言代码。

ImageDetail

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

IndexProjectionMode

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

InputFieldMappingEntry

技能的输入字段映射。

KeyPhraseExtractionSkill

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

KeyPhraseExtractionSkillLanguage

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

LanguageDetectionSkill

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

MergeSkill

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

OcrLineEnding

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

OcrSkill

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

OcrSkillLanguage

OcrSkill支持输入的语言代码。

OutputFieldMappingEntry

技能的输出字段映射。

PIIDetectionSkill

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

PIIDetectionSkillMaskingMode

一个字符串,指示要使用哪个 maskingMode 来屏蔽在输入文本中检测到的个人信息。

SearchIndexerDataNoneIdentity

清除数据源的标识属性。

SearchIndexerDataUserAssignedIdentity

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

SearchIndexerIndexProjection

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

SearchIndexerIndexProjectionSelector

指定搜索索引中要存储的数据的说明。

SearchIndexerIndexProjectionsParameters

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

SearchIndexerKnowledgeStore

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

SearchIndexerKnowledgeStoreFileProjectionSelector

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

SearchIndexerKnowledgeStoreObjectProjectionSelector

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

SearchIndexerKnowledgeStoreProjection

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

SearchIndexerKnowledgeStoreTableProjectionSelector

描述要存储在 Azure 表中的数据。

SearchIndexerSkillset

技能列表。

SearchResourceEncryptionKey

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

SentimentSkillLanguage

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

SentimentSkillV3

使用文本分析 API 评估非结构化文本,并为每个记录提供情绪标签(如“负”、“中性”和“正”),具体取决于服务在句子和文档级别找到的最高置信度分数。

ShaperSkill

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

SplitSkill

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

SplitSkillLanguage

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

TextSplitMode

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

TextTranslationSkill

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

TextTranslationSkillLanguage

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

VisualFeature

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

WebApiSkill

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

Accept

接受(Accept)首部。

说明
application/json;odata.metadata=minimal

AIServicesAccountIdentity

一个关联技能集的 Azure AI 服务资源的多区域账户。

名称 类型 说明
@odata.type string:

#Microsoft.Azure.Search.AIServicesByIdentity

派生类型的歧视性。

description

string

附加在技能集上的 Azure AI 服务资源描述。

identity SearchIndexerDataIdentity:

用于连接到 AI 服务的用户分配的托管标识。 如果未指定,则使用系统分配的托管标识。 在更新技能组时,如果未指定标识,则该值保持不变。 如果设置为“none”,则清除此属性的值。

subdomainUrl

string

对应的 AI 服务的子域名/Azure AI Services 端点网址。

AIServicesAccountKey

Azure AI服务资源的账户密钥,关联到技能集,用于该资源的子域。

名称 类型 说明
@odata.type string:

#Microsoft.Azure.Search.AIServicesByKey

派生类型的歧视性。

description

string

附加在技能集上的 Azure AI 服务资源描述。

key

string

用于配置附加到技能集上的 Azure AI 服务资源的密钥。

subdomainUrl

string

对应的 AI 服务的子域名/Azure AI Services 端点网址。

AzureOpenAIEmbeddingSkill

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

名称 类型 说明
@odata.type string:

#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill

派生类型的歧视性。

apiKey

string

指定的 Azure OpenAI 资源的 API 密钥。

authIdentity SearchIndexerDataIdentity:

用于出站连接的用户分配的托管标识。

context

string

表示执行操作的级别,例如文档根或文档内容(例如 /document 或 /document/content)。 默认值为 /document。

deploymentId

string

指定资源上的 Azure OpenAI 模型部署的 ID。

description

string

描述技能的说明,描述技能的输入、输出和用法。

dimensions

integer (int32)

输出嵌入应有的维数。 仅在文本嵌入-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

TextEmbeddingAda002 模型。

text-embedding-3-large

TextEmbedding3大型模型。

text-embedding-3-small

TextEmbedding3小型模型。

gpt-5-mini

Gpt5Mini型号。

gpt-5-nano

Gpt5Nano模型。

gpt-5.4-mini

GPT54Mini型号。

gpt-5.4-nano

Gpt54Nano型号。

ChatCompletionCommonModelParameters

聊天完成的通用语言模型参数。 如果省略,则使用默认值。

名称 类型 默认值 说明
frequencyPenalty

number (double)

0

[-2,2] 范围内的浮点数,可减少或增加重复标记的可能性。 默认值为 0。

maxTokens

integer (int32)

要生成的标记的最大数目。

model

string

要使用的模型的名称(例如,“gpt-4o”等)。 如果未指定,则默认值为 null。

presencePenalty

number (double)

0

[-2,2] 范围内的浮动值,根据新代币的现有存在对其进行惩罚。 默认值为 0。

seed

integer (int32)

用于控制确定性输出的随机种子。 如果省略,则使用随机化。

stop

string[]

将切断文本生成的停止序列列表。 默认值为无。

temperature

number (double)

0.7

采样温度。 默认值为 0.7。

ChatCompletionExtraParametersBehavior

规定Azure AI Foundry应如何处理“extraParameters”。 默认为“错误”。

说明
passThrough

将任何额外的参数直接传递给模型。

drop

删除所有额外参数。

error

如果存在任何额外参数,则引发错误。

ChatCompletionResponseFormat

确定应如何序列化语言模型的响应。 默认为“文本”。

名称 类型 默认值 说明
jsonSchemaProperties

ChatCompletionSchemaProperties

扩展属性的开放字典。 如果 'type' == 'json_schema' 则为必填项

type

ChatCompletionResponseFormatType

text

指定 LLM 应如何格式化响应。

ChatCompletionResponseFormatType

指定 LLM 应如何格式化响应。

说明
text

纯文本回复格式。

jsonObject

任意JSON对象响应格式。

jsonSchema

遵循JSON模式的响应格式。

ChatCompletionSchema

定义模型将用于构建其输出的自定义架构的对象。

名称 类型 默认值 说明
additionalProperties

boolean

False

控制对象是否允许包含 JSON Schema 中未定义的其他键/值。 默认值为 false。

properties

string

JSON 格式的字符串,用于定义模型的输出架构的属性和约束。

required

string[]

需要成为模型响应一部分的属性名称数组。 结构化输出必须包含所有属性。

type

string

object

架构表示的类型。 通常是“对象”。 默认值为 'object'。

ChatCompletionSchemaProperties

JSON 模式响应格式的属性。

名称 类型 默认值 说明
description

string

模型将遵循的 json 架构的说明。

name

string

模型将遵循的json模式名称。

schema

ChatCompletionSchema

模式定义。

strict

boolean

True

模型的响应是否应使用结构化输出。 默认值为 true。

ChatCompletionSkill

一项通过 Azure AI Foundry 的聊天完成终端调用语言模型的技能。

名称 类型 默认值 说明
@odata.type string:

#Microsoft.Skills.Custom.ChatCompletionSkill

派生类型的歧视性。

apiKey

string

用于向模型进行身份验证的 API 密钥。 apiKey 和 authIdentity 不能同时指定。

authIdentity SearchIndexerDataIdentity:

用于出站连接的用户分配的托管标识。 如果未指定 authResourceId,则使用系统分配的托管标识。 对索引器的更新(如果未指定标识)时,该值保持不变。 如果设置为“none”,则清除此属性的值。

commonModelParameters

ChatCompletionCommonModelParameters

客户可以调整的通用语言模型参数。 如果省略,将应用合理的违约。

context

string

表示执行操作的级别,例如文档根或文档内容(例如 /document 或 /document/content)。 默认值为 /document。

description

string

描述技能的说明,描述技能的输入、输出和用法。

extraParameters

应追加到聊天完成调用的特定于模型的参数的开放类型字典。 遵循 Azure AI Foundry 的可扩展性模式。

extraParametersBehavior

ChatCompletionExtraParametersBehavior

error

Azure AI Foundry 如何处理额外参数。 默认值为“error”。

inputs

InputFieldMappingEntry[]

技能的输入可以是源数据集中的列,也可以是上游技能的输出。

name

string

唯一标识技能集内的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称,其前缀为字符“#”。

outputs

OutputFieldMappingEntry[]

技能的输出是搜索索引中的字段,或者是另一个技能可以用作输入的值。

responseFormat

ChatCompletionResponseFormat

确定 LLM 应如何格式化其响应。 默认为“文本”响应类型。

uri

string

Web API 的 URL。

CognitiveServicesAccountKey

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

名称 类型 说明
@odata.type string:

#Microsoft.Azure.Search.CognitiveServicesByKey

派生类型的歧视性。

description

string

附加在技能集上的 Azure AI 服务资源描述。

key

string

用于配置附加到技能集上的 Azure AI 服务资源的密钥。

ConditionalSkill

一种技能,使需要布尔操作的方案能够确定要分配给输出的数据。

名称 类型 说明
@odata.type string:

#Microsoft.Skills.Util.ConditionalSkill

派生类型的歧视性。

context

string

表示执行操作的级别,例如文档根或文档内容(例如 /document 或 /document/content)。 默认值为 /document。

description

string

描述技能的说明,描述技能的输入、输出和用法。

inputs

InputFieldMappingEntry[]

技能的输入可以是源数据集中的列,也可以是上游技能的输出。

name

string

唯一标识技能集内的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称,其前缀为字符“#”。

outputs

OutputFieldMappingEntry[]

技能的输出是搜索索引中的字段,或者是另一个技能可以用作输入的值。

ContentUnderstandingSkill

一项利用 Azure AI 内容理解技术处理和提取结构化洞察的技能,使内容丰富且可搜索,从而增强文档索引和检索能力。

名称 类型 说明
@odata.type string:

#Microsoft.Skills.Util.ContentUnderstandingSkill

派生类型的歧视性。

chunkingProperties

ContentUnderstandingSkillChunkingProperties

控制内容分块的基数。

context

string

表示执行操作的级别,例如文档根或文档内容(例如 /document 或 /document/content)。 默认值为 /document。

description

string

描述技能的说明,描述技能的输入、输出和用法。

extractionOptions

ContentUnderstandingSkillExtractionOptions[]

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

inputs

InputFieldMappingEntry[]

技能的输入可以是源数据集中的列,也可以是上游技能的输出。

name

string

唯一标识技能集内的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称,其前缀为字符“#”。

outputs

OutputFieldMappingEntry[]

技能的输出是搜索索引中的字段,或者是另一个技能可以用作输入的值。

ContentUnderstandingSkillChunkingProperties

控制内容分块的基数。

名称 类型 默认值 说明
maximumLength

integer (int32)

最大块长度(以字符为单位)。 默认值为 500。

overlapLength

integer (int32)

在两个文本块之间提供的重叠长度。 默认值为 0。

unit enum:

characters

characters

块的单位。

ContentUnderstandingSkillExtractionOptions

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

说明
images

指定应从文档中提取图像内容。

locationMetadata

指定应从文档中提取位置元数据。

CustomEntity

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

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

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

名称 类型 说明
accentSensitive

boolean

确定别名是否对重音敏感。

caseSensitive

boolean

确定别名是否区分大小写。

fuzzyEditDistance

integer (int32)

确定别名的模糊编辑距离。

text

string

别名的文本。

CustomEntityLookupSkill

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

名称 类型 说明
@odata.type string:

#Microsoft.Skills.Text.CustomEntityLookupSkill

派生类型的歧视性。

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

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

名称 类型 说明
@odata.type string:

#Microsoft.Azure.Search.DefaultCognitiveServices

派生类型的歧视性。

description

string

附加在技能集上的 Azure AI 服务资源描述。

DocumentExtractionSkill

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

名称 类型 说明
@odata.type string:

#Microsoft.Skills.Util.DocumentExtractionSkill

派生类型的歧视性。

configuration

技能配置的字典。

context

string

表示执行操作的级别,例如文档根或文档内容(例如 /document 或 /document/content)。 默认值为 /document。

dataToExtract

string

要为技能提取的数据的类型。 如果未定义,将设置为“contentAndMetadata”。

description

string

描述技能的说明,描述技能的输入、输出和用法。

inputs

InputFieldMappingEntry[]

技能的输入可以是源数据集中的列,也可以是上游技能的输出。

name

string

唯一标识技能集内的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称,其前缀为字符“#”。

outputs

OutputFieldMappingEntry[]

技能的输出是搜索索引中的字段,或者是另一个技能可以用作输入的值。

parsingMode

string

技能的 parsingMode。 如果未定义,将设置为“default”。

DocumentIntelligenceLayoutSkill

一项通过Azure AI服务从丰富流程中文件提取内容和布局信息的技能。

名称 类型 默认值 说明
@odata.type string:

#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill

派生类型的歧视性。

chunkingProperties

DocumentIntelligenceLayoutSkillChunkingProperties

控制内容分块的基数。

context

string

表示执行操作的级别,例如文档根或文档内容(例如 /document 或 /document/content)。 默认值为 /document。

description

string

描述技能的说明,描述技能的输入、输出和用法。

extractionOptions

DocumentIntelligenceLayoutSkillExtractionOptions[]

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

inputs

InputFieldMappingEntry[]

技能的输入可以是源数据集中的列,也可以是上游技能的输出。

markdownHeaderDepth enum:
  • h1
  • h2
  • h3
  • h4
  • h5
  • h6
h6

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

name

string

唯一标识技能集内的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称,其前缀为字符“#”。

outputFormat enum:
  • markdown
  • text
markdown

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

outputMode enum:

oneToMany

oneToMany

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

outputs

OutputFieldMappingEntry[]

技能的输出是搜索索引中的字段,或者是另一个技能可以用作输入的值。

DocumentIntelligenceLayoutSkillChunkingProperties

控制内容分块的基数。

名称 类型 默认值 说明
maximumLength

integer (int32)

最大块长度(以字符为单位)。 默认值为 500。

overlapLength

integer (int32)

在两个文本块之间提供的重叠长度。 默认值为 0。

unit enum:

characters

characters

块的单位。

DocumentIntelligenceLayoutSkillExtractionOptions

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

说明
images

指定应从文档中提取图像内容。

locationMetadata

指定应从文档中提取位置元数据。

EntityCategory

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

说明
location

描述物理位置的实体。

organization

描述组织的实体。

person

描述人员的实体。

quantity

描述数量的实体。

datetime

描述日期和时间的实体。

url

描述 URL 的实体。

email

描述电子邮件地址的实体。

EntityLinkingSkill

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

名称 类型 说明
@odata.type string:

#Microsoft.Skills.Text.V3.EntityLinkingSkill

派生类型的歧视性。

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[]

技能的输出是搜索索引中的字段,或者是另一个技能可以用作输入的值。

EntityRecognitionSkillLanguage

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

说明
ar

阿拉伯语

cs

捷克语

zh-Hans

简体中文

zh-Hant

繁体中文

da

丹麦语

nl

荷兰语

en

英语

fi

芬兰语

fr

法语

de

德语

el

希腊语

hu

匈牙利语

it

意大利语

ja

日语

ko

Korean

no

挪威语(博克马尔)

pl

波兰语

pt-PT

葡萄牙语(葡萄牙)

pt-BR

葡萄牙语(巴西)

ru

俄语

es

西班牙语

sv

瑞典语

tr

土耳其语

EntityRecognitionSkillV3

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

名称 类型 说明
@odata.type string:

#Microsoft.Skills.Text.V3.EntityRecognitionSkill

派生类型的歧视性。

categories

EntityCategory[]

应提取的实体类别的列表。

context

string

表示执行操作的级别,例如文档根或文档内容(例如 /document 或 /document/content)。 默认值为 /document。

defaultLanguageCode

EntityRecognitionSkillLanguage

一个值,该值指示要使用的语言代码。 默认值为 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

附加信息。

type

string

附加信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

所有 Azure 资源管理器 API 的通用错误响应,用于返回失败操作的错误细节。 (这也遵循 OData 错误响应格式)。

名称 类型 说明
error

ErrorDetail

错误对象。

ImageAnalysisSkill

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

名称 类型 说明
@odata.type string:

#Microsoft.Skills.Vision.ImageAnalysisSkill

派生类型的歧视性。

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

俄语

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

派生类型的歧视性。

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

俄语

es

西班牙语

sv

瑞典语

LanguageDetectionSkill

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

名称 类型 说明
@odata.type string:

#Microsoft.Skills.Text.LanguageDetectionSkill

派生类型的歧视性。

context

string

表示执行操作的级别,例如文档根或文档内容(例如 /document 或 /document/content)。 默认值为 /document。

defaultCountryHint

string

如果语言检测模型无法消除语言歧义,则将其用作语言检测模型的提示的国家/地区代码。

description

string

描述技能的说明,描述技能的输入、输出和用法。

inputs

InputFieldMappingEntry[]

技能的输入可以是源数据集中的列,也可以是上游技能的输出。

modelVersion

string

调用文本分析服务时要使用的模型版本。 如果未指定,它将默认为最新可用。 除非绝对必要,否则建议不要指定此值。

name

string

唯一标识技能集内的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称,其前缀为字符“#”。

outputs

OutputFieldMappingEntry[]

技能的输出是搜索索引中的字段,或者是另一个技能可以用作输入的值。

MergeSkill

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

名称 类型 默认值 说明
@odata.type string:

#Microsoft.Skills.Text.MergeSkill

派生类型的歧视性。

context

string

表示执行操作的级别,例如文档根或文档内容(例如 /document 或 /document/content)。 默认值为 /document。

description

string

描述技能的说明,描述技能的输入、输出和用法。

inputs

InputFieldMappingEntry[]

技能的输入可以是源数据集中的列,也可以是上游技能的输出。

insertPostTag

string

标记指示合并文本的末尾。 默认情况下,标记是一个空空间。

insertPreTag

string

标记指示合并文本的开头。 默认情况下,标记是一个空空间。

name

string

唯一标识技能集内的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称,其前缀为字符“#”。

outputs

OutputFieldMappingEntry[]

技能的输出是搜索索引中的字段,或者是另一个技能可以用作输入的值。

OcrLineEnding

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

说明
space

行由单个空格字符分隔。

carriageReturn

行由回车符(“\r”)字符分隔。

lineFeed

行由单个换行符分隔(“\n”) 字符。

carriageReturnLineFeed

行由回车符和换行符(“\r\n”)字符分隔。

OcrSkill

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

名称 类型 默认值 说明
@odata.type string:

#Microsoft.Skills.Vision.OcrSkill

派生类型的歧视性。

context

string

表示执行操作的级别,例如文档根或文档内容(例如 /document 或 /document/content)。 默认值为 /document。

defaultLanguageCode

OcrSkillLanguage

一个值,该值指示要使用的语言代码。 默认值为 en

description

string

描述技能的说明,描述技能的输入、输出和用法。

detectOrientation

boolean

False

指示打开或不打开方向检测的值。 默认值为 false。

inputs

InputFieldMappingEntry[]

技能的输入可以是源数据集中的列,也可以是上游技能的输出。

lineEnding

OcrLineEnding

定义要在 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

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

多格拉语(天城文)

nl

荷兰语

en

英语

myv

埃尔齐亚 (西里尔文)

et

爱沙尼亚语

fo

法罗语

fj

斐济

fil

菲律宾语

fi

芬兰语

fr

法语

fur

Frulian

gag

加古兹 (拉丁语)

gl

加利西亚语

de

德语

gil

吉尔伯特斯语

gon

贡迪语(天城文)

el

希腊语

kl

格陵兰语

gvr

古隆语(德瓦纳加里)

ht

海地克里奥尔语

hlb

哈尔比语(天城文)

hni

哈尼

bgc

哈扬维

haw

夏威夷语

hi

印地语

mww

白苗语(拉丁字母)

hoc

何(德瓦纳吉里)

hu

匈牙利语

is

Icelandic

smn

Inari Sami

id

印度尼西亚语

ia

Interlingua

iu

Inuktitut (拉丁语)

ga

爱尔兰语

it

意大利语

ja

日语

Jns

贾恩萨里语(天城文)

jv

爪哇语

kea

卡布维尔第亚努

kac

卡钦(拉丁语)

xnr

康格里语(天城文)

krc

Karachay-Balkar

kaa-cyrl

Kara-Kalpak(西里尔文)

kaa

Kara-Kalpak (拉丁语)

csb

卡舒比语

kk-cyrl

哈萨克语(西里尔文)

kk-latn

哈萨克语(拉丁语)

klr

卡林

kha

卡西

quc

K'iche'

ko

Korean

kfq

Korku

kpy

科里亚克

kos

Kosraean

kum

库梅克语(西里尔语)

ku-arab

库尔德语(阿拉伯语)

ku-latn

库尔德语 (拉丁语)

kru

库鲁克语(天城文)

ky

吉尔吉斯语(西里尔语)

lkt

拉科他州

la

拉丁语

lt

立陶宛语

dsb

下索布尼语

smj

Lule Sami

lb

Luxembourgish

bfz

玛哈苏帕哈里(天城文)

ms

马来语(拉丁语)

mt

马耳他语

kmj

马尔托语(天城文)

gv

马恩岛语

mi

毛利语

mr

马拉地语

mn

蒙古语(西里尔文)

cnr-cyrl

黑山(西里尔文)

cnr-latn

蒙特内哥罗语(拉丁语)

nap

那不勒斯

ne

尼泊尔

niu

纽安

nog

Nogay

sme

北萨米语(拉丁语)

nb

挪威语

no

挪威语

oc

奥克西坦语

os

奥塞梯语

ps

普什图语

fa

波斯语

pl

波兰语

pt

Portuguese

pa

旁遮普语(阿拉伯语)

ksh

里普阿里安方言

ro

罗马尼亚语

rm

罗曼什语

ru

俄语

sck

萨德里语(天城文)

sm

萨摩亚语(拉丁语)

sa

圣文(德瓦纳吉里)

sat

桑塔利(德瓦纳吉里)

sco

苏格兰

gd

苏格兰盖尔语

sr

塞尔维亚语(拉丁语)

sr-Cyrl

塞尔维亚语(西里尔文)

sr-Latn

塞尔维亚语(拉丁语)

xsr

夏尔巴语(天城文)

srx

西尔毛里语(天城文)

sms

Skolt Sami

sk

斯洛伐克语

sl

斯洛文尼亚语

so

索马里语(阿拉伯语)

sma

南萨米

es

西班牙语

sw

斯瓦希里语(拉丁语)

sv

瑞典语

tg

塔吉克语(西里尔文)

tt

鞑靼语(拉丁语)

tet

Tetum

thf

坦格米

to

汤加

tr

土耳其语

tk

土库曼语(拉丁语)

tyv

图万

hsb

上索比安

ur

乌都语

ug

维吾尔语(阿拉伯语)

uz-arab

乌兹别克语(阿拉伯语)

uz-cyrl

乌兹别克语 (西里尔文)

uz

乌兹别克语(拉丁文)

vo

Volapük

wae

瓦尔瑟

cy

威尔士语

fy

西弗里斯兰语

yua

尤卡特克·玛雅

za

壮族

zu

祖鲁语

unk

未知(全部)

OutputFieldMappingEntry

技能的输出字段映射。

名称 类型 说明
name

string

技能定义的输出的名称。

targetName

string

输出的目标名称。 它是可选的,默认为 name。

PIIDetectionSkill

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

名称 类型 说明
@odata.type string:

#Microsoft.Skills.Text.PIIDetectionSkill

派生类型的歧视性。

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”的形式分配给搜索服务。

SearchIndexerIndexProjection

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

名称 类型 说明
parameters

SearchIndexerIndexProjectionsParameters

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

selectors

SearchIndexerIndexProjectionSelector[]

要对二级搜索索引执行的投影列表。

SearchIndexerIndexProjectionSelector

指定搜索索引中要存储的数据的说明。

名称 类型 说明
mappings

InputFieldMappingEntry[]

投影的映射,或应将哪个源映射到目标索引中的哪个字段。

parentKeyFieldName

string

搜索索引中要将父文档的键值映射到的字段的名称。 必须是可筛选的字符串字段,而不是键字段。

sourceContext

string

投影的源上下文。 表示文档将拆分为多个子文档的基数。

targetIndexName

string

要投影到的搜索索引的名称。 必须具有设置了“关键字”分析器的键字段。

SearchIndexerIndexProjectionsParameters

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

名称 类型 说明
projectionMode

IndexProjectionMode

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

SearchIndexerKnowledgeStore

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

名称 类型 说明
identity SearchIndexerDataIdentity:

用户指定的管理身份用于编写知识库预测时连接 Azure 存储。 如果连接字符串表示身份(ResourceId)但未指定,则使用系统分配的托管身份。 对索引器的更新(如果未指定标识)时,该值保持不变。 如果设置为“none”,则清除此属性的值。

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 容器。

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:

关于在技能运行时使用的Azure AI服务的详细信息。

description

string

技能集的说明。

encryptionKey

SearchResourceEncryptionKey

描述在 Azure 密钥保管库 中创建的加密密钥。 当你想完全确保没有人,甚至不包括Microsoft,能解密你的技能组定义时,这个密钥用于为你的技能组定义提供额外的静止加密层。 加密技能集定义后,它将始终保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果需要轮换加密密钥,可以根据需要更改此属性;技能组定义将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务,并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。

indexProjections

SearchIndexerIndexProjection

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

knowledgeStore

SearchIndexerKnowledgeStore

对丰富数据的 Azure blob、表格或文件的额外投影定义。

name

string

技能集的名称。

skills SearchIndexerSkill[]:

技能集中的技能列表。

SearchResourceEncryptionKey

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

名称 类型 说明
accessCredentials.applicationId

string

向 AAD 应用程序 ID 授予对静态数据加密时要使用的 Azure 密钥保管库 所需的访问权限。 应用程序 ID 不应与 AAD 应用程序的对象 ID 混淆。

accessCredentials.applicationSecret

string

指定的 AAD 应用程序的身份验证密钥。

identity SearchIndexerDataIdentity:

用于此加密密钥的显式托管标识。 如果未指定并且访问凭据属性为 null,则使用系统分配的托管标识。 更新资源时,如果未指定显式标识,则保持不变。 如果指定了“none”,则清除此属性的值。

keyVaultKeyName

string

用于加密静态数据的 Azure 密钥保管库 密钥的名称。

keyVaultKeyVersion

string

用于加密静态数据的 Azure 密钥保管库 密钥的版本。

keyVaultUri

string

Azure 密钥保管库 的 URI(也称为 DNS 名称),其中包含用于加密静态数据的密钥。 示例 URI 可能是 https://my-keyvault-name.vault.azure.net

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

派生类型的歧视性。

context

string

表示执行操作的级别,例如文档根或文档内容(例如 /document 或 /document/content)。 默认值为 /document。

defaultLanguageCode

SentimentSkillLanguage

一个值,该值指示要使用的语言代码。 默认值为 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

派生类型的歧视性。

context

string

表示执行操作的级别,例如文档根或文档内容(例如 /document 或 /document/content)。 默认值为 /document。

description

string

描述技能的说明,描述技能的输入、输出和用法。

inputs

InputFieldMappingEntry[]

技能的输入可以是源数据集中的列,也可以是上游技能的输出。

name

string

唯一标识技能集内的技能的名称。 未定义名称的技能将在技能数组中为其基于 1 的索引提供默认名称,其前缀为字符“#”。

outputs

OutputFieldMappingEntry[]

技能的输出是搜索索引中的字段,或者是另一个技能可以用作输入的值。

SplitSkill

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

名称 类型 说明
@odata.type string:

#Microsoft.Skills.Text.SplitSkill

派生类型的歧视性。

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

俄语

sk

斯洛伐克语

sl

斯洛文尼亚语

sr

塞尔维亚语

sv

瑞典语

tr

土耳其语

ur

乌都语

zh

中文(简体中文)

TextSplitMode

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

说明
pages

将文本拆分为单个页面。

sentences

将文本拆分为单个句子。

TextTranslationSkill

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

名称 类型 说明
@odata.type string:

#Microsoft.Skills.Text.TranslationSkill

派生类型的歧视性。

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

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

Queretaro Otomi

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

派生类型的歧视性。

authIdentity SearchIndexerDataIdentity:

用于出站连接的用户分配的托管标识。 如果未指定 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。