Type Alias CreateMessageReqPayload

CreateMessageReqPayload: {
    concat_user_messages_query?: boolean | null;
    context_options?: ContextOptions | null;
    filters?: ChunkFilter | null;
    highlight_options?: HighlightOptions | null;
    llm_options?: LLMOptions | null;
    new_message_content: string;
    no_result_message?: string | null;
    page_size?: number | null;
    score_threshold?: number | null;
    search_query?: string | null;
    search_type?: SearchMethod | null;
    sort_options?: SortOptions | null;
    topic_id: string;
    use_group_search?: 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
  • Optionalfilters?: ChunkFilter | null
  • Optionalhighlight_options?: HighlightOptions | null
  • Optionalllm_options?: LLMOptions | null
  • new_message_content: string

    The content of the user message to attach to the topic and then generate an assistant message in response to.

  • Optionalno_result_message?: string | null

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

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

  • 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 attach the message to.

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

  • 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