[JS] fix: Citations where context was being dropped in OpenAIModel.ts (#2136)

## Linked issues

closes: #2131
closes: #2080

## Details
- Change the abstract length to 477, in the rare case where the word
clips at >477 but <480, then adds ellipses
- `OpenAIModel`: re-add message context so it is not being dropped from
`ToolsAugmentation` changes. This now means citations are being rendered
as expected.

<img width="862" alt="image"
src="https://github.com/user-attachments/assets/307e9f9f-251c-4220-aa87-1268e92057ac">


## Attestation Checklist

- [x] My code follows the style guidelines of this project

- I have checked for/fixed spelling, linting, and other errors
- I have commented my code for clarity
- I have made corresponding changes to the documentation (updating the
doc strings in the code is sufficient)
- My changes generate no new warnings
- I have added tests that validates my changes, and provides sufficient
test coverage. I have tested with:
  - Local testing
  - E2E testing in Teams
- New and existing unit tests pass locally with my changes

### Additional information

> Feel free to add other relevant information below

---------

Co-authored-by: Corina Gum <>

Author: corinagum

dotnet/packages/Microsoft.TeamsAI/Microsoft.TeamsAI/AI/Action/DefaultActions.cs

@@ -105,7 +105,7 @@ public async Task<string> SayCommandAsync([ActionTurnContext] ITurnContext turnC
                 int i = 0;
                 foreach (Citation citation in command.Response.Context.Citations)
                 {
-                    string abs = CitationUtils.Snippet(citation.Content, 480);
+                    string abs = CitationUtils.Snippet(citation.Content, 477);
                     if (isTeamsChannel)
                     {
                         content.Replace("\n", "<br>");

js/packages/teams-ai/package.json

@@ -25,17 +25,17 @@
     "main": "./lib/index.js",
     "types": "./lib/index.d.ts",
     "peerDependencies": {
-        "botbuilder": "^4.23.0",
-        "openai": "^4.61.0"
+        "botbuilder": "^4.23.1",
+        "openai": "^4.68.2"
     },
     "dependencies": {
         "@azure/openai-assistants": "1.0.0-beta.6",
         "@azure/msal-node": "^2.15.0",
         "axios": "^1.7.5",
         "botbuilder-dialogs": "^4.23.1",
-        "botframework-connector": "^4.23.0",
-        "botframework-schema": "^4.23.0",
-        "botframework-streaming": "^4.23.0",
+        "botframework-connector": "^4.23.1",
+        "botframework-schema": "^4.23.1",
+        "botframework-streaming": "^4.23.1",
         "gpt-tokenizer": "^2.5.1",
         "json-colorizer": "^2.2.2",
         "jsonschema": "1.4.1",

js/packages/teams-ai/src/actions/SayCommand.ts

@@ -41,7 +41,7 @@ export function sayCommand<TState extends TurnState = TurnState>(feedbackLoopEna
                     appearance: {
                         '@type': 'DigitalDocument',
                         name: citation.title || `Document #${i + 1}`,
-                        abstract: Utilities.snippet(citation.content, 480)
+                        abstract: Utilities.snippet(citation.content, 477)
                     }
                 };
 

js/packages/teams-ai/src/models/OpenAIModel.spec.ts

@@ -1,3 +1,5 @@
+/// <reference types="mocha" />
+
 import { strict as assert } from 'assert';
 import sinon from 'sinon';
 import { OpenAIModel } from './OpenAIModel';
@@ -87,4 +89,56 @@ describe('OpenAIModel', () => {
             )
         );
     });
+
+    it('should handle citations in the context', async () => {
+        const model = new OpenAIModel({
+            apiKey: 'test-api-key',
+            endpoint: 'https://test-endpoint.com',
+            defaultModel: 'gpt-3.5-turbo'
+        });
+
+        const mockResponse = {
+            choices: [{
+                message: {
+                    role: 'assistant',
+                    content: 'Test response',
+                    context: {
+                        citations: [
+                            {
+                                content: 'Citation content',
+                                title: 'Citation title',
+                                url: 'https://citation.url'
+                            }
+                        ]
+                    }
+                }
+            }]
+        };
+
+        // Mock the API call
+        sinon.stub(model['_client'].chat.completions, 'create').resolves(mockResponse as any);
+
+        // Mock necessary parameters for completePrompt method
+        const context: any = {};
+        const memory: any = { getValue: () => ({}) };
+        const functions: any = {};
+        const tokenizer: any = {};
+        const template: any = {
+            config: { completion: {} },
+            prompt: { renderAsMessages: async () => ({ output: [] }) }
+        };
+
+        const result = await model.completePrompt(context, memory, functions, tokenizer, template);
+
+        assert.equal(result.status, 'success');
+        assert.equal(result.message?.role, 'assistant');
+        assert.equal(result.message?.content, 'Test response');
+        assert.deepEqual(result.message?.context?.citations, [
+            {
+                content: 'Citation content',
+                title: 'Citation title',
+                url: 'https://citation.url'
+            }
+        ]);
+    });
 });

js/packages/teams-ai/src/models/OpenAIModel.ts

@@ -375,16 +375,18 @@ export class OpenAIModel implements PromptCompletionModel {
                     }
                     // Handle tool calls
                     if (delta.tool_calls) {
-                        message.action_calls = delta.tool_calls.map((toolCall) => {
-                            return {
-                                id: toolCall.id,
-                                function: {
-                                    name: toolCall.function!.name,
-                                    arguments: toolCall.function!.arguments
-                                },
-                                type: toolCall.type
-                            } as ActionCall;
-                        });
+                        message.action_calls = delta.tool_calls.map(
+                            (toolCall: OpenAI.Chat.Completions.ChatCompletionChunk.Choice.Delta.ToolCall) => {
+                                return {
+                                    id: toolCall.id,
+                                    function: {
+                                        name: toolCall.function!.name,
+                                        arguments: toolCall.function!.arguments
+                                    },
+                                    type: toolCall.type
+                                } as ActionCall;
+                            }
+                        );
                     }
 
                     // Signal chunk received
@@ -400,8 +402,19 @@ export class OpenAIModel implements PromptCompletionModel {
                     console.log(Colorize.value('duration', Date.now() - startTime, 'ms'));
                 }
             } else {
-                const actionCalls: ActionCall[] = [];
                 const responseMessage = (completion as ChatCompletion).choices![0].message;
+                message = {
+                    role: responseMessage.role,
+                    content: responseMessage.content ?? ''
+                };
+
+                // Preserve message context if there is any
+                const messageWithContext = responseMessage as Message<string>;
+
+                if (messageWithContext.context) {
+                    message.context = messageWithContext.context;
+                }
+                const actionCalls: ActionCall[] = [];
                 const isToolsAugmentation =
                     template.config.augmentation && template.config.augmentation?.augmentation_type == 'tools';
 
@@ -418,16 +431,11 @@ export class OpenAIModel implements PromptCompletionModel {
                         });
                     }
                 }
-                // Log the generated response
-                message = {
-                    role: responseMessage.role,
-                    content: responseMessage.content ?? ''
-                };
-
                 if (actionCalls.length > 0) {
                     message.action_calls = actionCalls;
                 }
 
+                // Log the generated response
                 if (this.options.logRequests) {
                     console.log(Colorize.title('CHAT RESPONSE:'));
                     console.log(Colorize.value('duration', Date.now() - startTime, 'ms'));

js/samples/01.getting-started/a.echoBot/package.json

@@ -25,7 +25,7 @@
         "@microsoft/teams-ai": "~1.5.2",
         "botbuilder": "^4.23.1",
         "dotenv": "^16.4.5",
-        "openai": "4.61.0",
+        "openai": "4.68.2",
         "replace": "~1.2.0",
         "restify": "~11.1.0"
     },

js/samples/02.teams-features/a.messageExtensions.searchCommand/package.json

@@ -23,7 +23,7 @@
         "axios": "^1.7.5",
         "botbuilder": "^4.23.1",
         "dotenv": "^16.4.5",
-        "openai": "4.61.0",
+        "openai": "4.68.2",
         "replace": "~1.2.0",
         "restify": "~11.1.0"
     },

js/samples/02.teams-features/b.adaptiveCards.typeAheadBot/package.json

@@ -26,7 +26,7 @@
         "axios": "^1.7.5",
         "botbuilder": "^4.23.1",
         "dotenv": "^16.4.5",
-        "openai": "4.61.0",
+        "openai": "4.68.2",
         "replace": "~1.2.0",
         "restify": "~11.1.0"
     },

js/samples/03.ai-concepts/a.twentyQuestions/package.json

@@ -24,7 +24,7 @@
         "@microsoft/teams-ai": "~1.5.2",
         "botbuilder": "^4.23.1",
         "dotenv": "^16.4.5",
-        "openai": "4.61.0",
+        "openai": "4.68.2",
         "replace": "~1.2.0",
         "restify": "~11.1.0"
     },

js/samples/03.ai-concepts/b.AI-messageExtensions/package.json

@@ -22,7 +22,7 @@
         "botbuilder": "^4.23.1",
         "@microsoft/teams-ai": "~1.5.2",
         "dotenv": "^16.4.5",
-        "openai": "4.61.0",
+        "openai": "4.68.2",
         "replace": "~1.2.0",
         "restify": "~11.1.0"
     },