refactor(ai): define Typesense ask-ai message and config types

Author: tharropoulos

packages/docsearch-react/src/types/AskiAi.ts

@@ -1,39 +1,40 @@
-import type { UIMessage } from '@ai-sdk/react';
-import type { ToolUIPart, UIDataTypes, UIMessagePart } from 'ai';
+import type { MultiSearchRequestSchema } from 'typesense/lib/Typesense/Types';
 
 export type AskAiState = 'conversation-history' | 'conversation' | 'initial' | 'new-conversation';
 
-export interface SearchIndexTool {
-  input: {
-    query: string;
-  };
-  output: {
-    query?: string;
-    hits?: any[];
-  };
-}
+export type AskAiStatus = 'error' | 'ready' | 'streaming' | 'submitted';
 
-export interface AgentStudioSearchTool {
-  input: {
-    index: string;
-    query: string;
-    number_of_results: number;
-    facet_filters: any | null;
-  };
-  output: {
-    hits?: any[];
-    nbHits?: number;
-    queryID?: string;
-  };
+export interface AITextPart {
+  type: 'text';
+  text: string;
+  state?: 'done' | 'streaming';
 }
 
-type Tools = {
-  searchIndex: SearchIndexTool;
-  algolia_search_index: AgentStudioSearchTool;
+export type AIMessagePart = AITextPart;
+
+export type AIMessage = {
+  id: string;
+  role: 'assistant' | 'user';
+  parts: AIMessagePart[];
+  metadata?: {
+    stopped?: boolean;
+    conversationId?: string;
+  };
 };
 
-export type AIMessage = UIMessage<{ stopped?: boolean }, UIDataTypes, Tools>;
+export type UseAskAiSendMessageOptions = {
+  suggestedQuestionId?: string;
+};
 
-export type AIMessagePart = UIMessagePart<UIDataTypes, Tools>;
+export type TypesenseAskAiSearchParameters = Omit<
+  Partial<MultiSearchRequestSchema<Record<string, unknown>, string>>,
+  'collection' | 'exclude_fields' | 'q' | 'query_by'
+>;
 
-export type AIToolPart = ToolUIPart<Tools>;
+export type TypesenseAskAiParams = {
+  collection: string;
+  conversationModelId: string;
+  excludeFields?: string;
+  queryBy: string;
+  searchParameters?: TypesenseAskAiSearchParameters;
+};

packages/docsearch-react/src/types/StoredDocSearchHit.ts

@@ -9,6 +9,7 @@ export type StoredAskAiMessage = AIMessage & {
 };
 
 export type StoredAskAiState = StoredDocSearchHit & {
+  conversationId?: string;
   stopped?: boolean;
   messages?: StoredAskAiMessage[];
 };

packages/docsearch-react/src/utils/ai.ts

@@ -1,7 +1,5 @@
-import type { TextUIPart } from 'ai';
-
 import type { StoredAskAiState } from '../types';
-import type { AIMessage } from '../types/AskiAi';
+import type { AIMessage, AITextPart } from '../types/AskiAi';
 
 import { sanitizeUserInput } from './sanitize';
 
@@ -69,11 +67,16 @@ export function extractLinksFromMessage(message: AIMessage | null): ExtractedLin
   return links;
 }
 
-export const buildDummyAskAiHit = (query: string, messages: AIMessage[]): StoredAskAiState => {
+export const buildDummyAskAiHit = (
+  query: string,
+  messages: AIMessage[],
+  conversationId?: string
+): StoredAskAiState => {
   const textPart = messages[0].parts.find((part) => part.type === 'text');
   const sanitizedText = textPart?.text ? sanitizeUserInput(textPart.text) : '';
 
   return {
+    conversationId,
     query,
     objectID: sanitizedText,
     messages,
@@ -96,7 +99,7 @@ export const buildDummyAskAiHit = (query: string, messages: AIMessage[]): Stored
   };
 };
 
-export const getMessageContent = (message: AIMessage | null): TextUIPart | undefined =>
+export const getMessageContent = (message: AIMessage | null): AITextPart | undefined =>
   message?.parts.find((part) => part.type === 'text');
 
 /**