trieve_client/models/
create_message_req_payload.rs

1/*
2 * Trieve API
3 *
4 * Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
5 *
6 * The version of the OpenAPI document: 0.11.7
7 * Contact: developers@trieve.ai
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12
13#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
14pub struct CreateMessageReqPayload {
15    /// 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.
16    #[serde(rename = "concat_user_messages_query", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
17    pub concat_user_messages_query: Option<Option<bool>>,
18    #[serde(rename = "filters", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
19    pub filters: Option<Option<Box<models::ChunkFilter>>>,
20    #[serde(rename = "highlight_options", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
21    pub highlight_options: Option<Option<Box<models::HighlightOptions>>>,
22    #[serde(rename = "llm_options", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
23    pub llm_options: Option<Option<Box<models::LlmOptions>>>,
24    /// The content of the user message to attach to the topic and then generate an assistant message in response to.
25    #[serde(rename = "new_message_content")]
26    pub new_message_content: String,
27    /// 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.
28    #[serde(rename = "page_size", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
29    pub page_size: Option<Option<i64>>,
30    /// 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.
31    #[serde(rename = "score_threshold", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
32    pub score_threshold: Option<Option<f32>>,
33    /// 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.
34    #[serde(rename = "search_query", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
35    pub search_query: Option<Option<String>>,
36    #[serde(rename = "search_type", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
37    pub search_type: Option<Option<models::SearchMethod>>,
38    /// The ID of the topic to attach the message to.
39    #[serde(rename = "topic_id")]
40    pub topic_id: uuid::Uuid,
41    /// 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.
42    #[serde(rename = "user_id", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
43    pub user_id: Option<Option<String>>,
44}
45
46impl CreateMessageReqPayload {
47    pub fn new(new_message_content: String, topic_id: uuid::Uuid) -> CreateMessageReqPayload {
48        CreateMessageReqPayload {
49            concat_user_messages_query: None,
50            filters: None,
51            highlight_options: None,
52            llm_options: None,
53            new_message_content,
54            page_size: None,
55            score_threshold: None,
56            search_query: None,
57            search_type: None,
58            topic_id,
59            user_id: None,
60        }
61    }
62}
63
trieve_client/models/create_message_req_payload.rs

trieve_client/models/
create_message_req_payload.rs
