Devel

packages/ai-function-caller/src/index.ts

@@ -9,10 +9,27 @@
 
 /**
  * A class for calling AI functions and managing interactions.
+ * @example
+ * ```ts
+ * import { AIFunctionCaller } from "@withorbit/ai-function-caller";
+ * import { AIFunction } from "@withorbit/ai-function-caller";
+ *
+ * const functions: AIFunction<any>[] = [
+ *  {
+ *   name: "add",
+ *   method: async (args: any) => {
+ *   return args.a + args.b;
+ *  }
+ * ];
+ *
+ * const aiFunctionCaller = new AIFunctionCaller(functions);
+ * const response = await aiFunctionCaller.query("What is 2 + 2?");
+ * console.log(response); // 4
+ * ```
  */
 export class AIFunctionCaller {
   public messages: Message[] = [];
   public functions: AIFunction<any>[];
   private openai: OpenAI;
 
   /**
@@ -20,7 +37,7 @@
    * @param functions - Array of AI functions.
    * @param initialMessages - Initial set of messages, defaults to an empty array.
    */
   constructor(functions: AIFunction<any>[], initialMessages: Message[] = []) {
     this.functions = functions;
     this.openai = new OpenAI({ apiKey: process.env.OPENAI_API_KEY });
     this.messages = initialMessages;
@@ -29,6 +46,7 @@
   /**
    * Logs a message to the message array.
    * @param message - The message to log.
+   * @example
    */
   private logMessage(message: Message): void {
     this.messages.push(message);
@@ -39,7 +57,7 @@
    * @returns A Promise resolving to MessageContent or AIFunctionCall.
    */
   private async executeAIModel(): Promise<MessageContent | AIFunctionCall> {
     const response: any = await this.openai.chat.completions.create({
       model: "gpt-4-0613",
       messages: this.messages,
       functions: this.functions,
@@ -59,7 +77,7 @@
     const { name, arguments: args } = aiFunctionCall;
     const { method } = this.functions.find(
       (f) => f.name === name,
     ) as AIFunction<any>;
     const functionResponse = await method(args);
     return this.processMessage(
       "Function",
@@ -94,8 +112,13 @@
    * Processes a user query and returns the response.
    * @param userMessage - The user message to process.
    * @returns A Promise resolving to the response.
+   * @example
+   * ```ts
+   * const response = await aiFunctionCaller.query("What is 2 + 2?");
+   * console.log(response); // 4
+   * ```
    */
   public async query(userMessage: string): Promise<any> {
     return await this.processMessage("User", MessageRole.User, userMessage);
   }
 }