cleanup: add back only_used_docs_used for now

Author: densumesh

clients/ts-sdk/openapi.json

@@ -11670,6 +11670,11 @@
             "description": "No result message for when there are no chunks found above the score threshold.",
             "nullable": true
           },
+          "only_include_docs_used": {
+            "type": "boolean",
+            "description": "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.",
+            "nullable": true
+          },
           "page_size": {
             "type": "integer",
             "format": "int64",
@@ -12766,6 +12771,11 @@
             "description": "No result message for when there are no chunks found above the score threshold.",
             "nullable": true
           },
+          "only_include_docs_used": {
+            "type": "boolean",
+            "description": "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.",
+            "nullable": true
+          },
           "page_size": {
             "type": "integer",
             "format": "int64",
@@ -19323,6 +19333,11 @@
             "description": "No result message for when there are no chunks found above the score threshold.",
             "nullable": true
           },
+          "only_include_docs_used": {
+            "type": "boolean",
+            "description": "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.",
+            "nullable": true
+          },
           "page_size": {
             "type": "integer",
             "format": "int64",
@@ -22473,7 +22488,7 @@
           },
           "is_ecommerce": {
             "type": "boolean",
-            "description": "Whether of not the suggested queries are being generated for ecomm. If true, the suggested queries will be generated for ecomm. If false, the suggested queries will be generated for non-ecomm.",
+            "description": "Whether of not the suggested queries are being generated for ecommerce.",
             "nullable": true
           },
           "is_followup": {

clients/ts-sdk/src/types.gen.ts

@@ -1086,6 +1086,10 @@ export type CreateMessageReqPayload = {
      * No result message for when there are no chunks found above the score threshold.
      */
     no_result_message?: (string) | 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.
+     */
+    only_include_docs_used?: (boolean) | 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.
      */
@@ -1594,6 +1598,10 @@ export type EditMessageReqPayload = {
      * No result message for when there are no chunks found above the score threshold.
      */
     no_result_message?: (string) | 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.
+     */
+    only_include_docs_used?: (boolean) | 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.
      */
@@ -3695,6 +3703,10 @@ export type RegenerateMessageReqPayload = {
      * No result message for when there are no chunks found above the score threshold.
      */
     no_result_message?: (string) | 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.
+     */
+    only_include_docs_used?: (boolean) | 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.
      */
@@ -4525,7 +4537,7 @@ export type SuggestedQueriesReqPayload = {
     context?: (string) | null;
     filters?: ((ChunkFilter) | null);
     /**
-     * Whether of not the suggested queries are being generated for ecomm. If true, the suggested queries will be generated for ecomm. If false, the suggested queries will be generated for non-ecomm.
+     * Whether of not the suggested queries are being generated for ecommerce.
      */
     is_ecommerce?: (boolean) | null;
     /**

server/src/data/models.rs

@@ -4547,6 +4547,7 @@ impl ApiKeyRequestParams {
             typo_options: self.typo_options.or(payload.typo_options),
             metadata: payload.metadata,
             use_agentic_search: payload.use_agentic_search,
+            only_include_docs_used: payload.only_include_docs_used,
         }
     }
 
@@ -9432,6 +9433,7 @@ impl<'de> Deserialize<'de> for CreateMessageReqPayload {
             use_quote_negated_terms: Option<bool>,
             remove_stop_words: Option<bool>,
             typo_options: Option<TypoOptions>,
+            pub only_include_docs_used: Option<bool>,
         }
 
         let mut helper = Helper::deserialize(deserializer)?;
@@ -9472,6 +9474,7 @@ impl<'de> Deserialize<'de> for CreateMessageReqPayload {
             remove_stop_words: helper.remove_stop_words,
             typo_options: helper.typo_options,
             use_agentic_search: helper.use_agentic_search,
+            only_include_docs_used: helper.only_include_docs_used,
         })
     }
 }
@@ -9506,6 +9509,7 @@ impl<'de> Deserialize<'de> for RegenerateMessageReqPayload {
             pub typo_options: Option<TypoOptions>,
             pub rag_context: Option<String>,
             pub use_agentic_search: Option<bool>,
+            pub only_include_docs_used: Option<bool>,
         }
 
         let mut helper = Helper::deserialize(deserializer)?;
@@ -9543,6 +9547,7 @@ impl<'de> Deserialize<'de> for RegenerateMessageReqPayload {
             typo_options: helper.typo_options,
             rag_context: helper.rag_context,
             use_agentic_search: helper.use_agentic_search,
+            only_include_docs_used: helper.only_include_docs_used,
         })
     }
 }
@@ -9581,6 +9586,7 @@ impl<'de> Deserialize<'de> for EditMessageReqPayload {
             pub typo_options: Option<TypoOptions>,
             pub rag_context: Option<String>,
             pub use_agentic_search: Option<bool>,
+            pub only_include_docs_used: Option<bool>,
         }
 
         let mut helper = Helper::deserialize(deserializer)?;
@@ -9622,6 +9628,7 @@ impl<'de> Deserialize<'de> for EditMessageReqPayload {
             typo_options: helper.typo_options,
             rag_context: helper.rag_context,
             use_agentic_search: helper.use_agentic_search,
+            only_include_docs_used: helper.only_include_docs_used,
         })
     }
 }

server/src/handlers/message_handler.rs

@@ -106,6 +106,8 @@ pub struct CreateMessageReqPayload {
     pub context_options: Option<ContextOptions>,
     /// No result message for when there are no chunks found above the score threshold.
     pub no_result_message: Option<String>,
+    /// 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.
+    pub only_include_docs_used: Option<bool>,
     /// The currency to use for the completion. If not specified, this defaults to "USD".
     pub currency: Option<String>,
     /// Search_type can be either "semantic", "fulltext", or "hybrid". "hybrid" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using scores from a cross encoder model. "semantic" will pull in one page (10 chunks) of the nearest cosine distant vectors. "fulltext" will pull in one page (10 chunks) of full-text results based on SPLADE. Default is "hybrid".
@@ -271,6 +273,7 @@ pub async fn create_message(
         &dataset_config,
         previous_messages,
         create_message_data.use_agentic_search.unwrap_or(false),
+        create_message_data.only_include_docs_used.unwrap_or(false),
         new_message,
         dataset_org_plan_sub.dataset.id,
         &create_message_pool,
@@ -406,6 +409,8 @@ pub struct RegenerateMessageReqPayload {
     pub context_options: Option<ContextOptions>,
     /// No result message for when there are no chunks found above the score threshold.
     pub no_result_message: Option<String>,
+    /// 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.
+    pub only_include_docs_used: Option<bool>,
     /// The currency symbol to use for the completion. If not specified, this defaults to "$".
     pub currency: Option<String>,
     /// Search_type can be either "semantic", "fulltext", or "hybrid". "hybrid" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using scores from a cross encoder model. "semantic" will pull in one page (10 chunks) of the nearest cosine distant vectors. "fulltext" will pull in one page (10 chunks) of full-text results based on SPLADE. Default is "hybrid".
@@ -460,6 +465,8 @@ pub struct EditMessageReqPayload {
     pub context_options: Option<ContextOptions>,
     /// No result message for when there are no chunks found above the score threshold.
     pub no_result_message: Option<String>,
+    /// 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.
+    pub only_include_docs_used: Option<bool>,
     /// The currency symbol to use for the completion. If not specified, this defaults to "$".
     pub currency: Option<String>,
     /// Search_type can be either "semantic", "fulltext", or "hybrid". "hybrid" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using scores from a cross encoder model. "semantic" will pull in one page (10 chunks) of the nearest cosine distant vectors. "fulltext" will pull in one page (10 chunks) of full-text results based on SPLADE. Default is "hybrid".
@@ -517,6 +524,7 @@ impl From<EditMessageReqPayload> for CreateMessageReqPayload {
             metadata: data.metadata,
             rag_context: data.rag_context,
             use_agentic_search: data.use_agentic_search,
+            only_include_docs_used: data.only_include_docs_used,
         }
     }
 }
@@ -548,6 +556,7 @@ impl From<RegenerateMessageReqPayload> for CreateMessageReqPayload {
             metadata: data.metadata,
             rag_context: data.rag_context,
             use_agentic_search: data.use_agentic_search,
+            only_include_docs_used: data.only_include_docs_used,
         }
     }
 }