Optional
extend_Optional
filters?: ChunkFilter | nullOptional
group_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.
Optional
highlight_Optional
metadata?: unknownMetadata is any metadata you want to associate w/ the event that is created from this request
Optional
page_Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.
Optional
remove_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.
Optional
score_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.
Optional
scoring_Optional
slim_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 (typically 10-50ms). Default is false.
Optional
sort_Optional
typo_Optional
use_If true, quoted and - prefixed words will be parsed from the queries and used as required and negated words respectively. Default is false.
Optional
user_User ID is the id of the user who is making the request. This is used to track user interactions with the search results.
If specified to true, this will extend the search results to include non-exact prefix matches of the same search_type such that a full page_size of results are returned. Default is false.