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

package/src/tools/retrieve-knowledge.ts

@@ -0,0 +1,27 @@
+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,5 +1,7 @@
 import {
   AgenticOutputMessage,
+  AiAgentArgs,
+  GuardrailRule,
   InferenceResponse,
   RunResult,
 } from '@botonic/core'
@@ -15,6 +17,7 @@ import { OutputSchema } from './structured-output'
 
 export interface Context {
   authToken: string
+  sources: string[]
 }
 
 export type RunContext = OpenAIRunContext<Context>
@@ -26,11 +29,6 @@ export interface CustomTool {
   func: (input?: any, runContext?: RunContext) => Promise<any>
 }
 
-export interface GuardrailRule {
-  name: string
-  description: string
-}
-
 export type ContactInfo = Record<string, string>
 
 export type Tool = OpenAITool<Context>
@@ -40,13 +38,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,
+}