Struct SearchCollectionParams

pub struct SearchCollectionParams {

    pub collection_name: String,
    pub q: String,
    pub query_by: String,
    pub query_by_weights: Option<String>,
    pub text_match_type: Option<String>,
    pub prefix: Option<String>,
    pub infix: Option<String>,
    pub max_extra_prefix: Option<i32>,
    pub max_extra_suffix: Option<i32>,
    pub filter_by: Option<String>,
    pub sort_by: Option<String>,
    pub facet_by: Option<String>,
    pub max_facet_values: Option<i32>,
    pub facet_query: Option<String>,
    pub num_typos: Option<String>,
    pub page: Option<i32>,
    pub per_page: Option<i32>,
    pub limit: Option<i32>,
    pub offset: Option<i32>,
    pub group_by: Option<String>,
    pub group_limit: Option<i32>,
    pub group_missing_values: Option<bool>,
    pub include_fields: Option<String>,
    pub exclude_fields: Option<String>,
    pub highlight_full_fields: Option<String>,
    pub highlight_affix_num_tokens: Option<i32>,
    pub highlight_start_tag: Option<String>,
    pub highlight_end_tag: Option<String>,
    pub enable_highlight_v1: Option<bool>,
    pub snippet_threshold: Option<i32>,
    pub drop_tokens_threshold: Option<i32>,
    pub drop_tokens_mode: Option<DropTokensMode>,
    pub typo_tokens_threshold: Option<i32>,
    pub enable_typos_for_alpha_numerical_tokens: Option<bool>,
    pub filter_curated_hits: Option<bool>,
    pub enable_synonyms: Option<bool>,
    pub synonym_prefix: Option<bool>,
    pub synonym_num_typos: Option<i32>,
    pub pinned_hits: Option<String>,
    pub hidden_hits: Option<String>,
    pub override_tags: Option<String>,
    pub highlight_fields: Option<String>,
    pub split_join_tokens: Option<String>,
    pub pre_segmented_query: Option<bool>,
    pub preset: Option<String>,
    pub enable_overrides: Option<bool>,
    pub prioritize_exact_match: Option<bool>,
    pub max_candidates: Option<i32>,
    pub prioritize_token_position: Option<bool>,
    pub prioritize_num_matching_fields: Option<bool>,
    pub enable_typos_for_numerical_tokens: Option<bool>,
    pub exhaustive_search: Option<bool>,
    pub search_cutoff_ms: Option<i32>,
    pub use_cache: Option<bool>,
    pub cache_ttl: Option<i32>,
    pub min_len_1typo: Option<i32>,
    pub min_len_2typo: Option<i32>,
    pub vector_query: Option<String>,
    pub remote_embedding_timeout_ms: Option<i32>,
    pub remote_embedding_num_tries: Option<i32>,
    pub facet_strategy: Option<String>,
    pub stopwords: Option<String>,
    pub facet_return_parent: Option<String>,
    pub voice_query: Option<String>,
    pub conversation: Option<bool>,
    pub conversation_model_id: Option<String>,
    pub conversation_id: Option<String>,
}

struct for passing parameters to the method [search_collection]

Fields

collection_name: String

The name of the collection to search for the document under

q: String

query_by: String

query_by_weights: Option<String>

text_match_type: Option<String>

prefix: Option<String>

infix: Option<String>

max_extra_prefix: Option<i32>

max_extra_suffix: Option<i32>

filter_by: Option<String>

sort_by: Option<String>

facet_by: Option<String>

max_facet_values: Option<i32>

facet_query: Option<String>

num_typos: Option<String>

page: Option<i32>

per_page: Option<i32>

limit: Option<i32>

offset: Option<i32>

group_by: Option<String>

group_limit: Option<i32>

group_missing_values: Option<bool>

include_fields: Option<String>

exclude_fields: Option<String>

highlight_full_fields: Option<String>

highlight_affix_num_tokens: Option<i32>

highlight_start_tag: Option<String>

highlight_end_tag: Option<String>

enable_highlight_v1: Option<bool>

snippet_threshold: Option<i32>

drop_tokens_threshold: Option<i32>

drop_tokens_mode: Option<DropTokensMode>

typo_tokens_threshold: Option<i32>

enable_typos_for_alpha_numerical_tokens: Option<bool>

filter_curated_hits: Option<bool>

enable_synonyms: Option<bool>

synonym_prefix: Option<bool>

synonym_num_typos: Option<i32>

pinned_hits: Option<String>

hidden_hits: Option<String>

override_tags: Option<String>

highlight_fields: Option<String>

split_join_tokens: Option<String>

pre_segmented_query: Option<bool>

preset: Option<String>

enable_overrides: Option<bool>

prioritize_exact_match: Option<bool>

max_candidates: Option<i32>

prioritize_token_position: Option<bool>

prioritize_num_matching_fields: Option<bool>

enable_typos_for_numerical_tokens: Option<bool>

exhaustive_search: Option<bool>

search_cutoff_ms: Option<i32>

use_cache: Option<bool>

cache_ttl: Option<i32>

min_len_1typo: Option<i32>

min_len_2typo: Option<i32>

vector_query: Option<String>

remote_embedding_timeout_ms: Option<i32>

remote_embedding_num_tries: Option<i32>

facet_strategy: Option<String>

stopwords: Option<String>

facet_return_parent: Option<String>

voice_query: Option<String>

conversation: Option<bool>

conversation_model_id: Option<String>

conversation_id: Option<String>

Trait Implementations

impl Clone for SearchCollectionParams

fn clone(&self) -> SearchCollectionParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchCollectionParams

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

Formats the value using the given formatter.