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

SimpleField interface

包:

@azure/search-documents

表示索引定义中的字段，该字段描述字段的名称、数据类型和搜索行为。

属性

analyzerName	要用于字段的语言分析器的名称。 此选项只能用于可搜索字段，并且无法与 searchAnalyzer 或 indexAnalyzer 一起设置。 选择分析器后，无法为字段更改它。 KnownAnalyzerNames 是包含内置分析器名称的枚举。
facetable	一个值，该值指示是否允许在分面查询中引用字段。 通常用于搜索结果的演示文稿，包括按类别 (例如，搜索数码相机并查看按品牌、百万像素、按价格等) 命中次数。 Edm.GeographyPoint 或集合 (Edm.GeographyPoint) 类型字段不可识别。 所有其他简单字段的默认值为 false。
filterable	一个 值，该值指示是否允许在$filter查询中引用字段。 Filterable 与可搜索字符串的处理方式不同。 可筛选的 Edm.String 或 Collection (Edm.String) 类型的字段不会进行断字，因此比较仅用于完全匹配。 例如，如果将此类字段 f 设置为“sunny day”，$filter=f eq“sunny”将找不到匹配项，但$filter=f eq“sunny day”将找到匹配项。 默认值为 false。
hidden	一个值，该值指示字段是否可以在搜索结果中返回。 如果要使用字段 (例如边距) 作为筛选器、排序或评分机制，但不希望字段对最终用户可见，则可以启用此选项。 对于键字段，此属性必须为 false。 可以在现有字段上更改此属性。 禁用此属性不会导致索引存储要求的任何增加。 默认值为 false。
indexAnalyzerName	在为字段编制索引时使用的分析器的名称。 此选项只能与可搜索字段一起使用。 它必须与 searchAnalyzer 一起设置，并且不能与分析器选项一起设置。 选择分析器后，无法为字段更改它。 KnownAnalyzerNames 是包含内置分析器名称的枚举。
key	一个 值，该值指示字段是否唯一标识索引中的文档。 必须选择每个索引中的一个顶级字段作为键字段，并且该字段的类型必须为 Edm.String。 关键字段可用于直接查找文档以及更新或删除特定文档。 默认值为 false。
name	字段的名称，该名称在索引或父字段的 fields 集合中必须是唯一的。
searchable	一个值，该值指示字段是否可全文搜索。 这意味着它会在索引期间受到分词之类的分析。 如果将某个可搜索字段设置为“sunny day”之类的值，在内部它将拆分为单独的标记“sunny”和“day”。 这实现了对这些词的全文搜素。 对于其他非字符串数据类型的简单字段，此属性必须为 false。 注意：可搜索字段会在索引中占用额外的空间，因为Azure 认知搜索将存储字段值的其他标记化版本，以便进行全文搜索。 对于简单字段，默认为 false。
searchAnalyzerName	搜索字段时使用的分析器的名称。 此选项只能与可搜索字段一起使用。 它必须与 indexAnalyzer 一起设置，并且不能与分析器选项一起设置。 此分析器无法在现有字段上更新。 KnownAnalyzerNames 是包含内置分析器名称的枚举。
sortable	一个值，该值指示是否启用要在$orderby表达式中引用的字段。 默认情况下，Azure 认知搜索按分数对结果进行排序，但在许多情况下，用户需要按文档中的字段进行排序。 仅当简单字段是单值字段， (它在父文档) 的范围内具有单个值时，才能对其进行排序。 简单集合字段不可排序，因为它们是多值字段。 复杂集合的简单子字段也是多值字段，因此无法排序。 无论是直接父字段还是上级字段（即复杂集合），都是如此。 可排序的默认值为 false。
synonymMapNames	要与此字段关联的同义词名称列表。 此选项只能与可搜索字段一起使用。 目前，每个字段仅支持一个同义词映射。 为字段分配同义词映射可确保在查询时使用同义词映射中的规则扩展面向该字段的查询词。 可以在现有字段上更改此属性。
type	字段的数据类型。 可能的值包括：“Edm.String”、“Edm.Int32”、“Edm.Int64”、“Edm.Double”、“Edm.Boolean”、“Edm.DateTimeOffset”、“Edm.GeographyPoint”、“Collection (Edm.String) ”， “Collection (Edm.Int32) ”、“Collection (Edm.Int64) ”、“Collection (Edm.Double) ”、“Collection (Edm.Boolean) ”、“Collection (Edm.DateTimeOffset) ”、“Collection (Edm.GeographyPoint) ”、“Collection (Edm.Single) ”
vectorSearchDimensions	向量字段的维度。
vectorSearchProfileName	指定用于搜索矢量字段的算法和可选参数的矢量搜索算法配置的名称。

属性详细信息

analyzerName

要用于字段的语言分析器的名称。 此选项只能用于可搜索字段，并且无法与 searchAnalyzer 或 indexAnalyzer 一起设置。 选择分析器后，无法为字段更改它。 KnownAnalyzerNames 是包含内置分析器名称的枚举。

analyzerName?: string

属性值

string

facetable

一个值，该值指示是否允许在分面查询中引用字段。 通常用于搜索结果的演示文稿，包括按类别 (例如，搜索数码相机并查看按品牌、百万像素、按价格等) 命中次数。 Edm.GeographyPoint 或集合 (Edm.GeographyPoint) 类型字段不可识别。 所有其他简单字段的默认值为 false。

facetable?: boolean

属性值

boolean

filterable

一个 值，该值指示是否允许在$filter查询中引用字段。 Filterable 与可搜索字符串的处理方式不同。 可筛选的 Edm.String 或 Collection (Edm.String) 类型的字段不会进行断字，因此比较仅用于完全匹配。 例如，如果将此类字段 f 设置为“sunny day”，$filter=f eq“sunny”将找不到匹配项，但$filter=f eq“sunny day”将找到匹配项。 默认值为 false。

filterable?: boolean

属性值

boolean

hidden

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

hidden?: boolean

属性值

boolean

indexAnalyzerName

在为字段编制索引时使用的分析器的名称。 此选项只能与可搜索字段一起使用。 它必须与 searchAnalyzer 一起设置，并且不能与分析器选项一起设置。 选择分析器后，无法为字段更改它。 KnownAnalyzerNames 是包含内置分析器名称的枚举。

indexAnalyzerName?: string

属性值

string

key

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

key?: boolean

属性值

boolean

name

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

name: string

属性值

string

searchable

一个值，该值指示字段是否可全文搜索。 这意味着它会在索引期间受到分词之类的分析。 如果将某个可搜索字段设置为“sunny day”之类的值，在内部它将拆分为单独的标记“sunny”和“day”。 这实现了对这些词的全文搜素。 对于其他非字符串数据类型的简单字段，此属性必须为 false。 注意：可搜索字段会在索引中占用额外的空间，因为Azure 认知搜索将存储字段值的其他标记化版本，以便进行全文搜索。 对于简单字段，默认为 false。

searchable?: boolean

属性值

boolean

searchAnalyzerName

搜索字段时使用的分析器的名称。 此选项只能与可搜索字段一起使用。 它必须与 indexAnalyzer 一起设置，并且不能与分析器选项一起设置。 此分析器无法在现有字段上更新。 KnownAnalyzerNames 是包含内置分析器名称的枚举。

searchAnalyzerName?: string

属性值

string

sortable

一个值，该值指示是否启用要在$orderby表达式中引用的字段。 默认情况下，Azure 认知搜索按分数对结果进行排序，但在许多情况下，用户需要按文档中的字段进行排序。 仅当简单字段是单值字段， (它在父文档) 的范围内具有单个值时，才能对其进行排序。 简单集合字段不可排序，因为它们是多值字段。 复杂集合的简单子字段也是多值字段，因此无法排序。 无论是直接父字段还是上级字段（即复杂集合），都是如此。 可排序的默认值为 false。

sortable?: boolean

属性值

boolean

synonymMapNames

要与此字段关联的同义词名称列表。 此选项只能与可搜索字段一起使用。 目前，每个字段仅支持一个同义词映射。 为字段分配同义词映射可确保在查询时使用同义词映射中的规则扩展面向该字段的查询词。 可以在现有字段上更改此属性。

synonymMapNames?: string[]

属性值

string[]

type

字段的数据类型。 可能的值包括：“Edm.String”、“Edm.Int32”、“Edm.Int64”、“Edm.Double”、“Edm.Boolean”、“Edm.DateTimeOffset”、“Edm.GeographyPoint”、“Collection (Edm.String) ”， “Collection (Edm.Int32) ”、“Collection (Edm.Int64) ”、“Collection (Edm.Double) ”、“Collection (Edm.Boolean) ”、“Collection (Edm.DateTimeOffset) ”、“Collection (Edm.GeographyPoint) ”、“Collection (Edm.Single) ”

type: SearchFieldDataType

属性值

SearchFieldDataType

vectorSearchDimensions

向量字段的维度。

vectorSearchDimensions?: number

属性值

number

vectorSearchProfileName

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

vectorSearchProfileName?: string

属性值

string