Type Alias SearchWithinGroupReqPayload

SearchWithinGroupReqPayload: {
    content_only?: boolean | null;
    filters?: ChunkFilter | null;
    get_total_pages?: boolean | null;
    group_id?: string | null;
    group_tracking_id?: string | null;
    highlight_options?: HighlightOptions | null;
    metadata?: unknown;
    page?: number | null;
    page_size?: number | null;
    query: QueryTypes;
    remove_stop_words?: boolean | null;
    score_threshold?: number | null;
    scoring_options?: ScoringOptions | null;
    search_type: SearchMethod;
    slim_chunks?: boolean | null;
    sort_options?: SortOptions | null;
    typo_options?: TypoOptions | null;
    use_quote_negated_terms?: boolean | null;
    user_id?: string | null;
}

Type declaration

  • Optionalcontent_only?: boolean | null

    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.

  • Optionalfilters?: ChunkFilter | null
  • Optionalget_total_pages?: boolean | null

    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).

  • Optionalgroup_id?: string | null

    Group specifies the group to search within. Results will only consist of chunks which are bookmarks within the specified group.

  • Optionalgroup_tracking_id?: string | null

    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.

  • Optionalhighlight_options?: HighlightOptions | null
  • Optionalmetadata?: unknown

    Metadata is any metadata you want to associate w/ the event that is created from this request

  • Optionalpage?: number | null

    The page of chunks to fetch. Page is 1-indexed.

  • Optionalpage_size?: number | null

    The page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.

  • query: QueryTypes
  • Optionalremove_stop_words?: boolean | null

    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.

  • Optionalscore_threshold?: number | null

    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.

  • Optionalscoring_options?: ScoringOptions | null
  • search_type: SearchMethod
  • Optionalslim_chunks?: boolean | null

    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 (typicall 10-50ms). Default is false.

  • Optionalsort_options?: SortOptions | null
  • Optionaltypo_options?: TypoOptions | null
  • Optionaluse_quote_negated_terms?: boolean | null

    If true, quoted and - prefixed words will be parsed from the queries and used as required and negated words respectively. Default is false.

  • Optionaluser_id?: string | null

    The user_id is the id of the user who is making the request. This is used to track user interactions with the search results.

Settings

Member Visibility