Optional
content_Optional
filters?: ChunkFilter | nullOptional
get_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).
Optional
highlight_Optional
page?: number | nullPage of chunks to fetch. Page is 1-indexed.
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 for cosine distance metric. For Manhattan Distance, Euclidean Distance, and Dot Product, it will filter out scores above the threshold distance. This threshold applies before weight and bias modifications. If not specified, this defaults to no threshold. A threshold of 0 will default to no threshold.
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.
Set content_only to true to only returning the 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.