Indexes - Create

SearchIndex

ErrorResponse

错误响应。

#Microsoft.Azure.Search.AsciiFoldingTokenFilter

指定令牌筛选器类型的 URI 片段。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

boolean

指示是否保留原始令牌的值。 默认值为 false。

string

向 Azure Key Vault 授予所需的访问权限的 AAD 应用程序 ID，该权限将在加密静态数据时使用。 应用程序 ID 不应与 AAD 应用程序的对象 ID 混淆。

string

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

#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill

指定技能类型的 URI 片段。

string

指定 Azure OpenAI 资源的 API 密钥。

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

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

string

表示执行作的级别，例如文档根目录或文档内容（例如，/document 或 /document/content）。 默认值为 /document。

string

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

string

描述技能的描述，描述技能的输入、输出和用法。

integer (int32)

生成的输出嵌入应有的维度数。 仅在 text-embedding-3 及更高版本中受支持。

InputFieldMappingEntry[]

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

AzureOpenAIModelName

部署在提供的 deploymentId 路径上的嵌入模型的名称。

string

在技能集中唯一标识它的技能的名称。 未定义名称的技能将在技能数组中为其从 1 开始的索引的默认名称，前缀为字符“#”。

OutputFieldMappingEntry[]

技能的输出要么是搜索索引中的字段，要么是可作为其他技能输入使用的值。

string (uri)

Azure OpenAI 资源的资源 URI。

string

指定 Azure OpenAI 资源的 API 密钥。

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

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

string

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

AzureOpenAIModelName

部署在提供的 deploymentId 路径上的嵌入模型的名称。

string (uri)

Azure OpenAI 资源的资源 URI。

AzureOpenAIEmbeddingSkill

包含特定于 Azure OpenAI 嵌入矢量化的参数。

azureOpenAI

配置为用于向量搜索的矢量化方法的名称。

string

要与此特定矢量化方法关联的名称。

binaryQuantization

配置为与矢量搜索一起使用的压缩方法类型的名称。

string

要与此特定配置关联的名称。

RescoringOptions

包含重新评分的选项。

integer (int32)

要截断向量的维数。 截断向量可以减小向量的大小和搜索期间需要传输的数据量。 这可以节省存储成本并提高搜索性能，但代价是召回率。 它只能用于使用套娃表示学习 （MRL） 训练的嵌入，例如 OpenAI text-embedding-3-large （small）。 默认值为 null，这意味着没有截断。

#Microsoft.Azure.Search.BM25Similarity

number (double)

此属性控制文档长度如何影响相关性分数。 默认情况下，使用值 0.75。 值 0.0 表示不应用长度规范化，而值 1.0 表示分数按文档长度完全规范化。

number (double)

此属性控制每个匹配术语的术语频率与文档查询对的最终相关性分数之间的缩放函数。 默认情况下，使用值 1.2。 值 0.0 表示分数不会随着术语频率的增加而缩放。

#Microsoft.Azure.Search.CjkBigramTokenFilter

指定令牌筛选器类型的 URI 片段。

CjkBigramTokenFilterScripts[]

要忽略的脚本。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

boolean

一个值，指示是同时输出单元组和双元组（如果为 true），还是仅输出双元组（如果为 false）。 默认值为 false。

#Microsoft.Azure.Search.ClassicSimilarity

#Microsoft.Azure.Search.ClassicTokenizer

指定分词器类型的 URI 片段。

integer (int32)

最大令牌长度。 默认值为 255。 长度超过最大长度的令牌将被拆分。 可以使用的最大令牌长度为 300 个字符。

string

分词器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.CommonGramTokenFilter

指定令牌筛选器类型的 URI 片段。

string[]

常用词集。

boolean

指示常用单词匹配是否不区分大小写的值。 默认值为 false。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

boolean

指示令牌筛选器是否处于查询模式的值。 在查询模式下，令牌筛选器会生成二元组，然后删除常用单词和单个术语，然后删除一个常用单词。 默认值为 false。

string[]

JavaScript 代码将被授予对索引访问权限的来源列表。 可以包含 {protocol}：//{fully-qualified-domain-name}[：{port#}] 形式的主机列表，或单个“*”以允许所有源（不推荐）。

integer (int64)

浏览器应缓存 CORS 预检响应的持续时间。 默认为 5 分钟。

#Microsoft.Azure.Search.CustomAnalyzer

指定分析器类型的 URI 片段。

CharFilterName[]

用于在分词器处理输入文本之前准备输入文本的字符过滤器列表。 例如，它们可以替换某些字符或符号。 筛选器按列出的顺序运行。

string

分析器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

TokenFilterName[]

用于过滤掉或修改分词器生成的令牌的令牌过滤器列表。 例如，您可以指定一个小写过滤器，将所有字符转换为小写。 筛选器按列出的顺序运行。

LexicalTokenizerName

用于将连续文本划分为一系列标记的标记器的名称，例如将句子分解为单词。

#Microsoft.Azure.Search.CustomNormalizer

指定规范化程序类型的 URI 片段。

CharFilterName[]

用于在处理输入文本之前准备输入文本的字符过滤器列表。 例如，它们可以替换某些字符或符号。 筛选器按列出的顺序运行。

string

规范化器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。 它不能以“.microsoft”或“.lucene”结尾，也不能命名为“asciifolding”、“standard”、“lowercase”、“uppercase”或“elision”。

TokenFilterName[]

用于过滤或修改输入令牌的令牌筛选器列表。 例如，您可以指定一个小写过滤器，将所有字符转换为小写。 筛选器按列出的顺序运行。

#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter

指定令牌筛选器类型的 URI 片段。

integer (int32)

最大子字大小。 仅输出短于此的子词。 默认为 15. 最大值为 300。

integer (int32)

最小子字大小。 仅输出比此长度更长的子词。 默认值为 2。 最大值为 300。

integer (int32)

最小字数。 只有比这更长的单词才会被处理。 默认值为 5。 最大值为 300。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

boolean

指示是否仅将最长的匹配子词添加到输出中的值。 默认值为 false。

string[]

要匹配的单词列表。

number (double)

原始分数的乘数。 必须是不等于 1.0 的正数。

DistanceScoringParameters

距离评分函数的参数值。

string

用作评分函数输入的字段的名称。

ScoringFunctionInterpolation

一个值，指示如何在文档分数之间插值提升;默认为“线性”。

distance

指示要使用的函数类型。 有效值包括大小、新鲜度、距离和标签。 函数类型必须是小写的。

number (double)

距提升范围结束的参考位置的距离（以公里为单位）。

string

在搜索查询中传递的用于指定引用位置的参数的名称。

#Microsoft.Azure.Search.EdgeNGramTokenFilter

指定令牌筛选器类型的 URI 片段。

integer (int32)

最大 n-gram 长度。 默认值为 2。

integer (int32)

最小 n-gram 长度。 默认值为 1。 必须小于 maxGram 的值。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

EdgeNGramTokenFilterSide

指定应从输入的哪一侧生成 n-gram。 默认值为“front”。

#Microsoft.Azure.Search.EdgeNGramTokenFilterV2

指定令牌筛选器类型的 URI 片段。

integer (int32)

最大 n-gram 长度。 默认值为 2。 最大值为 300。

integer (int32)

最小 n-gram 长度。 默认值为 1。 最大值为 300。 必须小于 maxGram 的值。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

EdgeNGramTokenFilterSide

指定应从输入的哪一侧生成 n-gram。 默认值为“front”。

#Microsoft.Azure.Search.EdgeNGramTokenizer

指定分词器类型的 URI 片段。

integer (int32)

最大 n-gram 长度。 默认值为 2。 最大值为 300。

integer (int32)

最小 n-gram 长度。 默认值为 1。 最大值为 300。 必须小于 maxGram 的值。

string

分词器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

TokenCharacterKind[]

要保留在令牌中的字符类。

#Microsoft.Azure.Search.ElisionTokenFilter

指定令牌筛选器类型的 URI 片段。

string[]

要删除的文章集。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

object

其他信息。

string

其他信息类型。

ErrorAdditionalInfo[]

错误附加信息。

string

错误代码。

ErrorDetail[]

错误详细信息。

string

错误消息。

string

错误目标。

ErrorDetail

错误对象。

VectorSearchAlgorithmMetric

用于向量比较的相似度指标。

ExhaustiveKnnParameters

包含特定于穷尽 KNN 算法的参数。

exhaustiveKnn

配置为用于矢量搜索的算法类型的名称。

string

要与此特定配置关联的名称。

number (double)

原始分数的乘数。 必须是不等于 1.0 的正数。

string

用作评分函数输入的字段的名称。

FreshnessScoringParameters

新鲜度评分函数的参数值。

ScoringFunctionInterpolation

一个值，指示如何在文档分数之间插值提升;默认为“线性”。

freshness

指示要使用的函数类型。 有效值包括大小、新鲜度、距离和标签。 函数类型必须是小写的。

string (duration)

特定文档的加速将停止的到期期限。

integer (int32)

包含最近邻的动态列表的大小，在索引时使用。 增加此参数可能会提高索引质量，但代价是索引时间增加。 在某个时候，增加该参数会导致收益递减。

integer (int32)

包含最近邻的动态列表的大小，在搜索时使用。 增加此参数可能会改善搜索结果，但代价是搜索速度变慢。 在某个时候，增加该参数会导致收益递减。

integer (int32)

在构造期间为每个新元素创建的双向链接数。 增加此参数值可能会提高召回率并减少具有高内在维数的数据集的检索时间，但代价是内存消耗增加和索引时间延长。

VectorSearchAlgorithmMetric

用于向量比较的相似度指标。

HnswParameters

包含特定于 HNSW 算法的参数。

hnsw

配置为用于矢量搜索的算法类型的名称。

string

要与此特定配置关联的名称。

InputFieldMappingEntry[]

创建复杂类型时使用的递归输入。

string

输入的名称。

string

输入的源。

string

用于选择递归输入的源上下文。

#Microsoft.Azure.Search.KeepTokenFilter

指定令牌筛选器类型的 URI 片段。

string[]

要保留的单词列表。

boolean

指示是否先将所有单词小写的值。 默认值为 false。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.KeywordMarkerTokenFilter

指定令牌筛选器类型的 URI 片段。

boolean

指示是否忽略大小写的值。 如果为 true，则所有单词首先转换为小写。 默认值为 false。

string[]

要标记为关键字的单词列表。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.KeywordTokenizer

指定分词器类型的 URI 片段。

integer (int32)

读取缓冲区大小（以字节为单位）。 默认值为 256。

string

分词器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.KeywordTokenizerV2

指定分词器类型的 URI 片段。

integer (int32)

最大令牌长度。 默认值为 256。 长度超过最大长度的令牌将被拆分。 可以使用的最大令牌长度为 300 个字符。

string

分词器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.LengthTokenFilter

指定令牌筛选器类型的 URI 片段。

integer (int32)

最大长度（以字符为单位）。 默认值和最大值为 300。

integer (int32)

最小长度（以字符为单位）。 默认为 0。 最大值为 300。 必须小于 max 的值。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.LimitTokenFilter

指定令牌筛选器类型的 URI 片段。

boolean

一个值，指示即使达到 maxTokenCount，是否也必须使用输入中的所有令牌。 默认值为 false。

integer (int32)

要生成的最大令牌数。 默认值为 1。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.StandardAnalyzer

指定分析器类型的 URI 片段。

integer (int32)

最大令牌长度。 默认值为 255。 长度超过最大长度的令牌将被拆分。 可以使用的最大令牌长度为 300 个字符。

string

分析器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

string[]

停用词列表。

#Microsoft.Azure.Search.StandardTokenizer

指定分词器类型的 URI 片段。

integer (int32)

最大令牌长度。 默认值为 255。 长度超过最大长度的令牌将被拆分。

string

分词器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.StandardTokenizerV2

指定分词器类型的 URI 片段。

integer (int32)

最大令牌长度。 默认值为 255。 长度超过最大长度的令牌将被拆分。 可以使用的最大令牌长度为 300 个字符。

string

分词器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

number (double)

原始分数的乘数。 必须是不等于 1.0 的正数。

string

用作评分函数输入的字段的名称。

ScoringFunctionInterpolation

一个值，指示如何在文档分数之间插值提升;默认为“线性”。

MagnitudeScoringParameters

幅度评分函数的参数值。

magnitude

指示要使用的函数类型。 有效值包括大小、新鲜度、距离和标签。 函数类型必须是小写的。

number (double)

提升结束的字段值。

number (double)

开始提升的字段值。

boolean

指示是否对超出范围结束值的字段值应用恒定提升的值;默认值为 false。

#Microsoft.Azure.Search.MappingCharFilter

指定字符过滤器类型的 URI 片段。

string[]

以下格式的映射列表：“a=>b”（字符“a”的所有匹配项都将替换为字符“b”）。

string

字符过滤器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer

指定分词器类型的 URI 片段。

boolean

指示如何使用分词器的值。 如果用作搜索分词器，则设置为 true，如果用作索引分词器，则设置为 false。 默认值为 false。

MicrosoftStemmingTokenizerLanguage

要使用的语言。 默认值为英语。

integer (int32)

最大令牌长度。 长度超过最大长度的令牌将被拆分。 可以使用的最大令牌长度为 300 个字符。 长度超过 300 个字符的令牌首先拆分为长度为 300 的令牌，然后根据设置的最大令牌长度拆分每个令牌。 默认值为 255。

string

分词器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.MicrosoftLanguageTokenizer

指定分词器类型的 URI 片段。

boolean

指示如何使用分词器的值。 如果用作搜索分词器，则设置为 true，如果用作索引分词器，则设置为 false。 默认值为 false。

MicrosoftTokenizerLanguage

要使用的语言。 默认值为英语。

integer (int32)

最大令牌长度。 长度超过最大长度的令牌将被拆分。 可以使用的最大令牌长度为 300 个字符。 长度超过 300 个字符的令牌首先拆分为长度为 300 的令牌，然后根据设置的最大令牌长度拆分每个令牌。 默认值为 255。

string

分词器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.NGramTokenFilter

指定令牌筛选器类型的 URI 片段。

integer (int32)

最大 n-gram 长度。 默认值为 2。

integer (int32)

最小 n-gram 长度。 默认值为 1。 必须小于 maxGram 的值。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.NGramTokenFilterV2

指定令牌筛选器类型的 URI 片段。

integer (int32)

最大 n-gram 长度。 默认值为 2。 最大值为 300。

integer (int32)

最小 n-gram 长度。 默认值为 1。 最大值为 300。 必须小于 maxGram 的值。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.NGramTokenizer

指定分词器类型的 URI 片段。

integer (int32)

最大 n-gram 长度。 默认值为 2。 最大值为 300。

integer (int32)

最小 n-gram 长度。 默认值为 1。 最大值为 300。 必须小于 maxGram 的值。

string

分词器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

TokenCharacterKind[]

要保留在令牌中的字符类。

string

技能定义的输出的名称。

string

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

#Microsoft.Azure.Search.PathHierarchyTokenizerV2

指定分词器类型的 URI 片段。

string (char)

要使用的分隔符。 默认值为“/”。

integer (int32)

最大令牌长度。 默认值和最大值为 300。

string

分词器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

string (char)

如果设置，则替换分隔符的值。 默认值为“/”。

boolean

指示是否以相反顺序生成令牌的值。 默认值为 false。

integer (int32)

要跳过的初始令牌数。 默认为 0。

#Microsoft.Azure.Search.PatternAnalyzer

指定分析器类型的 URI 片段。

RegexFlags

正则表达式标志。

boolean

指示术语是否应小写的值。 默认值为 true。

string

分析器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

string

用于匹配标记分隔符的正则表达式模式。 默认是匹配一个或多个非单词字符的表达式。

string[]

停用词列表。

#Microsoft.Azure.Search.PatternCaptureTokenFilter

指定令牌筛选器类型的 URI 片段。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

string[]

要与每个标记匹配的模式列表。

boolean

一个值，指示是否返回原始标记，即使其中一个模式匹配。 默认值为 true。

#Microsoft.Azure.Search.PatternReplaceCharFilter

指定字符过滤器类型的 URI 片段。

string

字符过滤器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

string

正则表达式模式。

string

替换文本。

#Microsoft.Azure.Search.PatternReplaceTokenFilter

指定令牌筛选器类型的 URI 片段。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

string

正则表达式模式。

string

替换文本。

#Microsoft.Azure.Search.PatternTokenizer

指定分词器类型的 URI 片段。

RegexFlags

正则表达式标志。

integer (int32)

正则表达式模式中匹配组的从零开始的序号，要提取到标记中。 如果要使用整个模式将输入拆分为标记，则使用 -1，而不考虑匹配的组。 默认值为 -1。

string

分词器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

string

用于匹配标记分隔符的正则表达式模式。 默认是匹配一个或多个非单词字符的表达式。

#Microsoft.Azure.Search.PhoneticTokenFilter

指定令牌筛选器类型的 URI 片段。

PhoneticEncoder

要使用的语音编码器。 默认值为“metaphone”。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

boolean

指示编码令牌是否应替换原始令牌的值。 如果为 false，则将编码标记添加为同义词。 默认值为 true。

SemanticField[]

定义要用于语义排名、标题、突出显示和答案的内容字段。 为获得最佳结果，所选字段应包含自然语言形式的文本。 数组中字段的顺序表示它们的优先级。 如果内容很长，优先级较低的字段可能会被截断。

SemanticField[]

定义要用于语义排名、标题、突出显示和答案的关键字字段。 为了获得最佳结果，所选字段应包含关键字列表。 数组中字段的顺序表示它们的优先级。 如果内容很长，优先级较低的字段可能会被截断。

SemanticField

定义要用于语义排名、标题、突出显示和答案的标题字段。 如果索引中没有标题字段，请将其留空。

number (double)

默认过采样因子。 过采样检索更多的潜在文档集，以抵消由于量化而造成的分辨率损失。 这增加了将在全精度向量上重新评分的结果集。 最小值为 1，表示没有过采样 （1x）。 只有当 'enableRescoring' 为 true 时，才能设置此参数。 较高的值会以延迟为代价提高召回率。

boolean

如果设置为 true，则在对压缩向量进行初始搜索后，将使用全精度向量重新计算相似性分数。 这将以延迟为代价提高召回率。

VectorSearchCompressionRescoreStorageMethod

控制原始矢量的存储方法。 此设置是不可变的。

VectorSearchCompressionTargetDataType

压缩向量值的量化数据类型。

scalarQuantization

配置为与矢量搜索一起使用的压缩方法类型的名称。

string

要与此特定配置关联的名称。

RescoringOptions

包含重新评分的选项。

ScalarQuantizationParameters

包含特定于标量量化的参数。

integer (int32)

要截断向量的维数。 截断向量可以减小向量的大小和搜索期间需要传输的数据量。 这可以节省存储成本并提高搜索性能，但代价是召回率。 它只能用于使用套娃表示学习 （MRL） 训练的嵌入，例如 OpenAI text-embedding-3-large （small）。 默认值为 null，这意味着没有截断。

ScoringFunctionAggregation

指示如何组合各个评分函数的结果的值。 默认为“Sum”。 如果没有评分函数，则忽略。

• DistanceScoringFunction[]
• FreshnessScoringFunction[]
• MagnitudeScoringFunction[]
• TagScoringFunction[]

影响文档评分的函数集合。

string

评分配置文件的名称。

TextWeights

根据某些索引字段中的文本匹配提高评分的参数。

LexicalAnalyzerName

要用于字段的分析器的名称。 此选项只能与可搜索字段一起使用，不能与 searchAnalyzer 或 indexAnalyzer 一起设置。 一旦选择了分析器，就无法针对该字段进行更改。 对于复杂字段，必须为 null。

integer (int32)

矢量场的维数。

boolean

指示是否启用在分面查询中引用字段的值。 通常在按类别包含命中次数的搜索结果展示中使用（例如，搜索数码相机并按品牌、像素、价格等查看命中）。 对于复杂字段，此属性必须为 null。 Edm.GeographyPoint 或 Collection（Edm.GeographyPoint） 类型的字段不能是可分面的。 对于所有其他简单字段，默认值为 true。

SearchField[]

如果子字段是类型为 Edm.ComplexType 或 Collection（Edm.ComplexType） 的字段，则为子字段列表。 对于简单字段，必须为 null 或空。

boolean

指示是否启用在$filter查询中引用该字段的值。 filterable 与 searchable 在字符串的处理方式上有所不同。 可筛选的 Edm.String 或 Collection（Edm.String） 类型的字段不会进行断词处理，因此比较仅用于完全匹配。 例如，如果将这样的字段 f 设置为“sunny day”，则 $filter=f eq 'sunny' 将找不到匹配项，但 $filter=f eq 'sunny day' 会找到匹配项。 对于复杂字段，此属性必须为 null。 对于简单字段，默认值为 true，对于复杂字段，默认值为 null。

LexicalAnalyzerName

在为字段编制索引时使用的分析器的名称。 此选项只能用于可搜索字段。 它必须与 searchAnalyzer 一起设置，不能与 analyzer 选项一起设置。 此属性不能设置为语言分析器的名称;如果需要语言分析器，请改用 analyzer 属性。 一旦选择了分析器，就无法针对该字段进行更改。 对于复杂字段，必须为 null。

boolean

指示该字段是否唯一标识索引中的文档的值。 必须选择每个索引中只有一个顶级字段作为键字段，并且该字段必须是 Edm.String 类型。 键字段可用于直接查找文档并更新或删除特定文档。 对于简单字段，默认值为 false，对于复杂字段，默认值为 null。

string

字段的名称，在索引或父字段的字段集合中必须是唯一的。

LexicalNormalizerName

要用于字段的规范化器的名称。 此选项只能用于启用了可过滤、可排序或可分面的字段。 选择归一化器后，无法为字段更改它。 对于复杂字段，必须为 null。

boolean

指示是否可以在搜索结果中返回该字段的值。 如果要将字段（例如边距）用作筛选、排序或评分机制，但不希望该字段对最终用户可见，则可以禁用此选项。 对于键字段，此属性必须为 true，对于复杂字段，此属性必须为 null。 可以在现有字段上更改此属性。 启用此属性不会导致索引存储要求增加。 对于简单字段，默认值为 true，对于向量字段为 false，对于复杂字段，默认值为 null。

LexicalAnalyzerName

在搜索字段时使用的分析器的名称。 此选项只能用于可搜索字段。 它必须与 indexAnalyzer 一起设置，不能与 analyzer 选项一起设置。 此属性不能设置为语言分析器的名称;如果需要语言分析器，请改用 analyzer 属性。 可以在现有字段上更新此分析器。 对于复杂字段，必须为 null。

boolean

指示字段是否可全文搜索的值。 这意味着它将在索引过程中进行诸如断字等分析。 如果将可搜索字段设置为“sunny day”等值，则在内部它将拆分为单独的标记“sunny”和“day”。 这实现了对这些词的全文搜素。 默认情况下，可以搜索 Edm.String 或 Collection（Edm.String） 类型的字段。 对于其他非字符串数据类型的简单字段，此属性必须为 false，对于复杂字段，此属性必须为 null。 注意：可搜索字段会占用索引中的额外空间，以容纳用于全文搜索的字段值的其他标记化版本。 如果要节省索引中的空间，并且不需要在搜索中包含字段，请将 searchable 设置为 false。

boolean

指示是否启用在$orderby表达式中引用字段的值。 默认情况下，搜索引擎按分数对结果进行排序，但在许多体验中，用户会希望按文档中的字段进行排序。 仅当简单字段是单值的（它在父文档的作用域中具有单个值）时，它才能进行排序。 简单集合字段不能排序，因为它们是多值的。 复杂集合的简单子字段也是多值的，因此无法排序。 无论是直接父字段还是上级字段，都是如此，这就是复杂的集合。 复杂字段不能进行排序，并且此类字段的 sortable 属性必须为 null。 对于单值简单字段，sortable 的默认值为 true，对于多值简单字段为 false，对于复杂字段为 null。

boolean

一个不可变值，指示该字段是否将单独保留在磁盘上以在搜索结果中返回。 如果您不打算在搜索响应中返回字段内容以节省存储开销，则可以禁用此选项。 这只能在索引创建期间设置，并且只能针对向量字段进行设置。 不能更改现有字段的此属性，也不能将新字段设置为 false。 如果此属性设置为 false，则属性“retrievable”也必须设置为 false。 对于键字段、新字段和非向量字段，此属性必须为 true 或未设置，对于复杂字段必须为 null。 禁用此属性将减少索引存储要求。 对于矢量场，默认值为 true。

string[]

要与此字段关联的同义词映射的名称列表。 此选项只能用于可搜索字段。 目前每个字段仅支持一个同义词映射。 将同义词映射分配给字段可确保使用同义词映射中的规则在查询时扩展针对该字段的查询词。 可以在现有字段上更改此属性。 对于复杂字段，必须为 null 或空集合。

SearchFieldDataType

字段的数据类型。

VectorEncodingFormat

用于解释字段内容的编码格式。

string

向量搜索配置文件的名称，用于指定搜索向量字段时要使用的算法和矢量化器。

string

索引的 ETag。

• CustomAnalyzer[]
• LuceneStandardAnalyzer[]
• PatternAnalyzer[]
• StopAnalyzer[]

索引的分析器。

• MappingCharFilter[]
• PatternReplaceCharFilter[]

索引的字符筛选器。

CorsOptions

用于控制索引的跨域资源共享 （CORS） 的选项。

string

如果查询中未指定任何评分配置文件，则要使用的评分配置文件的名称。 如果未设置此属性，并且在查询中未指定评分配置文件，则将使用默认评分 （tf-idf）。

string

索引的描述。

SearchResourceEncryptionKey

在 Azure Key Vault 中创建的加密密钥的说明。 当你希望完全保证没有人（甚至 Microsoft）无法解密你的数据时，此密钥用于为数据提供额外的静态加密级别。 加密数据后，它将始终保持加密状态。 搜索服务将忽略将此属性设置为 null 的尝试。 如果要轮换加密密钥，可以根据需要更改此属性;您的数据将不受影响。 使用客户管理的密钥进行加密不适用于免费搜索服务，仅适用于 2019 年 1 月 1 日或之后创建的付费服务。

SearchField[]

索引的字段。

string

索引的名称。

CustomNormalizer[]

索引的规范化器。

ScoringProfile[]

索引的评分配置文件。

SemanticSettings

定义影响语义功能的搜索索引的参数。

• BM25Similarity
• ClassicSimilarity

对与搜索查询匹配的文档进行评分和排名时要使用的相似性算法类型。 相似性算法只能在索引创建时定义，不能在现有索引上进行修改。 如果为 null，则使用 ClassicSimilarity 算法。

Suggester[]

索引的建议。

• AsciiFoldingTokenFilter[]
• CjkBigramTokenFilter[]
• CommonGramTokenFilter[]
• DictionaryDecompounderTokenFilter[]
• EdgeNGramTokenFilter[]
• EdgeNGramTokenFilterV2[]
• ElisionTokenFilter[]
• KeepTokenFilter[]
• KeywordMarkerTokenFilter[]
• LengthTokenFilter[]
• LimitTokenFilter[]
• NGramTokenFilter[]
• NGramTokenFilterV2[]
• PatternCaptureTokenFilter[]
• PatternReplaceTokenFilter[]
• PhoneticTokenFilter[]
• ShingleTokenFilter[]
• SnowballTokenFilter[]
• StemmerOverrideTokenFilter[]
• StemmerTokenFilter[]
• StopwordsTokenFilter[]
• SynonymTokenFilter[]
• TruncateTokenFilter[]
• UniqueTokenFilter[]
• WordDelimiterTokenFilter[]

索引的令牌筛选器。

• ClassicTokenizer[]
• EdgeNGramTokenizer[]
• KeywordTokenizer[]
• KeywordTokenizerV2[]
• LuceneStandardTokenizer[]
• LuceneStandardTokenizerV2[]
• MicrosoftLanguageStemmingTokenizer[]
• MicrosoftLanguageTokenizer[]
• NGramTokenizer[]
• PathHierarchyTokenizerV2[]
• PatternTokenizer[]
• UaxUrlEmailTokenizer[]

索引的分词器。

VectorSearch

包含与矢量搜索相关的配置选项。

#Microsoft.Azure.Search.DataNoneIdentity

指定身份类型的 URI 片段。

#Microsoft.Azure.Search.DataUserAssignedIdentity

指定身份类型的 URI 片段。

string

用户分配的托管标识的完全限定的 Azure 资源 ID，通常采用“/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId”的形式，应分配给搜索服务。

AzureActiveDirectoryApplicationCredentials

用于访问 Azure Key Vault 的可选 Azure Active Directory 凭据。 如果改用托管标识，则不需要。

string

用于加密静态数据的 Azure Key Vault 密钥的名称。

string

用于加密静态数据的 Azure Key Vault 密钥版本。

string

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

string

语义配置的名称。

PrioritizedFields

描述用于语义排名、标题、突出显示和答案的标题、内容和关键字字段。 需要设置三个子属性（titleField、prioritizedKeywordsFields 和 prioritizedContentFields）中的至少一个。

RankingOrder

指定用于搜索结果排序顺序的分数类型。

string

SemanticConfiguration[]

索引的语义配置。

string

允许您在索引中设置默认语义配置的名称，以便每次都将其作为查询参数传递是可选的。

#Microsoft.Azure.Search.ShingleTokenFilter

指定令牌筛选器类型的 URI 片段。

string

要为没有标记的每个位置插入的字符串。 默认值为下划线（“_”）。

integer (int32)

最大木瓦尺寸。 默认值和最小值为 2。

integer (int32)

最小木瓦尺寸。 默认值和最小值为 2。 必须小于 maxShingleSize 的值。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

boolean

指示输出流是否包含输入标记（单形）和带状疱疹的值。 默认值为 true。

boolean

一个值，指示是否在没有可用带状疱疹时输出 unigram。 当 outputUnigrams 设置为 false 时，此属性优先。 默认值为 false。

string

连接相邻标记以形成木瓦时使用的字符串。 默认值为单个空格 （“ ”）。

#Microsoft.Azure.Search.SnowballTokenFilter

指定令牌筛选器类型的 URI 片段。

SnowballTokenFilterLanguage

要使用的语言。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.StemmerOverrideTokenFilter

指定令牌筛选器类型的 URI 片段。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

string[]

以下格式的词干删除规则列表：“word => stem”，例如：“ran => run”。

#Microsoft.Azure.Search.StemmerTokenFilter

指定令牌筛选器类型的 URI 片段。

StemmerTokenFilterLanguage

要使用的语言。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.StopAnalyzer

指定分析器类型的 URI 片段。

string

分析器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

string[]

停用词列表。

#Microsoft.Azure.Search.StopwordsTokenFilter

指定令牌筛选器类型的 URI 片段。

boolean

指示是否忽略大小写的值。 如果为 true，则所有单词首先转换为小写。 默认值为 false。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

boolean

一个值，指示如果最后一个搜索词是停用词，则是否忽略该搜索词。 默认值为 true。

string[]

停用词列表。 不能同时设置此属性和停用词列表属性。

StopwordsList

要使用的停用词的预定义列表。 不能同时设置此属性和停用词属性。 默认为英语。

string

建议者的名称。

SuggesterSearchMode

指示建议器功能的值。

string[]

建议器适用的字段名称列表。 每个字段都必须是可搜索的。

#Microsoft.Azure.Search.SynonymTokenFilter

指定令牌筛选器类型的 URI 片段。

boolean

一个值，指示同义词列表中的所有单词（如果未使用 => 表示法）是否相互映射。 如果为 true，则同义词列表中的所有单词（如果未使用 => 表示法）将相互映射。 以下列表：不可思议、不可思议、神话般地、惊人相当于：不可思议、不可思议、不可思议、神话般地、令人惊叹> =不可思议、难以置信、神话般地、令人惊叹。 如果为 false，则以下列表：incredible、unbelievable、fabulous、amazing 将等效于：incredible、unbelievable、fabulous、amazing => incredible。 默认值为 true。

boolean

指示是否对输入进行大小写折叠以进行匹配的值。 默认值为 false。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

string[]

以下两种格式之一的同义词列表： 1. 不可思议、难以置信、神话般的 => 惊人 - => 符号左侧的所有术语都将替换为其右侧的所有术语;2. 不可思议、难以置信、神话般的、惊人的 - 逗号分隔的等效单词列表。 设置展开选项以更改此列表的解释方式。

number (double)

原始分数的乘数。 必须是不等于 1.0 的正数。

string

用作评分函数输入的字段的名称。

ScoringFunctionInterpolation

一个值，指示如何在文档分数之间插值提升;默认为“线性”。

TagScoringParameters

标记评分函数的参数值。

tag

指示要使用的函数类型。 有效值包括大小、新鲜度、距离和标签。 函数类型必须是小写的。

string

在搜索查询中传递的参数的名称，用于指定要与目标字段进行比较的标记列表。

object

用于提高文档评分的每个字段权重的字典。 键是字段名称，值是每个字段的权重。

#Microsoft.Azure.Search.TruncateTokenFilter

指定令牌筛选器类型的 URI 片段。

integer (int32)

将截断的术语长度。 默认值和最大值为 300。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.UaxUrlEmailTokenizer

指定分词器类型的 URI 片段。

integer (int32)

最大令牌长度。 默认值为 255。 长度超过最大长度的令牌将被拆分。 可以使用的最大令牌长度为 300 个字符。

string

分词器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

#Microsoft.Azure.Search.UniqueTokenFilter

指定令牌筛选器类型的 URI 片段。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

boolean

指示是否仅删除同一位置的重复项的值。 默认值为 false。

• ExhaustiveKnnVectorSearchAlgorithmConfiguration[]
• HnswVectorSearchAlgorithmConfiguration[]

包含特定于索引或查询期间使用的算法的配置选项。

• BinaryQuantizationVectorSearchCompressionConfiguration[]
• ScalarQuantizationVectorSearchCompressionConfiguration[]

包含特定于索引或查询期间使用的压缩方法的配置选项。

VectorSearchProfile[]

定义要与矢量搜索一起使用的配置组合。

• AzureOpenAIVectorizer[]
• WebApiVectorizer[]

包含有关如何矢量化文本矢量查询的配置选项。

string

指定算法和可选参数的矢量搜索算法配置的名称。

string

指定压缩方法和可选参数的压缩方法配置的名称。

string

要与此特定向量搜索配置文件关联的名称。

string

配置为用于矢量搜索的矢量化的名称。

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

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

string

适用于连接到 Azure 函数中的外部代码或提供转换的其他应用程序中的自定义终结点。 此值应是向 Azure Active Directory 注册时为函数或应用创建的应用程序 ID。 指定后，矢量化使用搜索服务的托管 ID（系统或用户分配）和函数或应用的访问令牌连接到函数或应用，并将此值用作创建访问令牌范围的资源 ID。

object

发出 HTTP 请求所需的标头。

string

HTTP 请求的方法。

string (duration)

请求的所需超时。 默认值为 30 秒。

string (uri)

提供矢量化器的 Web API 的 URI。

WebApiParameters

指定用户定义矢量化器的属性。

customWebApi

配置为用于向量搜索的矢量化方法的名称。

string

要与此特定矢量化方法关联的名称。

#Microsoft.Azure.Search.WordDelimiterTokenFilter

指定令牌筛选器类型的 URI 片段。

boolean

指示是否将所有子字部分连接的值。 例如，如果将其设置为 true，则“Azure-Search-1”将变为“AzureSearch1”。 默认值为 false。

boolean

指示是否将连接编号部分的最大运行量的值。 例如，如果将其设置为 true，则“1-2”变为“12”。 默认值为 false。

boolean

指示是否将对单词部分的最大运行数进行连接的值。 例如，如果将其设置为 true，则“Azure-Search”将变为“AzureSearch”。 默认值为 false。

boolean

指示是否生成数字子词的值。 默认值为 true。

boolean

指示是否生成部分词的值。 如果设置，则导致生成部分单词;例如，“AzureSearch”变为“Azure”“Search”。 默认值为 true。

string

令牌筛选器的名称。 它只能包含字母、数字、空格、破折号或下划线，只能以字母数字字符开头和结尾，并且限制为 128 个字符。

boolean

指示是否保留原始单词并将其添加到子单词列表中的值。 默认值为 false。

string[]

要防止分隔的令牌列表。

boolean

指示是否在 caseChange 上拆分单词的值。 例如，如果将其设置为 true，则“AzureSearch”将变为“Azure”“Search”。 默认值为 true。

boolean

指示是否对数字进行拆分的值。 例如，如果将其设置为 true，则“Azure1Search”将变为“Azure”“1”Search“。 默认值为 true。

boolean

指示是否删除每个子词的尾随“'s”的值。 默认值为 true。