Struct CreateMessageReqPayload

pub struct CreateMessageReqPayload {
    pub concat_user_messages_query: Option<Option<bool>>,
    pub filters: Option<Option<Box<ChunkFilter>>>,
    pub highlight_options: Option<Option<Box<HighlightOptions>>>,
    pub llm_options: Option<Option<Box<LlmOptions>>>,
    pub new_message_content: String,
    pub page_size: Option<Option<i64>>,
    pub score_threshold: Option<Option<f32>>,
    pub search_query: Option<Option<String>>,
    pub search_type: Option<Option<SearchMethod>>,
    pub topic_id: Uuid,
    pub user_id: Option<Option<String>>,
}

Fields

concat_user_messages_query: Option<Option<bool>>

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.

filters: Option<Option<Box<ChunkFilter>>>

highlight_options: Option<Option<Box<HighlightOptions>>>

llm_options: Option<Option<Box<LlmOptions>>>

new_message_content: String

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

page_size: Option<Option<i64>>

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.

score_threshold: Option<Option<f32>>

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.

search_query: Option<Option<String>>

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.

search_type: Option<Option<SearchMethod>>

topic_id: Uuid

The ID of the topic to attach the message to.

user_id: Option<Option<String>>

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.

Implementations

impl CreateMessageReqPayload

pub fn new( new_message_content: String, topic_id: Uuid, ) -> CreateMessageReqPayload

Trait Implementations

impl Clone for CreateMessageReqPayload

fn clone(&self) -> CreateMessageReqPayload

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateMessageReqPayload

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateMessageReqPayload

fn default() -> CreateMessageReqPayload

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateMessageReqPayload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateMessageReqPayload

fn eq(&self, other: &CreateMessageReqPayload) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CreateMessageReqPayload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateMessageReqPayload