@botonic/plugin-ai-agents 0.40.0-alpha.1 → 0.40.1-alpha.0

package/src/index.ts

@@ -1,4 +1,4 @@
-import { BotContext, Plugin } from '@botonic/core'
+import { AiAgentArgs, BotContext, Plugin } from '@botonic/core'
 import { tool } from '@openai/agents'
 
 import { AIAgentBuilder } from './agent-builder'
@@ -8,7 +8,6 @@ import { setUpOpenAI } from './openai'
 import { AIAgentRunner } from './runner'
 import {
   AgenticInputMessage,
-  AiAgentArgs,
   Context,
   CustomTool,
   InferenceResponse,
@@ -48,7 +47,8 @@ export default class BotonicPluginAiAgents implements Plugin {
         aiAgentArgs.instructions,
         tools,
         request.session.user.contact_info || {},
-        aiAgentArgs.inputGuardrailRules || []
+        aiAgentArgs.inputGuardrailRules || [],
+        aiAgentArgs.sourceIds || []
       ).build()
 
       const messages = await this.getMessages(
@@ -58,6 +58,8 @@ export default class BotonicPluginAiAgents implements Plugin {
       )
       const context: Context = {
         authToken,
+        request,
+        sources: aiAgentArgs.sourceIds || [],
       }
 
       const runner = new AIAgentRunner(agent)

package/src/structured-output/carousel.ts

@@ -14,7 +14,7 @@ export const CarouselSchema = z
           image: z.string(),
           button: z.object({
             text: z.string(),
-            url: z.string(),
+            url: z.string().nullable().optional(),
           }),
         })
       ),

package/src/structured-output/text-with-buttons.ts

@@ -8,7 +8,11 @@ export const TextWithButtonsSchema = z
     type: z.enum(['textWithButtons']),
     content: z.object({
       text: z.string(),
-      buttons: z.array(z.string()),
+      buttons: z.array(
+        z.object({
+          text: z.string(),
+        })
+      ),
     }),
   })
   .describe(

package/src/tools/index.ts

@@ -1,3 +1,4 @@
 import { Tool } from '../types'
+export { retrieveKnowledge } from './retrieve-knowledge'
 
 export const mandatoryTools: Tool[] = []

package/src/tools/retrieve-knowledge.ts

@@ -0,0 +1,28 @@
+import { RunContext, tool } from '@openai/agents'
+import { z } from 'zod'
+
+import { HubtypeApiClient } from '../hubtype-api-client'
+import { Context } from '../types'
+
+export const retrieveKnowledge = tool<any, Context, any>({
+  name: 'retrieve_knowledge',
+  description:
+    'Consult the knowledge base for information before answering. Use this tool to make sure the information you provide is faithful.',
+  parameters: z.object({
+    query: z.string().describe('The query to search the knowledge base for'),
+  }),
+  execute: async (
+    { query }: { query: string },
+    runContext?: RunContext<Context>
+  ): Promise<string[]> => {
+    const context = runContext?.context
+    if (!context) {
+      throw new Error('Context is required')
+    }
+    const sources = context.sources
+    const client = new HubtypeApiClient(context.authToken)
+    const chunks = await client.retrieveSimilarChunks(query, sources)
+
+    return chunks
+  },
+})

package/src/types.ts

@@ -1,6 +1,10 @@
 import {
   AgenticOutputMessage,
+  AiAgentArgs,
+  BotContext,
+  GuardrailRule,
   InferenceResponse,
+  ResolvedPlugins,
   RunResult,
 } from '@botonic/core'
 import {
@@ -13,22 +17,28 @@ import { ZodSchema } from 'zod'
 
 import { OutputSchema } from './structured-output'
 
-export interface Context {
+export interface Context<
+  TPlugins extends ResolvedPlugins = ResolvedPlugins,
+  TExtraData = any,
+> {
   authToken: string
+  request: BotContext<TPlugins, TExtraData>
+  sources: string[]
 }
 
-export type RunContext = OpenAIRunContext<Context>
+export type RunContext<
+  TPlugins extends ResolvedPlugins = ResolvedPlugins,
+  TExtraData = any,
+> = OpenAIRunContext<Context<TPlugins, TExtraData>>
 
 export interface CustomTool {
   name: string
   description: string
   schema: ZodSchema
-  func: (input?: any, runContext?: RunContext) => Promise<any>
-}
-
-export interface GuardrailRule {
-  name: string
-  description: string
+  func: <TPlugins extends ResolvedPlugins = ResolvedPlugins, TExtraData = any>(
+    input?: any,
+    runContext?: RunContext<TPlugins, TExtraData>
+  ) => Promise<any>
 }
 
 export type ContactInfo = Record<string, string>
@@ -40,13 +50,12 @@ export interface PluginAiAgentOptions {
   customTools?: CustomTool[]
 }
 
-export interface AiAgentArgs {
-  name: string
-  instructions: string
-  activeTools?: { name: string }[]
-  inputGuardrailRules?: GuardrailRule[]
-}
-
 export type AgenticInputMessage = AgentInputItem
 
-export type { AgenticOutputMessage, InferenceResponse, RunResult }
+export {
+  AgenticOutputMessage,
+  AiAgentArgs,
+  GuardrailRule,
+  InferenceResponse,
+  RunResult,
+}