feature: add must not filter tool call

Author: vid277

clients/search-component/src/utils/hooks/chat-context.tsx

@@ -4,6 +4,7 @@ import {
   defaultPriceToolCallOptions,
   defaultRelevanceToolCallOptions,
   defaultSearchToolCallOptions,
+  defaultNotFilterToolCallOptions,
   useModalState,
 } from "./modal-context";
 import { Chunk } from "../types";
@@ -91,18 +92,18 @@ const ChatContext = createContext<{
   rateChatCompletion: (isPositive: boolean, queryId: string | null) => void;
   productsWithClicks: ChunkIdWithIndex[];
 }>({
-  askQuestion: async () => { },
+  askQuestion: async () => {},
   currentQuestion: "",
   isLoading: false,
   loadingText: "",
   messages: [],
-  setCurrentQuestion: () => { },
-  cancelGroupChat: () => { },
-  clearConversation: () => { },
-  chatWithGroup: () => { },
-  switchToChatAndAskQuestion: async () => { },
-  stopGeneratingMessage: () => { },
-  rateChatCompletion: () => { },
+  setCurrentQuestion: () => {},
+  cancelGroupChat: () => {},
+  clearConversation: () => {},
+  chatWithGroup: () => {},
+  switchToChatAndAskQuestion: async () => {},
+  stopGeneratingMessage: () => {},
+  rateChatCompletion: () => {},
   productsWithClicks: [],
 });
 
@@ -521,6 +522,7 @@ function ChatProvider({ children }: { children: React.ReactNode }) {
     let useImage = false;
     let referenceImageUrls: string[] = [];
     let referenceChunks: Chunk[] = [];
+    let notFilter = false;
 
     if (!groupIds || groupIds.length === 0) {
       chatMessageAbortController.current = new AbortController();
@@ -645,6 +647,54 @@ function ChatProvider({ children }: { children: React.ReactNode }) {
           }
         });
 
+        const notFilterPromise = retryOperation(async () => {
+          if (!curGroup && messages.length > 1) {
+            return await trieveSDK.getToolCallFunctionParams({
+              user_message_text: `Here's the previous message thread so far: ${messages.map(
+                (message) => {
+                  if (
+                    message.type === "system" &&
+                    message.additional?.length &&
+                    props.type === "ecommerce"
+                  ) {
+                    const chunks = message.additional
+                      .map((chunk) => {
+                        return JSON.stringify({
+                          title: chunk.metadata?.title || "",
+                          description: chunk.chunk_html || "",
+                          price: chunk.num_value
+                            ? `${props.defaultCurrency || ""} ${chunk.num_value}`
+                            : "",
+                          link: chunk.link || "",
+                        });
+                      })
+                      .join("\n\n");
+                    return `\n\n${chunks}${message.text}`;
+                  } else {
+                    return `\n\n${message.text}`;
+                  }
+                },
+              )} \n\n${props.notFilterToolCallOptions?.userMessageTextPrefix ?? defaultNotFilterToolCallOptions.userMessageTextPrefix}: ${questionProp || currentQuestion}.`,
+              image_url: localImageUrl ? localImageUrl : null,
+              audio_input: curAudioBase64 ? curAudioBase64 : null,
+              tool_function: {
+                name: "not_filter",
+                description:
+                  props.notFilterToolCallOptions?.toolDescription ??
+                  defaultNotFilterToolCallOptions.toolDescription,
+                parameters: [
+                  {
+                    name: "not_filter",
+                    parameter_type: "boolean",
+                    description:
+                      "Whether or not the user is interested in the products previously shown to them. Set this to true if the user is not interested in the products they were shown or want something different.",
+                  },
+                ],
+              },
+            });
+          }
+        });
+
         const tagFiltersPromise = retryOperation(async () => {
           if (
             (!defaultMatchAnyTags || !defaultMatchAnyTags?.length) &&
@@ -693,11 +743,13 @@ function ChatProvider({ children }: { children: React.ReactNode }) {
           imageFiltersResp,
           tagFiltersResp,
           skipSearchResp,
+          notFilterResp,
         ] = await Promise.all([
           priceFiltersPromise,
           imageFiltersPromise,
           tagFiltersPromise,
           skipSearchPromise,
+          notFilterPromise,
         ]);
 
         if (transcribedQuery && curAudioBase64) {
@@ -725,7 +777,8 @@ function ChatProvider({ children }: { children: React.ReactNode }) {
         }
 
         useImage = (imageFiltersResp?.parameters &&
-          (imageFiltersResp.parameters as any)["image"] === true && localImageUrl) as boolean;
+          (imageFiltersResp.parameters as any)["image"] === true &&
+          localImageUrl) as boolean;
 
         const match_any_tags = [];
         if (tagFiltersResp?.parameters) {
@@ -786,6 +839,15 @@ function ChatProvider({ children }: { children: React.ReactNode }) {
           }
         }
 
+        if (notFilterResp?.parameters) {
+          const notFilterParam = (notFilterResp.parameters as any)[
+            "not_filter"
+          ];
+          if (typeof notFilterParam === "boolean" && notFilterParam) {
+            notFilter = true;
+          }
+        }
+
         clearTimeout(toolCallTimeout);
       } catch (e) {
         console.error("error getting getToolCallFunctionParams", e);
@@ -821,6 +883,19 @@ function ChatProvider({ children }: { children: React.ReactNode }) {
         filters = null;
       }
 
+      if (notFilter) {
+        if (filters == null) {
+          filters = { must_not: [] };
+        } else if (filters.must_not == null) {
+          filters.must_not = [];
+        }
+
+        (filters as ChunkFilter)?.must_not?.push({
+          field: "group_ids",
+          match_any: groupIdsInChat,
+        });
+      }
+
       searchAbortController.current = new AbortController();
       if (curGroup) {
         setLoadingText("Reading the product's information...");
@@ -883,7 +958,9 @@ function ChatProvider({ children }: { children: React.ReactNode }) {
           const searchOverGroupsResp = await retryOperation(async () => {
             return await trieveSDK.searchOverGroups(
               {
-                query: questionProp || currentQuestion,
+                query: notFilter
+                  ? `${messages[messages.length - 2]?.text} ${questionProp || currentQuestion}`
+                  : questionProp || currentQuestion,
                 search_type: "fulltext",
                 filters: filters,
                 page_size: 20,
@@ -1296,7 +1373,7 @@ function ChatProvider({ children }: { children: React.ReactNode }) {
     }
     if (audioBase64) {
       setAudioBase64("");
-      setTranscribedQuery("");  
+      setTranscribedQuery("");
     }
   };
 

clients/search-component/src/utils/hooks/modal-context.tsx

@@ -95,9 +95,15 @@ export const defaultSearchToolCallOptions: SearchToolCallOptions = {
     "Call this tool anytime it seems like we need to skip the search step. This tool tells our system that the user is asking about what they were previously shown.",
 };
 
+export const defaultNotFilterToolCallOptions: NotFilterToolCallOptions = {
+  userMessageTextPrefix: "Here is the user query:",
+  toolDescription:
+    "Set to true if the query is not interested in the products they were shown previously or would like to see something different. Ensure that this is only set to true when the user wants to see something different from the previously returned results or is not interested in those previously returned results.",
+};
+
 export const defaultPriceToolCallOptions: PriceToolCallOptions = {
   toolDescription:
-    "Only call this function if the query includes details about a price. Decide on which price filters to apply to the available catalog being used within the knowledge base to respond. If the question is slightly like a product name, respond with no filters (all false).",
+    "Only call this function if the query includes details about a price. Decide on which price filters to apply to the available catalog being used within the knowledge base to respond. If the question is slightly like a product name, respond with no filters (all false). If they don't specify a price number, then respond with no filters (all false).",
   minPriceDescription:
     "Minimum price of the product. Only set this if a minimum price is mentioned in the query.",
   maxPriceDescription:
@@ -110,6 +116,11 @@ export interface PriceToolCallOptions {
   maxPriceDescription?: string;
 }
 
+export interface NotFilterToolCallOptions {
+  userMessageTextPrefix?: string;
+  toolDescription: string;
+}
+
 export interface FilterSidebarSection {
   key: string;
   filterKey: string;
@@ -147,7 +158,6 @@ export function isDefaultSearchQuery(
   return typeof question === "object" && "query" in question;
 }
 
-
 export type ModalProps = {
   datasetId: string;
   apiKey: string;
@@ -182,6 +192,7 @@ export type ModalProps = {
   relevanceToolCallOptions?: RelevanceToolCallOptions;
   priceToolCallOptions?: PriceToolCallOptions;
   searchToolCallOptions?: SearchToolCallOptions;
+  notFilterToolCallOptions?: NotFilterToolCallOptions;
   defaultSearchMode?: SearchModes;
   usePagefind?: boolean;
   type?: ModalTypes;
@@ -252,6 +263,7 @@ const defaultProps = {
   baseUrl: "https://api.trieve.ai",
   relevanceToolCallOptions: defaultRelevanceToolCallOptions,
   priceToolCallOptions: defaultPriceToolCallOptions,
+  notFilterToolCallOptions: defaultNotFilterToolCallOptions,
   defaultSearchMode: "search" as SearchModes,
   placeholder: "Search...",
   chatPlaceholder: "Ask Anything...",

clients/ts-sdk/openapi.json

@@ -16203,6 +16203,19 @@
           }
         ]
       },
+      "NotFilterToolCallOptions": {
+        "type": "object",
+        "properties": {
+          "toolDescription": {
+            "type": "string",
+            "nullable": true
+          },
+          "userMessageTextPrefix": {
+            "type": "string",
+            "nullable": true
+          }
+        }
+      },
       "OcrStrategy": {
         "type": "string",
         "description": "Controls the Optical Character Recognition (OCR) strategy.\n- `All`: Processes all pages with OCR. (Latency penalty: ~0.5 seconds per page)\n- `Auto`: Selectively applies OCR only to pages with missing or low-quality text. When text layer is present the bounding boxes from the text layer are used.",
@@ -16824,6 +16837,14 @@
             "type": "string",
             "nullable": true
           },
+          "notFilterToolCallOptions": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/NotFilterToolCallOptions"
+              }
+            ],
+            "nullable": true
+          },
           "numberOfSuggestions": {
             "type": "integer",
             "nullable": true,

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

@@ -2939,6 +2939,11 @@ export type MultiQuery = {
 
 export type NewChunkMetadataTypes = SlimChunkMetadataWithArrayTagSet | ChunkMetadata | ContentChunkMetadata;
 
+export type NotFilterToolCallOptions = {
+    toolDescription?: (string) | null;
+    userMessageTextPrefix?: (string) | null;
+};
+
 /**
  * Controls the Optical Character Recognition (OCR) strategy.
  * - `All`: Processes all pages with OCR. (Latency penalty: ~0.5 seconds per page)
@@ -3135,6 +3140,7 @@ export type PublicPageParameters = {
     inlineHeader?: (string) | null;
     isTestMode?: (boolean) | null;
     navLogoImgSrcUrl?: (string) | null;
+    notFilterToolCallOptions?: ((NotFilterToolCallOptions) | null);
     numberOfSuggestions?: (number) | null;
     openGraphMetadata?: ((OpenGraphMetadata) | null);
     openLinksInNewTab?: (boolean) | null;

frontends/dashboard/src/hooks/usePublicPageSettings.tsx

@@ -19,6 +19,7 @@ import { ApiRoutes } from "../components/Routes";
 import { HeroPatterns } from "../pages/dataset/HeroPatterns";
 import { createInitializedContext } from "../utils/initialize";
 import {
+  defaultNotFilterToolCallOptions,
   defaultOpenGraphMetadata,
   defaultPriceToolCallOptions,
   defaultRelevanceToolCallOptions,
@@ -100,6 +101,12 @@ export const { use: usePublicPage, provider: PublicPageProvider } =
         });
       }
 
+      if (!extraParams.notFilterToolCallOptions) {
+        setExtraParams("notFilterToolCallOptions", {
+          ...defaultNotFilterToolCallOptions,
+        });
+      }
+
       if (!extraParams.openGraphMetadata) {
         setExtraParams("openGraphMetadata", {
           ...defaultOpenGraphMetadata,