Struct SearchOverGroupsReqPayload 

pub struct SearchOverGroupsReqPayload {

    pub filters: Option<Option<Box<ChunkFilter>>>,
    pub get_total_pages: Option<Option<bool>>,
    pub group_size: Option<Option<i32>>,
    pub highlight_options: Option<Option<Box<HighlightOptions>>>,
    pub page: Option<Option<i64>>,
    pub page_size: Option<Option<i64>>,
    pub query: Box<QueryTypes>,
    pub remove_stop_words: Option<Option<bool>>,
    pub score_threshold: Option<Option<f32>>,
    pub search_type: SearchMethod,
    pub slim_chunks: Option<Option<bool>>,
    pub use_quote_negated_terms: Option<Option<bool>>,
    pub user_id: Option<Option<String>>,
}

Fields

filters: Option<Option<Box<ChunkFilter>>>

get_total_pages: Option<Option<bool>>

Get total page count for the query accounting for the applied filters. Defaults to false, but can be set to true when the latency penalty is acceptable (typically 50-200ms).

group_size: Option<Option<i32>>

Group_size is the number of chunks to fetch for each group. The default is 3. If a group has less than group_size chunks, all chunks will be returned. If this is set to a large number, we recommend setting slim_chunks to true to avoid returning the content and chunk_html of the chunks so as to lower the amount of time required for content download and serialization.

highlight_options: Option<Option<Box<HighlightOptions>>>

page: Option<Option<i64>>

Page of group results to fetch. Page is 1-indexed.

page_size: Option<Option<i64>>

Page size is the number of group results to fetch. The default is 10.

query: Box<QueryTypes>

remove_stop_words: Option<Option<bool>>

If true, stop words (specified in server/src/stop-words.txt in the git repo) will be removed. Queries that are entirely stop words will be preserved.

score_threshold: Option<Option<f32>>

Set score_threshold to a float to filter out chunks with a score below the threshold. This threshold applies before weight and bias modifications. If not specified, this defaults to 0.0.

search_type: SearchMethod

slim_chunks: Option<Option<bool>>

Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typicall 10-50ms). Default is false.

use_quote_negated_terms: Option<Option<bool>>

If true, quoted and - prefixed words will be parsed from the queries and used as required and negated words respectively. Default is false.

user_id: Option<Option<String>>

The user_id is the id of the user who is making the request. This is used to track user interactions with the search results.

Implementations

impl SearchOverGroupsReqPayload

pub fn new( query: QueryTypes, search_type: SearchMethod, ) -> SearchOverGroupsReqPayload

Trait Implementations

impl Clone for SearchOverGroupsReqPayload

fn clone(&self) -> SearchOverGroupsReqPayload

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchOverGroupsReqPayload

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchOverGroupsReqPayload

fn default() -> SearchOverGroupsReqPayload

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchOverGroupsReqPayload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchOverGroupsReqPayload

fn eq(&self, other: &SearchOverGroupsReqPayload) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SearchOverGroupsReqPayload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SearchOverGroupsReqPayload