changed to AIOptions and updated getting-started docs

microsoft · Oct 9, 2023 · 97c184a · 97c184a
1 parent 1118442
commit 97c184a
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 36 deletions.
diff --git a/getting-started/js/00.MIGRATION.md b/getting-started/js/00.MIGRATION.md
@@ -30,6 +30,12 @@ const storage = new MemoryStorage();
 
 > `ApplicationTurnState` is the default `TurnState` that includes `ConversationState`, `UserState`, and `TempState`
 
+#### Optional ApplicationBuilder Class 
+
+You may also use the `ApplicationBuilder` class to instantiate your `Application` instance. This option provides greater readability and separates the management of the various configuration options (e.g., storage, turn state, AI module options, etc).
+
+Follow [this example](#optional-applicationbuilder-class-example) to learn more.
+
 ---
 
 ### 2. Message Extensions
@@ -96,9 +102,7 @@ app.adaptiveCards.actionSubmit("ChoiceSubmit", async (context, state, data: Subm
 });
 ```
 
-### Optional ApplicationBuilder Class 
-
-You may also use the `ApplicationBuilder` class to instantiate your `Application` instance. This option provides greater readability and separates the management of the various configuration options (e.g., storage, turn state, AI module options, etc).
+### Optional ApplicationBuilder Class Example
 
 js `index.ts`:
 

diff --git a/getting-started/js/01.AI-SETUP.md b/getting-started/js/01.AI-SETUP.md
@@ -51,33 +51,4 @@ const app = new Application({
     // ... other options
   }
 });
-```
-
-### Optional ApplicationBuilder Class 
-
-You may also use the `ApplicationBuilder` class to instantiate your `Application` instance. This option provides greater readability and separates the management of the various configuration options (e.g., storage, turn state, AI module options, etc).
-
-js `index.ts`:
-
-```js
-// Old method:
-// const app = new Application({
-//  storage,
-//  ai: {
-//    planner,
-//    promptManager,
-//    prompt: "defaultPrompt"
-    // ... other options
-//  }
-// });
-
-const app = new ApplicationBuilder()<ApplicationTurnState>
-    .withStorage(storage)
-    .withAI({
-      planner,
-      promptManager,
-      prompt: "defaultPrompt"
-      // ... other options
-    })
-    .build(); // this function internally calls the Application constructor
 ```
diff --git a/js/packages/teams-ai/src/Application.spec.ts b/js/packages/teams-ai/src/Application.spec.ts
@@ -86,7 +86,7 @@ describe('Application', () => {
             const app = new ApplicationBuilder()
                 .setRemoveRecipientMention(removeRecipientMention)
                 .withStorage(storage)
-                .withAI(ai)
+                .withAIOptions(ai)
                 .withLongRunningMessages(adapter, botAppId)
                 .withTurnStateManager(turnStateManager)
                 .withAdaptiveCardOptions(adaptiveCards)

diff --git a/js/packages/teams-ai/src/Application.ts b/js/packages/teams-ai/src/Application.ts
@@ -789,7 +789,7 @@ export class ApplicationBuilder<TState extends TurnState = DefaultTurnState> {
      * @param {AIOptions<TState>} aiOptions The options for the AI system.
      * @returns {this} The ApplicationBuilder instance.
      */
-    public withAI(aiOptions: AIOptions<TState>): this {
+    public withAIOptions(aiOptions: AIOptions<TState>): this {
         this._options.ai = aiOptions;
         return this;
     }

diff --git a/js/samples/04.ai.b.messageExtensions.AI-ME/src/index.ts b/js/samples/04.ai.b.messageExtensions.AI-ME/src/index.ts
@@ -110,7 +110,7 @@ const botAppId = process.env.MicrosoftAppId || '';
 const app = new ApplicationBuilder<ApplicationTurnState>()
     .withStorage(storage)
     .withLongRunningMessages(adapter, botAppId)
-    .withAI({
+    .withAIOptions({
         planner,
         promptManager
     })

diff --git a/js/samples/04.e.twentyQuestions/src/index.ts b/js/samples/04.e.twentyQuestions/src/index.ts
@@ -93,7 +93,7 @@ const promptManager = new DefaultPromptManager<ApplicationTurnState>(path.join(_
 const storage = new MemoryStorage();
 const app = new ApplicationBuilder<ApplicationTurnState>()
     .withStorage(storage)
-    .withAI({
+    .withAIOptions({
         planner,
         promptManager
     })