support aimode field

etc/chat-core.api.md

@@ -55,7 +55,7 @@ export enum Environment {
 //
 // @internal
 export interface InternalConfig {
-    // (undocumented)
+    aiMode?: string;
     promptPackage?: ChatPrompt;
 }
 
@@ -83,8 +83,6 @@ export interface MessageRequest {
     conversationId?: string;
     messages: Message[];
     notes?: MessageNotes;
-    // @internal
-    promptPackage?: ChatPrompt;
 }
 
 // @public

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yext/chat-core",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "Typescript Networking Library for the Yext Chat API",
   "main": "./dist/commonjs/index.js",
   "module": "./dist/esm/index.mjs",

src/infra/ChatCoreImpl.ts

@@ -9,7 +9,6 @@ import {
   MessageRequest,
   MessageResponse,
   Endpoints,
-  ChatPrompt,
 } from "../models";
 import { ApiMessageRequest } from "../models/endpoints/MessageRequest";
 import { ApiResponse } from "../models/http/ApiResponse";
@@ -25,22 +24,22 @@ export class ChatCoreImpl implements ChatCore {
   private chatConfig: ChatConfig;
   private httpService: HttpService;
   private endpoints: Endpoints;
-  private promptPackage: ChatPrompt;
+  private internalConfig: InternalConfig;
 
-  constructor(chatConfig: ChatConfig, internalConfig?: InternalConfig) {
+  constructor(chatConfig: ChatConfig, internalConfig: InternalConfig = {}) {
     this.chatConfig = chatConfig;
     this.httpService = new HttpServiceImpl();
-    this.endpoints =
-      chatConfig.endpoints ?? EndpointsFactory.getEndpoints(this.chatConfig);
-    this.promptPackage = internalConfig?.promptPackage ?? "stable";
+    this.endpoints = chatConfig.endpoints ?? EndpointsFactory.getEndpoints(this.chatConfig);
+    this.internalConfig = internalConfig
   }
 
   async getNextMessage(request: MessageRequest): Promise<MessageResponse> {
     const queryParams: QueryParams = { v: defaultApiVersion };
     const body: ApiMessageRequest = {
       ...request,
       version: this.chatConfig.version,
-      promptPackage: this.promptPackage,
+      promptPackage: this.internalConfig.promptPackage,
+      aiMode: this.internalConfig.aiMode
     };
     const rawResponse = await this.httpService.post(
       this.endpoints.chat,
@@ -74,7 +73,8 @@ export class ChatCoreImpl implements ChatCore {
     const body: ApiMessageRequest = {
       ...request,
       version: this.chatConfig.version,
-      promptPackage: this.promptPackage,
+      promptPackage: this.internalConfig.promptPackage,
+      aiMode: this.internalConfig.aiMode
     };
     const rawResponse = await this.httpService.post(
       this.endpoints.chatStream,

src/models/InternalConfig.ts

@@ -14,5 +14,21 @@ export type ChatPrompt = "stable" | "nightly";
  * @internal
  */
 export interface InternalConfig {
+  /**
+   * promptPackage corresponds to the package of prompts which will be used
+   * to carry out the instruction steps. When set to "nightly", the bot will
+   * use the most recent updates to the prompts, which may include experimental
+   * changes.
+   * It is STRONGLY recommended to use the default "stable" for your bot.
+   *
+   * @remarks
+   * The set of prompts which will be used by the bot's instruction steps.
+   * Defaults to "stable", which is the set of tested and verified prompts.
+   */
   promptPackage?: ChatPrompt;
+  /**
+   * Modes to determine types of models to use when sending requests the bot's
+   * instruction steps.
+   */
+  aiMode?: string;
 }

src/models/endpoints/MessageRequest.ts

@@ -40,19 +40,6 @@ export interface MessageRequest {
    */
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   context?: any;
-  /**
-   * promptPackage corresponds to the package of prompts which will be used
-   * to carry out the instruction steps. When set to "nightly", the bot will
-   * use the most recent updates to the prompts, which may include experimental
-   * changes.
-   * It is STRONGLY recommended to use the default "stable" for your bot.
-   *
-   * @remarks
-   * The set of prompts which will be used by the bot's instruction steps.
-   * Defaults to "stable", which is the set of tested and verified prompts.
-   * @internal
-   */
-  promptPackage?: ChatPrompt;
 }
 
 /**
@@ -69,6 +56,8 @@ export interface ApiMessageRequest {
   messages: Message[];
   /** {@inheritDoc MessageNotes} */
   notes?: MessageNotes;
-  /** {@inheritdoc MessageRequest.promptPackage} */
+  /** {@inheritDoc InternalConfig.promptPackage} */
   promptPackage?: ChatPrompt;
+  /** {@inheritDoc InternalConfig.aiMode} */
+  aiMode?: string;
 }

test-node-cjs/node.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import http from "http";
-import { ChatConfig, StreamEventName, provideChatCore } from "@yext/chat-core";
+import { ChatConfig, InternalConfig, MessageRequest, StreamEventName, provideChatCoreInternal } from "@yext/chat-core";
 import dotenv from "dotenv";
 
 dotenv.config();
@@ -14,17 +14,21 @@ const config: ChatConfig = {
   },
 };
 
+const internalConfig: InternalConfig = { /** for testing pursposes */}
+
+const request: MessageRequest = {
+  messages: [
+    {
+      timestamp: "2023-05-17T19:21:21.915Z",
+      source: "USER",
+      text: "How do I send an email?",
+    }
+  ]
+}
+
 async function stream(res: any) {
-  const chatCore = provideChatCore(config);
-  const stream = await chatCore.streamNextMessage({
-    messages: [
-      {
-        timestamp: "2023-05-17T19:21:21.915Z",
-        source: "USER",
-        text: "How do I send an email?",
-      },
-    ],
-  });
+  const chatCore = provideChatCoreInternal(config, internalConfig);
+  const stream = await chatCore.streamNextMessage(request);
   Object.values(StreamEventName).forEach((eventName) => {
     stream.addEventListener(eventName, (event) => {
       console.log(`${eventName}:`, event.data);
@@ -42,10 +46,8 @@ const server = http.createServer(async (req: any, res: any) => {
   if (req.url === "/streaming") {
     stream(res);
   } else {
-    const chatCore = provideChatCore(config);
-    const reply = await chatCore.getNextMessage({
-      messages: [],
-    });
+    const chatCore = provideChatCoreInternal(config, internalConfig);
+    const reply = await chatCore.getNextMessage(request);
     res.end(JSON.stringify(reply, null, 2));
   }
 });

tests/ChatCore.test.ts

@@ -14,7 +14,6 @@ const mockedMessageRequest: MessageRequest = {
     foo: "bar",
   },
   messages: [],
-  promptPackage: "stable",
 };
 
 const defaultConfig: ChatConfig = {
@@ -131,7 +130,7 @@ describe("URL and http request construction", () => {
           foo: "bar",
         },
         messages: [],
-        promptPackage: "stable",
+
       },
       "my-api-key"
     );
@@ -150,7 +149,6 @@ describe("URL and http request construction", () => {
           foo: "bar",
         },
         messages: [],
-        promptPackage: "stable",
       },
       "my-api-key"
     );
@@ -175,7 +173,6 @@ describe("URL and http request construction", () => {
           foo: "bar",
         },
         messages: [],
-        promptPackage: "stable",
       },
       "my-api-key"
     );
@@ -195,7 +192,6 @@ describe("URL and http request construction", () => {
           foo: "bar",
         },
         messages: [],
-        promptPackage: "stable",
       },
       "my-api-key"
     );