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

SimpleField interface

包:

@azure/search-documents

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

属性

analyzerName	要用于字段的分析器的名称。 此选项只能与可搜索字段一起使用，不能与 searchAnalyzer 或 indexAnalyzer 一起设置。 选择分析器后，无法更改该字段。
facetable	一个值，该值指示是否允许在分面查询中引用字段。 通常用于按类别显示的搜索结果（例如，按品牌搜索、按百万像素、按价格等）搜索数字摄像头并查看命中次数）。 无法分面 Edm.GeographyPoint 或 Collection（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。 可以在现有字段上更改此属性。 启用此属性不会导致索引存储要求增加。 对于矢量字段，默认值为 true，否则为 false。
indexAnalyzerName	在索引时为字段使用的分析器的名称。 此选项只能与可搜索字段一起使用。 它必须与 searchAnalyzer 一起设置，并且不能与分析器选项一起设置。 此属性不能设置为语言分析器的名称;如果需要语言分析器，请改用分析器属性。 选择分析器后，无法更改该字段。
key	一个值，该值指示字段是否唯一标识索引中的文档。 每个索引中的一个顶级字段必须选择为键字段，并且必须的类型为 Edm.String。 键字段可用于直接查找文档并更新或删除特定文档。 默认值为 false。
name	字段的名称，在索引或父字段的字段集合中必须唯一。
searchable	一个值，该值指示字段是否可全文搜索。 这意味着它将在编制索引期间进行断字分析。 如果将可搜索字段设置为“sunny day”等值，则内部会将其拆分为单个标记“sunny”和“day”。 这将启用全文搜索这些术语。 默认情况下，可搜索类型为 Edm.String 或 Collection（Edm.String）的字段。 对于其他非字符串数据类型的简单字段，此属性必须为 false。 注意：可搜索字段在索引中使用额外的空间，以适应用于全文搜索的字段值的其他标记化版本。 如果要在索引中节省空间，并且不需要在搜索中包含字段，请将可搜索设置为 false。 默认值为 false。
searchAnalyzerName	在搜索时用于字段的分析器的名称。 此选项只能与可搜索字段一起使用。 它必须与 indexAnalyzerName 一起设置，不能与 analyzerName 选项一起设置。 此属性不能设置为语言分析器的名称;如果需要语言分析器，请改用 analyzerName 属性。 可以在现有字段中更新此分析器。
sortable	一个值，该值指示是否启用要在$orderby表达式中引用的字段。 默认情况下，搜索引擎按分数对结果进行排序，但在很多体验中，用户希望按文档中的字段进行排序。 仅当简单字段是单值（它在父文档的作用域中具有单个值）时，才能进行排序。 简单集合字段不可排序，因为它们是多值。 复杂集合的简单子字段也是多值，因此无法排序。 无论是直接父字段还是上级字段，都是复杂的集合，都是如此。 默认值为 false。
stored	一个不可变值，该值指示字段是否将单独保存在要在搜索结果中返回的磁盘上。 如果不打算在搜索响应中返回字段内容以节省存储开销，则可以禁用此选项。 这只能在创建索引期间设置，并且只能为向量字段设置。 对于现有字段，不能更改此属性，也不能为新字段设置为 false。 如果此属性设置为 false，则属性“hidden”必须设置为“true”。 对于键字段、新字段和非向量字段，此属性必须为 false 或未设置。 禁用此属性可以减少索引存储要求。
synonymMapNames	要与此字段关联的同义词的名称列表。 此选项只能与可搜索字段一起使用。 目前每个字段仅支持一个同义词映射。 将同义词映射分配给字段可确保使用同义词映射中的规则在查询时扩展针对该字段的查询词。 可以在现有字段上更改此属性。
type	字段的数据类型。
vectorEncodingFormat	用于解释字段内容的编码格式。
vectorSearchDimensions	矢量字段的维度。
vectorSearchProfileName	矢量搜索配置文件的名称，该配置文件指定要在搜索向量字段时使用的算法和向量器。

属性详细信息

analyzerName

要用于字段的分析器的名称。 此选项只能与可搜索字段一起使用，不能与 searchAnalyzer 或 indexAnalyzer 一起设置。 选择分析器后，无法更改该字段。

analyzerName?: string

属性值

string

facetable

一个值，该值指示是否允许在分面查询中引用字段。 通常用于按类别显示的搜索结果（例如，按品牌搜索、按百万像素、按价格等）搜索数字摄像头并查看命中次数）。 无法分面 Edm.GeographyPoint 或 Collection（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。 可以在现有字段上更改此属性。 启用此属性不会导致索引存储要求增加。 对于矢量字段，默认值为 true，否则为 false。

hidden?: boolean

属性值

boolean

indexAnalyzerName

在索引时为字段使用的分析器的名称。 此选项只能与可搜索字段一起使用。 它必须与 searchAnalyzer 一起设置，并且不能与分析器选项一起设置。 此属性不能设置为语言分析器的名称;如果需要语言分析器，请改用分析器属性。 选择分析器后，无法更改该字段。

indexAnalyzerName?: string

属性值

string

key

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

key?: boolean

属性值

boolean

name

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

name: string

属性值

string

searchable

一个值，该值指示字段是否可全文搜索。 这意味着它将在编制索引期间进行断字分析。 如果将可搜索字段设置为“sunny day”等值，则内部会将其拆分为单个标记“sunny”和“day”。 这将启用全文搜索这些术语。 默认情况下，可搜索类型为 Edm.String 或 Collection（Edm.String）的字段。 对于其他非字符串数据类型的简单字段，此属性必须为 false。 注意：可搜索字段在索引中使用额外的空间，以适应用于全文搜索的字段值的其他标记化版本。 如果要在索引中节省空间，并且不需要在搜索中包含字段，请将可搜索设置为 false。 默认值为 false。

searchable?: boolean

属性值

boolean

searchAnalyzerName

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

searchAnalyzerName?: string

属性值

string

sortable

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

sortable?: boolean

属性值

boolean

stored

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

stored?: boolean

属性值

boolean

synonymMapNames

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

synonymMapNames?: string[]

属性值

string[]

type

字段的数据类型。

type: SearchFieldDataType

属性值

SearchFieldDataType

vectorEncodingFormat

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

vectorEncodingFormat?: string

属性值

string

vectorSearchDimensions

矢量字段的维度。

vectorSearchDimensions?: number

属性值

number

vectorSearchProfileName

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

vectorSearchProfileName?: string

属性值

string