OpenApiTypesense.SearchParameters (OpenApiTypesense v0.6.5)

View Source

Provides struct and type for a SearchParameters

Summary

Types

t()

@type t() :: %OpenApiTypesense.SearchParameters{
  cache_ttl: integer() | nil,
  conversation: boolean() | nil,
  conversation_id: String.t() | nil,
  conversation_model_id: String.t() | nil,
  drop_tokens_mode: String.t() | nil,
  drop_tokens_threshold: integer() | nil,
  enable_highlight_v1: boolean() | nil,
  enable_overrides: boolean() | nil,
  enable_synonyms: boolean() | nil,
  enable_typos_for_alpha_numerical_tokens: boolean() | nil,
  enable_typos_for_numerical_tokens: boolean() | nil,
  exclude_fields: String.t() | nil,
  exhaustive_search: boolean() | nil,
  facet_by: String.t() | nil,
  facet_query: String.t() | nil,
  facet_return_parent: String.t() | nil,
  facet_strategy: String.t() | nil,
  filter_by: String.t() | nil,
  filter_curated_hits: boolean() | nil,
  group_by: String.t() | nil,
  group_limit: integer() | nil,
  group_missing_values: boolean() | nil,
  hidden_hits: String.t() | nil,
  highlight_affix_num_tokens: integer() | nil,
  highlight_end_tag: String.t() | nil,
  highlight_fields: String.t() | nil,
  highlight_full_fields: String.t() | nil,
  highlight_start_tag: String.t() | nil,
  include_fields: String.t() | nil,
  infix: String.t() | nil,
  limit: integer() | nil,
  max_candidates: integer() | nil,
  max_extra_prefix: integer() | nil,
  max_extra_suffix: integer() | nil,
  max_facet_values: integer() | nil,
  min_len_1typo: integer() | nil,
  min_len_2typo: integer() | nil,
  num_typos: String.t() | nil,
  offset: integer() | nil,
  override_tags: String.t() | nil,
  page: integer() | nil,
  per_page: integer() | nil,
  pinned_hits: String.t() | nil,
  pre_segmented_query: boolean() | nil,
  prefix: String.t() | nil,
  preset: String.t() | nil,
  prioritize_exact_match: boolean() | nil,
  prioritize_num_matching_fields: boolean() | nil,
  prioritize_token_position: boolean() | nil,
  q: String.t() | nil,
  query_by: String.t() | nil,
  query_by_weights: String.t() | nil,
  remote_embedding_num_tries: integer() | nil,
  remote_embedding_timeout_ms: integer() | nil,
  search_cutoff_ms: integer() | nil,
  snippet_threshold: integer() | nil,
  sort_by: String.t() | nil,
  split_join_tokens: String.t() | nil,
  stopwords: String.t() | nil,
  synonym_num_typos: integer() | nil,
  synonym_prefix: boolean() | nil,
  text_match_type: String.t() | nil,
  typo_tokens_threshold: integer() | nil,
  use_cache: boolean() | nil,
  vector_query: String.t() | nil,
  voice_query: String.t() | nil
}