Skip to content

Latest commit

 

History

History
40 lines (34 loc) · 2.83 KB

SearchWithinGroupData.md

File metadata and controls

40 lines (34 loc) · 2.83 KB
Raw

TrieveRubyClient::SearchWithinGroupData

Properties

Name Type Description Notes
date_bias Boolean Set date_bias to true to bias search results towards more recent chunks. This will work best in hybrid search mode. [optional]
filters ChunkFilter [optional]
group_id String Group specifies the group to search within. Results will only consist of chunks which are bookmarks within the specified group. [optional]
group_tracking_id String Group_tracking_id specifies the group to search within by tracking id. Results will only consist of chunks which are bookmarks within the specified group. If both group_id and group_tracking_id are provided, group_id will be used. [optional]
highlight_delimiters Array<String> Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [&quot;?&quot;, &quot;,&quot;, &quot;.&quot;, &quot;!&quot;]. [optional]
highlight_results Boolean Set highlight_results to true to highlight the results. If not specified, this defaults to true. [optional]
page Integer The page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon. [optional]
page_size Integer The page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. [optional]
query String The query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set.
score_threshold Float Set score_threshold to a float to filter out chunks with a score below the threshold. [optional]
search_type String Search_type can be either &quot;semantic&quot;, &quot;fulltext&quot;, or &quot;hybrid&quot;. &quot;hybrid&quot; will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. &quot;semantic&quot; will pull in one page (10 chunks) of the nearest cosine distant vectors. &quot;fulltext&quot; will pull in one page (10 chunks) of full-text results based on SPLADE.
use_weights Boolean Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true. [optional]

Example

require 'trieve_ruby_client'

instance = TrieveRubyClient::SearchWithinGroupData.new(
  date_bias: null,
  filters: null,
  group_id: null,
  group_tracking_id: null,
  highlight_delimiters: null,
  highlight_results: null,
  page: null,
  page_size: null,
  query: null,
  score_threshold: null,
  search_type: null,
  use_weights: null
)