SearchParams._Fields (Aliyun OPENSEARCH SDK for Java 6.0.0 API)

java.lang.Object
- java.lang.Enum<SearchParams._Fields>
- - com.aliyun.opensearch.sdk.generated.search.SearchParams._Fields

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SearchParams._Fields>, org.apache.thrift.TFieldIdEnum

Enclosing class:

SearchParams
```
public static enum SearchParams._Fields
extends java.lang.Enum<SearchParams._Fields>
implements org.apache.thrift.TFieldIdEnum
```
The set of fields this struct contains, along with convenience methods for finding and manipulating them.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ABTEST` Abtest
`AGGREGATES` 添加统计信息(aggregate)相关参数
`CONFIG` config for search.
`CUSTOM_CLAUSE` 自定义查询子句
`CUSTOM_PARAM`
`DEEP_PAGING`
`DISABLE_FUNCTIONS` 关闭某些功能模块(disable) 有如下场景需要考虑： 1、如果要关闭整个qp的功能，则指定disableValue="qp"。 2、要指定某个索引关闭某个功能，则可以指定disableValue="qp:function_name:index_names", 其中index_names可以用“\|”分隔，可以为index_name1\|index_name2...
`DISTINCTS` 聚合打散条件
`FILTER` 过滤规则(filter)
`FINAL_DISTINCT` 精排聚合打散条件
`QUERY` 设定指定索引字段范围的搜索关键词(query) 此query是查询必需的一部分，可以指定不同的索引名，并同时可指定多个查询及之间的关系（AND, OR, ANDNOT, RANK）。例如查询subject索引字段的query:“手机”，可以设置为 query=subject:'手机'。上边例子如果查询price 在1000-2000之间的手机，其查询语句为： query=subject:'手机' AND price:[1000,2000] NOTE: text类型索引在建立时做了分词，而string类型的索引则没有分词。
`QUERY_PROCESSOR_NAMES` 设置查询分析规则(qp)
`RANK`
`RAW_QUERY` 终端用户输入的query
`SORT` 排序字段及排序方式(sort)
`SUGGEST` 下拉提示是搜索服务的基础功能，在用户输入查询词的过程中，智能推荐候选query，减少用户输入，帮助用户尽快找到想要的内容。 OpenSearch下拉提示在实现了中文前缀，拼音全拼，拼音首字母简拼查询等通用功能的基础上，实现了基于用户文档内容的query智能识别。用户通过控制台的简单配置，就能拥有专属的定制下拉提示。此外，控制台上还提供了黑名单，推荐词条功能，让用户进一步控制下拉提示的结果，实现更灵活的定制。
`SUMMARIES` 动态摘要(summary)信息
`USER_ID` 终端用户的id，用来统计uv信息

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SearchParams._Fields`	`findByName(java.lang.String name)` Find the _Fields constant that matches name, or null if its not found.
`static SearchParams._Fields`	`findByThriftId(int fieldId)` Find the _Fields constant that matches fieldId, or null if its not found.
`static SearchParams._Fields`	`findByThriftIdOrThrow(int fieldId)` Find the _Fields constant that matches fieldId, throwing an exception if it is not found.
`java.lang.String`	`getFieldName()`
`short`	`getThriftFieldId()`
`static SearchParams._Fields`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static SearchParams._Fields[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - CONFIG
```
public static final SearchParams._Fields CONFIG
```
    config for search.
  - QUERY
```
public static final SearchParams._Fields QUERY
```
    设定指定索引字段范围的搜索关键词(query) 此query是查询必需的一部分，可以指定不同的索引名，并同时可指定多个查询及之间的关系（AND, OR, ANDNOT, RANK）。例如查询subject索引字段的query:“手机”，可以设置为 query=subject:'手机'。上边例子如果查询price 在1000-2000之间的手机，其查询语句为： query=subject:'手机' AND price:[1000,2000] NOTE: text类型索引在建立时做了分词，而string类型的索引则没有分词。
    
    See Also:
    
    Query Clause
  - FILTER
```
public static final SearchParams._Fields FILTER
```
    过滤规则(filter)
  - SORT
```
public static final SearchParams._Fields SORT
```
    排序字段及排序方式(sort)
  - RANK
```
public static final SearchParams._Fields RANK
```
  - AGGREGATES
```
public static final SearchParams._Fields AGGREGATES
```
    添加统计信息(aggregate)相关参数
  - DISTINCTS
```
public static final SearchParams._Fields DISTINCTS
```
    聚合打散条件
  - SUMMARIES
```
public static final SearchParams._Fields SUMMARIES
```
    动态摘要(summary)信息
  - QUERY_PROCESSOR_NAMES
```
public static final SearchParams._Fields QUERY_PROCESSOR_NAMES
```
    设置查询分析规则(qp)
  - DEEP_PAGING
```
public static final SearchParams._Fields DEEP_PAGING
```
  - DISABLE_FUNCTIONS
```
public static final SearchParams._Fields DISABLE_FUNCTIONS
```
    关闭某些功能模块(disable) 有如下场景需要考虑： 1、如果要关闭整个qp的功能，则指定disableValue="qp"。 2、要指定某个索引关闭某个功能，则可以指定disableValue="qp:function_name:index_names", 其中index_names可以用“|”分隔，可以为index_name1|index_name2... 3、如果要关闭多个function可以用“,”分隔，例如：disableValue="qp:function_name1:index_name1,qp:function_name2:index_name1" qp有如下模块： 1、spell_check: 检查用户查询串中的拼写错误，并给出纠错建议。 2、term_weighting: 分析查询中每个词的重要程度，并将其量化成权重，权重较低的词可能不会参与召回。 3、stop_word: 根据系统内置的停用词典过滤查询中无意义的词 4、synonym: 根据系统提供的通用同义词库和语义模型，对查询串进行同义词扩展，以便扩大召回。 example: "qp" 标示关闭整个qp "qp:spell_check" 标示关闭qp的拼音纠错功能。 "qp:stop_word:index_name1|index_name2" 标示关闭qp中index_name1和index_name2上的停用词功能。 key 需要禁用的函数名称 value 待禁用函数的详细说明
  - CUSTOM_PARAM
```
public static final SearchParams._Fields CUSTOM_PARAM
```
  - SUGGEST
```
public static final SearchParams._Fields SUGGEST
```
    下拉提示是搜索服务的基础功能，在用户输入查询词的过程中，智能推荐候选query，减少用户输入，帮助用户尽快找到想要的内容。 OpenSearch下拉提示在实现了中文前缀，拼音全拼，拼音首字母简拼查询等通用功能的基础上，实现了基于用户文档内容的query智能识别。用户通过控制台的简单配置，就能拥有专属的定制下拉提示。此外，控制台上还提供了黑名单，推荐词条功能，让用户进一步控制下拉提示的结果，实现更灵活的定制。
  - ABTEST
```
public static final SearchParams._Fields ABTEST
```
    Abtest
  - USER_ID
```
public static final SearchParams._Fields USER_ID
```
    终端用户的id，用来统计uv信息
  - RAW_QUERY
```
public static final SearchParams._Fields RAW_QUERY
```
    终端用户输入的query
  - FINAL_DISTINCT
```
public static final SearchParams._Fields FINAL_DISTINCT
```
    精排聚合打散条件
  - CUSTOM_CLAUSE
```
public static final SearchParams._Fields CUSTOM_CLAUSE
```
    自定义查询子句
- Method Detail
  - values
```
public static SearchParams._Fields[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (SearchParams._Fields c : SearchParams._Fields.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SearchParams._Fields valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - findByThriftId
```
public static SearchParams._Fields findByThriftId(int fieldId)
```
    Find the _Fields constant that matches fieldId, or null if its not found.
  - findByThriftIdOrThrow
```
public static SearchParams._Fields findByThriftIdOrThrow(int fieldId)
```
    Find the _Fields constant that matches fieldId, throwing an exception if it is not found.
  - findByName
```
public static SearchParams._Fields findByName(java.lang.String name)
```
    Find the _Fields constant that matches name, or null if its not found.
  - getThriftFieldId
```
public short getThriftFieldId()
```
    Specified by:
    
    getThriftFieldId in interface org.apache.thrift.TFieldIdEnum
  - getFieldName
```
public java.lang.String getFieldName()
```
    Specified by:
    
    getFieldName in interface org.apache.thrift.TFieldIdEnum

Enum SearchParams._Fields

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CONFIG

QUERY

FILTER

SORT

RANK

AGGREGATES

DISTINCTS

SUMMARIES

QUERY_PROCESSOR_NAMES

DEEP_PAGING

DISABLE_FUNCTIONS

CUSTOM_PARAM

SUGGEST

ABTEST

USER_ID

RAW_QUERY

FINAL_DISTINCT

CUSTOM_CLAUSE

Method Detail

values

valueOf

findByThriftId

findByThriftIdOrThrow

findByName

getThriftFieldId

getFieldName