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

SearchField 类

定义

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

public class SearchField
type SearchField = class
Public Class SearchField
继承
SearchField

构造函数

SearchField(String, SearchFieldDataType)

初始化 SearchField 类的新实例。

属性

AnalyzerName

获取或设置要用于字段的分析器的名称。 此选项只能与可搜索字段一起使用,并且不能与 SearchAnalyzerNameIndexAnalyzerName一起设置。 选择分析器后,无法为字段更改它。 对于复杂字段,必须为 null。

Fields

如果此字段的类型 Complex 为或“集合 (DataType.Complex) ”,则获取嵌套字段的列表。

IndexAnalyzerName

获取或设置在为字段编制索引时使用的分析器的名称。 此选项只能与可搜索字段一起使用。 它必须与 SearchAnalyzerName 一起设置,并且无法与 AnalyzerName 选项一起设置。 此属性不能设置为语言分析器的名称;如果需要语言分析器, AnalyzerName 请改用 属性。 选择分析器后,无法为字段更改它。 对于复杂字段,必须为 null。

IsFacetable

获取或设置一个值,该值指示是否可以在分面查询中检索字段。 默认值为 NULL。 对于复杂字段,此属性必须为 null,但可以在复杂字段内的简单字段上设置。

IsFilterable

获取或设置一个值,该值指示是否可以在查询中 $filter 引用字段。 默认值为 NULL。 对于复杂字段,此属性必须为 null,但可以在复杂字段内的简单字段上设置。

IsHidden

获取或设置一个值,该值指示是否将在搜索结果中返回该字段。 默认值为 NULL。 对于键字段,此属性必须为 true,对于复杂字段,此属性必须为 null。

IsKey

获取或设置字段是否为键字段。 默认值为 NULL。 SearchIndex必须恰好有一个 类型String为 的键字段。

IsSearchable

获取或设置一个值,该值指示字段是否可全文搜索。 默认值为 NULL。 这意味着它会在索引期间受到分词之类的分析。 此属性只能为 String 或 “集合 (DataType.String) ”。 对于非字符串简单字段,它必须为 false,对于复杂字段,它必须为 null。

IsSortable

获取或设置一个值,该值指示是否可以在表达式中 $orderby 引用字段。 默认值为 NULL。 仅当简单字段是单值类型(如 StringInt32)时,它才能进行排序。

Name

获取字段名。

NormalizerName

要用于字段的规范化器的名称。 此选项只能与启用了可筛选、可排序或可分面的字段一起使用。 选择规范化器后,无法更改字段的规范化程序。 对于复杂字段,必须为 null。

SearchAnalyzerName

获取或设置在搜索时用于字段的分析器的名称。 此选项只能与可搜索字段一起使用。 它必须与 IndexAnalyzerName 一起设置,并且无法与 AnalyzerName 选项一起设置。 此属性不能设置为语言分析器的名称;如果需要语言分析器, AnalyzerName 请改用 属性。 此分析器无法在现有字段上更新。 对于复杂字段,必须为 null。

SynonymMapNames

获取与此字段关联的同义词映射的名称列表。 只有 为 true 的 IsSearchable 字段才能具有关联的同义词映射。

Type

Ge 字段的数据类型。

VectorSearchDimensions

向量字段的维数。

VectorSearchProfile

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

方法

ToString()

返回表示当前对象的字符串。

适用于