Type Alias RegenerateMessageReqPayload

RegenerateMessageReqPayload: {
    concat_user_messages_query?: boolean | null;
    context_options?: ContextOptions | null;
    currency?: string | null;
    filters?: ChunkFilter | null;
    highlight_options?: HighlightOptions | null;
    llm_options?: LLMOptions | null;
    metadata?: unknown;
    model?: string | null;
    no_result_message?: string | null;
    number_of_messages_to_include?: number | null;
    only_include_docs_used?: boolean | null;
    page_size?: number | null;
    rag_context?: string | null;
    remove_stop_words?: boolean | null;
    score_threshold?: number | null;
    search_query?: string | null;
    search_type?: SearchMethod | null;
    sort_options?: SortOptions | null;
    topic_id: string;
    typo_options?: TypoOptions | null;
    use_agentic_search?: boolean | null;
    use_group_search?: boolean | null;
    use_quote_negated_terms?: boolean | null;
    user_id?: string | null;
}

Type declaration

  • Optionalconcat_user_messages_query?: boolean | null

    If concat user messages query is set to true, all of the user messages in the topic will be concatenated together and used as the search query. If not specified, this defaults to false. Default is false.

  • Optionalcontext_options?: ContextOptions | null
  • Optionalcurrency?: string | null

    The currency symbol to use for the completion. If not specified, this defaults to "$".

  • Optionalfilters?: ChunkFilter | null
  • Optionalhighlight_options?: HighlightOptions | null
  • Optionalllm_options?: LLMOptions | null
  • Optionalmetadata?: unknown

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

  • Optionalmodel?: string | null

    Model name to use for the completion. If not specified, this defaults to the dataset's model.

  • Optionalno_result_message?: string | null

    No result message for when there are no chunks found above the score threshold.

  • Optionalnumber_of_messages_to_include?: number | null

    Number of messages to include in the context window. If not specified, this defaults to 10.

  • Optionalonly_include_docs_used?: boolean | null

    Only include docs used is a boolean that indicates whether or not to only include the docs that were used in the completion. If true, the completion will only include the docs that were used in the completion. If false, the completion will include all of the docs.

  • Optionalpage_size?: number | null

    Page size is the number of chunks to fetch during RAG. If 0, then no search will be performed. If specified, this will override the N retrievals to include in the dataset configuration. Default is None.

  • Optionalrag_context?: string | null

    Overrides what the way chunks are placed into the context window

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

  • Optionalsearch_query?: string | null

    Query is the search query. This can be any string. The search_query will be used to create a dense embedding vector and/or sparse vector which will be used to find the result set. If not specified, will default to the last user message or HyDE if HyDE is enabled in the dataset configuration. Default is None.

  • Optionalsearch_type?: SearchMethod | null
  • Optionalsort_options?: SortOptions | null
  • topic_id: string

    The id of the topic to regenerate the last message for.

  • Optionaltypo_options?: TypoOptions | null
  • Optionaluse_agentic_search?: boolean | null

    If true, the search will be conducted using llm tool calling. If not specified, this defaults to false.

  • Optionaluse_group_search?: boolean | null

    If use_group_search is set to true, the search will be conducted using the search_over_groups api. If not specified, this defaults to false.

  • 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 RAG results.

Settings

Member Visibility