@microsoft/agents-hosting 0.5.1-g2e246ff274 → 0.5.4-ga4d0401645

package/dist/src/app/streaming/streamingResponse.js

@@ -0,0 +1,331 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StreamingResponse = void 0;
+const agents_activity_1 = require("@microsoft/agents-activity");
+const utilities_1 = require("./utilities");
+/**
+ * A helper class for streaming responses to the client.
+ * @remarks
+ * This class is used to send a series of updates to the client in a single response. The expected
+ * sequence of calls is:
+ *
+ * `sendInformativeUpdate()`, `sendTextChunk()`, `sendTextChunk()`, ..., `endStream()`.
+ *
+ * Once `endStream()` is called, the stream is considered ended and no further updates can be sent.
+ */
+class StreamingResponse {
+    /**
+       * Creates a new StreamingResponse instance.
+       * @param {TurnContext} context - Context for the current turn of conversation with the user.
+       * @returns {TurnContext} - The context for the current turn of conversation with the user.
+       */
+    constructor(context) {
+        this._nextSequence = 1;
+        this._message = '';
+        this._ended = false;
+        // Queue for outgoing activities
+        this._queue = [];
+        this._chunkQueued = false;
+        // Powered by AI feature flags
+        this._enableFeedbackLoop = false;
+        this._enableGeneratedByAILabel = false;
+        this._citations = [];
+        this._context = context;
+    }
+    /**
+       * Gets the stream ID of the current response.
+       * @returns {string | undefined} - The stream ID of the current response.
+       * @remarks
+       * Assigned after the initial update is sent.
+       */
+    get streamId() {
+        return this._streamId;
+    }
+    /**
+       * Gets the citations of the current response.
+       */
+    get citations() {
+        return this._citations;
+    }
+    /**
+       * Gets the number of updates sent for the stream.
+       * @returns {number} - The number of updates sent for the stream.
+       */
+    get updatesSent() {
+        return this._nextSequence - 1;
+    }
+    /**
+       * Queues an informative update to be sent to the client.
+       * @param {string} text Text of the update to send.
+       */
+    queueInformativeUpdate(text) {
+        if (this._ended) {
+            throw new Error('The stream has already ended.');
+        }
+        // Queue a typing activity
+        this.queueActivity(() => agents_activity_1.Activity.fromObject({
+            type: 'typing',
+            text,
+            channelData: {
+                streamType: 'informative',
+                streamSequence: this._nextSequence++
+            }
+        }));
+    }
+    /**
+       * Queues a chunk of partial message text to be sent to the client
+       * @remarks
+       * The text we be sent as quickly as possible to the client. Chunks may be combined before
+       * delivery to the client.
+       * @param {string} text Partial text of the message to send.
+       * @param {Citation[]} citations Citations to be included in the message.
+       */
+    queueTextChunk(text, citations) {
+        if (this._ended) {
+            throw new Error('The stream has already ended.');
+        }
+        // Update full message text
+        this._message += text;
+        // If there are citations, modify the content so that the sources are numbers instead of [doc1], [doc2], etc.
+        this._message = utilities_1.Utilities.formatCitationsResponse(this._message);
+        // Queue the next chunk
+        this.queueNextChunk();
+    }
+    /**
+       * Ends the stream by sending the final message to the client.
+       * @returns {Promise<void>} - A promise representing the async operation
+       */
+    endStream() {
+        if (this._ended) {
+            throw new Error('The stream has already ended.');
+        }
+        // Queue final message
+        this._ended = true;
+        this.queueNextChunk();
+        // Wait for the queue to drain
+        return this.waitForQueue();
+    }
+    /**
+       * Sets the attachments to attach to the final chunk.
+       * @param attachments List of attachments.
+       */
+    setAttachments(attachments) {
+        this._attachments = attachments;
+    }
+    /**
+       * Sets the sensitivity label to attach to the final chunk.
+       * @param sensitivityLabel The sensitivty label.
+       */
+    setSensitivityLabel(sensitivityLabel) {
+        this._sensitivityLabel = sensitivityLabel;
+    }
+    /**
+       * Sets the citations for the full message.
+       * @param {Citation[]} citations Citations to be included in the message.
+       */
+    setCitations(citations) {
+        if (citations.length > 0) {
+            if (!this._citations) {
+                this._citations = [];
+            }
+            let currPos = this._citations.length;
+            for (const citation of citations) {
+                const clientCitation = {
+                    '@type': 'Claim',
+                    position: currPos + 1,
+                    appearance: {
+                        '@type': 'DigitalDocument',
+                        name: citation.title || `Document #${currPos + 1}`,
+                        abstract: utilities_1.Utilities.snippet(citation.content, 477)
+                    }
+                };
+                currPos++;
+                this._citations.push(clientCitation);
+            }
+        }
+    }
+    /**
+       * Sets the Feedback Loop in Teams that allows a user to
+       * give thumbs up or down to a response.
+       * Default is `false`.
+       * @param enableFeedbackLoop If true, the feedback loop is enabled.
+       */
+    setFeedbackLoop(enableFeedbackLoop) {
+        this._enableFeedbackLoop = enableFeedbackLoop;
+    }
+    /**
+       * Sets the type of UI to use for the feedback loop.
+       * @param feedbackLoopType The type of the feedback loop.
+       */
+    setFeedbackLoopType(feedbackLoopType) {
+        this._feedbackLoopType = feedbackLoopType;
+    }
+    /**
+       * Sets the the Generated by AI label in Teams
+       * Default is `false`.
+       * @param enableGeneratedByAILabel If true, the label is added.
+       */
+    setGeneratedByAILabel(enableGeneratedByAILabel) {
+        this._enableGeneratedByAILabel = enableGeneratedByAILabel;
+    }
+    /**
+       * Returns the most recently streamed message.
+       * @returns The streamed message.
+       */
+    getMessage() {
+        return this._message;
+    }
+    /**
+       * Waits for the outgoing activity queue to be empty.
+       * @returns {Promise<void>} - A promise representing the async operation.
+       */
+    waitForQueue() {
+        return this._queueSync || Promise.resolve();
+    }
+    /**
+       * Queues the next chunk of text to be sent to the client.
+       * @private
+       */
+    queueNextChunk() {
+        // Are we already waiting to send a chunk?
+        if (this._chunkQueued) {
+            return;
+        }
+        // Queue a chunk of text to be sent
+        this._chunkQueued = true;
+        this.queueActivity(() => {
+            this._chunkQueued = false;
+            if (this._ended) {
+                // Send final message
+                return agents_activity_1.Activity.fromObject({
+                    type: 'message',
+                    text: this._message,
+                    attachments: this._attachments,
+                    channelData: {
+                        streamType: 'final'
+                    }
+                });
+            }
+            else {
+                // Send typing activity
+                return agents_activity_1.Activity.fromObject({
+                    type: 'typing',
+                    text: this._message,
+                    channelData: {
+                        streamType: 'streaming',
+                        streamSequence: this._nextSequence++
+                    }
+                });
+            }
+        });
+    }
+    /**
+       * Queues an activity to be sent to the client.
+       */
+    queueActivity(factory) {
+        this._queue.push(factory);
+        // If there's no sync in progress, start one
+        if (!this._queueSync) {
+            this._queueSync = this.drainQueue().catch((err) => {
+                console.error(`Error occured when sending activity while streaming: "${err}".`);
+                throw err;
+            });
+        }
+    }
+    /**
+       * Sends any queued activities to the client until the queue is empty.
+       * @returns {Promise<void>} - A promise that will be resolved once the queue is empty.
+       * @private
+       */
+    async drainQueue() {
+        // eslint-disable-next-line no-async-promise-executor
+        return new Promise(async (resolve, reject) => {
+            try {
+                while (this._queue.length > 0) {
+                    // Get next activity from queue
+                    const factory = this._queue.shift();
+                    const activity = factory();
+                    // Send activity
+                    await this.sendActivity(activity);
+                }
+                resolve();
+            }
+            catch (err) {
+                reject(err);
+            }
+            finally {
+                // Queue is empty, mark as idle
+                this._queueSync = undefined;
+            }
+        });
+    }
+    /**
+       * Sends an activity to the client and saves the stream ID returned.
+       * @param {Activity} activity - The activity to send.
+       * @returns {Promise<void>} - A promise representing the async operation.
+       * @private
+       */
+    async sendActivity(activity) {
+        var _a;
+        // Set activity ID to the assigned stream ID
+        if (this._streamId) {
+            activity.id = this._streamId;
+            activity.channelData = Object.assign({}, activity.channelData, { streamId: this._streamId });
+        }
+        activity.entities = [
+            {
+                type: 'streaminfo',
+                ...activity.channelData
+            }
+        ];
+        if (this._citations && this._citations.length > 0 && !this._ended) {
+            // Filter out the citations unused in content.
+            const currCitations = (_a = utilities_1.Utilities.getUsedCitations(this._message, this._citations)) !== null && _a !== void 0 ? _a : undefined;
+            activity.entities.push({
+                type: 'https://schema.org/Message',
+                '@type': 'Message',
+                '@context': 'https://schema.org',
+                '@id': '',
+                citation: currCitations
+            });
+        }
+        // Add in Powered by AI feature flags
+        if (this._ended) {
+            if (this._enableFeedbackLoop && this._feedbackLoopType) {
+                activity.channelData = Object.assign({}, activity.channelData, {
+                    feedbackLoop: { type: this._feedbackLoopType }
+                });
+            }
+            else {
+                activity.channelData = Object.assign({}, activity.channelData, {
+                    feedbackLoopEnabled: this._enableFeedbackLoop
+                });
+            }
+            // Add in Generated by AI
+            if (this._enableGeneratedByAILabel) {
+                activity.entities.push({
+                    type: 'https://schema.org/Message',
+                    '@type': 'Message',
+                    '@context': 'https://schema.org',
+                    '@id': '',
+                    additionalType: ['AIGeneratedContent'],
+                    citation: this._citations && this._citations.length > 0 ? this._citations : [],
+                    usageInfo: this._sensitivityLabel
+                });
+            }
+        }
+        // Send activity
+        const response = await this._context.sendActivity(activity);
+        // await new Promise((resolve) => setTimeout(resolve, 1500))
+        // Save assigned stream ID
+        if (!this._streamId) {
+            this._streamId = response === null || response === void 0 ? void 0 : response.id;
+        }
+    }
+}
+exports.StreamingResponse = StreamingResponse;
+//# sourceMappingURL=streamingResponse.js.map

package/dist/src/app/streaming/streamingResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streamingResponse.js","sourceRoot":"","sources":["../../../../src/app/streaming/streamingResponse.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,gEAAyE;AAKzE,2CAAuC;AAEvC;;;;;;;;;GASG;AACH,MAAa,iBAAiB;IAoB5B;;;;SAIK;IACL,YAAoB,OAAoB;QAvBhC,kBAAa,GAAW,CAAC,CAAA;QAEzB,aAAQ,GAAW,EAAE,CAAA;QAErB,WAAM,GAAG,KAAK,CAAA;QAEtB,gCAAgC;QACxB,WAAM,GAA0B,EAAE,CAAA;QAElC,iBAAY,GAAG,KAAK,CAAA;QAE5B,8BAA8B;QACtB,wBAAmB,GAAG,KAAK,CAAA;QAE3B,8BAAyB,GAAG,KAAK,CAAA;QACjC,eAAU,GAAsB,EAAE,CAAA;QASxC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAA;IACzB,CAAC;IAED;;;;;SAKK;IACL,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAED;;SAEK;IACL,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAED;;;SAGK;IACL,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;IAC/B,CAAC;IAED;;;SAGK;IACE,sBAAsB,CAAE,IAAY;QACzC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAClD,CAAC;QAED,0BAA0B;QAC1B,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,0BAAQ,CAAC,UAAU,CAAC;YAC3C,IAAI,EAAE,QAAQ;YACd,IAAI;YACJ,WAAW,EAAE;gBACX,UAAU,EAAE,aAAa;gBACzB,cAAc,EAAE,IAAI,CAAC,aAAa,EAAE;aACb;SAC1B,CAAC,CAAC,CAAA;IACL,CAAC;IAED;;;;;;;SAOK;IACE,cAAc,CAAE,IAAY,EAAE,SAAsB;QACzD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAClD,CAAC;QAED,2BAA2B;QAC3B,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAA;QAErB,6GAA6G;QAC7G,IAAI,CAAC,QAAQ,GAAG,qBAAS,CAAC,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAEhE,uBAAuB;QACvB,IAAI,CAAC,cAAc,EAAE,CAAA;IACvB,CAAC;IAED;;;SAGK;IACE,SAAS;QACd,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAClD,CAAC;QAED,sBAAsB;QACtB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;QAClB,IAAI,CAAC,cAAc,EAAE,CAAA;QAErB,8BAA8B;QAC9B,OAAO,IAAI,CAAC,YAAY,EAAE,CAAA;IAC5B,CAAC;IAED;;;SAGK;IACE,cAAc,CAAE,WAAyB;QAC9C,IAAI,CAAC,YAAY,GAAG,WAAW,CAAA;IACjC,CAAC;IAED;;;SAGK;IACE,mBAAmB,CAAE,gBAAsC;QAChE,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAA;IAC3C,CAAC;IAED;;;SAGK;IACE,YAAY,CAAE,SAAqB;QACxC,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;gBACrB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAA;YACtB,CAAC;YACD,IAAI,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAA;YAEpC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,MAAM,cAAc,GAAmB;oBACrC,OAAO,EAAE,OAAO;oBAChB,QAAQ,EAAE,OAAO,GAAG,CAAC;oBACrB,UAAU,EAAE;wBACV,OAAO,EAAE,iBAAiB;wBAC1B,IAAI,EAAE,QAAQ,CAAC,KAAK,IAAI,aAAa,OAAO,GAAG,CAAC,EAAE;wBAClD,QAAQ,EAAE,qBAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC;qBACnD;iBACF,CAAA;gBACD,OAAO,EAAE,CAAA;gBACT,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;YACtC,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;;SAKK;IACE,eAAe,CAAE,kBAA2B;QACjD,IAAI,CAAC,mBAAmB,GAAG,kBAAkB,CAAA;IAC/C,CAAC;IAED;;;SAGK;IACE,mBAAmB,CAAE,gBAAsC;QAChE,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAA;IAC3C,CAAC;IAED;;;;SAIK;IACE,qBAAqB,CAAE,wBAAiC;QAC7D,IAAI,CAAC,yBAAyB,GAAG,wBAAwB,CAAA;IAC3D,CAAC;IAED;;;SAGK;IACE,UAAU;QACf,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED;;;SAGK;IACE,YAAY;QACjB,OAAO,IAAI,CAAC,UAAU,IAAI,OAAO,CAAC,OAAO,EAAE,CAAA;IAC7C,CAAC;IAED;;;SAGK;IACG,cAAc;QACpB,0CAA0C;QAC1C,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,OAAM;QACR,CAAC;QAED,mCAAmC;QACnC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;QACxB,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE;YACtB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;YACzB,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAChB,qBAAqB;gBACrB,OAAO,0BAAQ,CAAC,UAAU,CAAC;oBACzB,IAAI,EAAE,SAAS;oBACf,IAAI,EAAE,IAAI,CAAC,QAAQ;oBACnB,WAAW,EAAE,IAAI,CAAC,YAAY;oBAC9B,WAAW,EAAE;wBACX,UAAU,EAAE,OAAO;qBACI;iBAC1B,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,uBAAuB;gBACvB,OAAO,0BAAQ,CAAC,UAAU,CAAC;oBACzB,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,IAAI,CAAC,QAAQ;oBACnB,WAAW,EAAE;wBACX,UAAU,EAAE,WAAW;wBACvB,cAAc,EAAE,IAAI,CAAC,aAAa,EAAE;qBACb;iBAC1B,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;SAEK;IACG,aAAa,CAAE,OAAuB;QAC5C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAEzB,4CAA4C;QAC5C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;gBAChD,OAAO,CAAC,KAAK,CAAC,yDAAyD,GAAG,IAAI,CAAC,CAAA;gBAC/E,MAAM,GAAG,CAAA;YACX,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED;;;;SAIK;IACG,KAAK,CAAC,UAAU;QACtB,qDAAqD;QACrD,OAAO,IAAI,OAAO,CAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;YACjD,IAAI,CAAC;gBACH,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC9B,+BAA+B;oBAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,EAAG,CAAA;oBACpC,MAAM,QAAQ,GAAG,OAAO,EAAE,CAAA;oBAE1B,gBAAgB;oBAChB,MAAM,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;gBACnC,CAAC;gBAED,OAAO,EAAE,CAAA;YACX,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,MAAM,CAAC,GAAG,CAAC,CAAA;YACb,CAAC;oBAAS,CAAC;gBACT,+BAA+B;gBAC/B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAA;YAC7B,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;SAKK;IACG,KAAK,CAAC,YAAY,CAAE,QAAkB;;QAC5C,4CAA4C;QAC5C,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,QAAQ,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAA;YAC5B,QAAQ,CAAC,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;QAC9F,CAAC;QAED,QAAQ,CAAC,QAAQ,GAAG;YAClB;gBACE,IAAI,EAAE,YAAY;gBAClB,GAAG,QAAQ,CAAC,WAAW;aACd;SACZ,CAAA;QAED,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAClE,8CAA8C;YAC9C,MAAM,aAAa,GAAG,MAAA,qBAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,mCAAI,SAAS,CAAA;YAC7F,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;gBACrB,IAAI,EAAE,4BAA4B;gBAClC,OAAO,EAAE,SAAS;gBAClB,UAAU,EAAE,oBAAoB;gBAChC,KAAK,EAAE,EAAE;gBACT,QAAQ,EAAE,aAAa;aACH,CAAC,CAAA;QACzB,CAAC;QAED,qCAAqC;QACrC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,IAAI,IAAI,CAAC,mBAAmB,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACvD,QAAQ,CAAC,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,WAAW,EAAE;oBAC7D,YAAY,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,iBAAiB,EAAE;iBAC/C,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,WAAW,EAAE;oBAC7D,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;iBAC9C,CAAC,CAAA;YACJ,CAAC;YAED,yBAAyB;YACzB,IAAI,IAAI,CAAC,yBAAyB,EAAE,CAAC;gBACnC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC;oBACrB,IAAI,EAAE,4BAA4B;oBAClC,OAAO,EAAE,SAAS;oBAClB,UAAU,EAAE,oBAAoB;oBAChC,KAAK,EAAE,EAAE;oBACT,cAAc,EAAE,CAAC,oBAAoB,CAAC;oBACtC,QAAQ,EAAE,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE;oBAC9E,SAAS,EAAE,IAAI,CAAC,iBAAiB;iBACb,CAAC,CAAA;YACzB,CAAC;QACH,CAAC;QAED,gBAAgB;QAChB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QAC3D,4DAA4D;QAE5D,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,SAAS,GAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,EAAE,CAAA;QAC/B,CAAC;IACH,CAAC;CACF;AA5VD,8CA4VC"}

package/dist/src/app/streaming/utilities.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ClientCitation } from './clientCitation';
+/**
+ * Utility functions for manipulating .
+ */
+export declare class Utilities {
+    /**
+       *
+       * Clips the text to a maximum length in case it exceeds the limit.
+       * @param {string} text The text to clip.
+       * @param {number} maxLength The maximum length of the text to return, cutting off the last whole word.
+       * @returns {string} The modified text
+       */
+    static snippet(text: string, maxLength: number): string;
+    /**
+       * Convert citation tags `[doc(s)n]` to `[n]` where n is a number.
+       * @param {string} text The text to format.
+       * @returns {string} The formatted text.
+       */
+    static formatCitationsResponse(text: string): string;
+    /**
+       * Get the citations used in the text. This will remove any citations that are included in the citations array from the response but not referenced in the text.
+       * @param {string} text - The text to search for citation references, i.e. [1], [2], etc.
+       * @param {ClientCitation[]} citations - The list of citations to search for.
+       * @returns {ClientCitation[] | undefined} The list of citations used in the text.
+       */
+    static getUsedCitations(text: string, citations: ClientCitation[]): ClientCitation[] | undefined;
+}

package/dist/src/app/streaming/utilities.js

@@ -0,0 +1,101 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Utilities = void 0;
+// import { stringify } from 'yaml'
+// import { Tokenizer } from './tokenizers'
+/**
+ * Utility functions for manipulating .
+ */
+class Utilities {
+    //   /**
+    //      * Converts a value to a string.
+    //      * @remarks
+    //      * Dates are converted to ISO strings and Objects are converted to JSON or YAML, whichever is shorter.
+    //      * @param {Tokenizer} tokenizer Tokenizer to use for encoding.
+    //      * @param {any} value Value to convert.
+    //      * @param {boolean} asJSON Optional. If true objects will always be converted to JSON instead of YAML. Defaults to false.
+    //      * @returns {string} Converted value.
+    //      */
+    //   public static toString (tokenizer: Tokenizer, value: any, asJSON: boolean = false): string {
+    //     if (value === undefined || value === null) {
+    //       return ''
+    //     } else if (typeof value === 'object') {
+    //       if (typeof value.toISOString === 'function') {
+    //         return value.toISOString()
+    //       } else if (asJSON) {
+    //         return JSON.stringify(value)
+    //       } else {
+    //         // Return shorter version of object
+    //         const asYaml = stringify(value)
+    //         const asJSON = JSON.stringify(value)
+    //         if (tokenizer.encode(asYaml).length <= tokenizer.encode(asJSON).length) {
+    //           return asYaml
+    //         } else {
+    //           return asJSON
+    //         }
+    //       }
+    //     } else {
+    //       return value.toString()
+    //     }
+    //   }
+    /**
+       *
+       * Clips the text to a maximum length in case it exceeds the limit.
+       * @param {string} text The text to clip.
+       * @param {number} maxLength The maximum length of the text to return, cutting off the last whole word.
+       * @returns {string} The modified text
+       */
+    static snippet(text, maxLength) {
+        if (text.length <= maxLength) {
+            return text;
+        }
+        let snippet = text.slice(0, maxLength);
+        snippet = snippet.slice(0, Math.min(snippet.length, snippet.lastIndexOf(' ')));
+        snippet += '...';
+        return snippet;
+    }
+    /**
+       * Convert citation tags `[doc(s)n]` to `[n]` where n is a number.
+       * @param {string} text The text to format.
+       * @returns {string} The formatted text.
+       */
+    static formatCitationsResponse(text) {
+        return text.replace(/\[docs?(\d+)\]/gi, '[$1]');
+    }
+    /**
+       * Get the citations used in the text. This will remove any citations that are included in the citations array from the response but not referenced in the text.
+       * @param {string} text - The text to search for citation references, i.e. [1], [2], etc.
+       * @param {ClientCitation[]} citations - The list of citations to search for.
+       * @returns {ClientCitation[] | undefined} The list of citations used in the text.
+       */
+    static getUsedCitations(text, citations) {
+        const regex = /\[(\d+)\]/gi;
+        const matches = text.match(regex);
+        if (!matches) {
+            return undefined;
+        }
+        // Remove duplicates
+        const filteredMatches = new Set();
+        matches.forEach((match) => {
+            if (filteredMatches.has(match)) {
+                return;
+            }
+            filteredMatches.add(match);
+        });
+        // Add citations
+        const usedCitations = [];
+        filteredMatches.forEach((match) => {
+            const found = citations.find((citation) => `[${citation.position}]` === match);
+            if (found) {
+                usedCitations.push(found);
+            }
+        });
+        return usedCitations;
+    }
+}
+exports.Utilities = Utilities;
+//# sourceMappingURL=utilities.js.map

package/dist/src/app/streaming/utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utilities.js","sourceRoot":"","sources":["../../../../src/app/streaming/utilities.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,mCAAmC;AAEnC,2CAA2C;AAE3C;;GAEG;AACH,MAAa,SAAS;IACtB,QAAQ;IACR,uCAAuC;IACvC,kBAAkB;IAClB,6GAA6G;IAC7G,qEAAqE;IACrE,8CAA8C;IAC9C,gIAAgI;IAChI,4CAA4C;IAC5C,UAAU;IACV,iGAAiG;IACjG,mDAAmD;IACnD,kBAAkB;IAClB,8CAA8C;IAC9C,uDAAuD;IACvD,qCAAqC;IACrC,6BAA6B;IAC7B,uCAAuC;IACvC,iBAAiB;IACjB,8CAA8C;IAC9C,0CAA0C;IAC1C,+CAA+C;IAC/C,oFAAoF;IACpF,0BAA0B;IAC1B,mBAAmB;IACnB,0BAA0B;IAC1B,YAAY;IACZ,UAAU;IACV,eAAe;IACf,gCAAgC;IAChC,QAAQ;IACR,MAAM;IAEJ;;;;;;SAMK;IACE,MAAM,CAAC,OAAO,CAAE,IAAY,EAAE,SAAiB;QACpD,IAAI,IAAI,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAA;QACb,CAAC;QACD,IAAI,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAA;QACtC,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;QAC9E,OAAO,IAAI,KAAK,CAAA;QAChB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;SAIK;IACE,MAAM,CAAC,uBAAuB,CAAE,IAAY;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAA;IACjD,CAAC;IAED;;;;;SAKK;IACE,MAAM,CAAC,gBAAgB,CAAE,IAAY,EAAE,SAA2B;QACvE,MAAM,KAAK,GAAG,aAAa,CAAA;QAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QAEjC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,SAAS,CAAA;QAClB,CAAC;QAED,oBAAoB;QACpB,MAAM,eAAe,GAAG,IAAI,GAAG,EAAE,CAAA;QACjC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACxB,IAAI,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/B,OAAM;YACR,CAAC;YAED,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QAC5B,CAAC,CAAC,CAAA;QAEF,gBAAgB;QAChB,MAAM,aAAa,GAAqB,EAAE,CAAA;QAC1C,eAAe,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAChC,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,QAAQ,CAAC,QAAQ,GAAG,KAAK,KAAK,CAAC,CAAA;YAC9E,IAAI,KAAK,EAAE,CAAC;gBACV,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAC3B,CAAC;QACH,CAAC,CAAC,CAAA;QACF,OAAO,aAAa,CAAA;IACtB,CAAC;CACF;AA7FD,8BA6FC"}

package/dist/src/turnContext.d.ts

@@ -4,6 +4,7 @@ import { ResourceResponse } from './connector-client/resourceResponse';
 import { TurnContextStateCollection } from './turnContextStateCollection';
 import { AttachmentInfo } from './connector-client/attachmentInfo';
 import { AttachmentData } from './connector-client/attachmentData';
+import { StreamingResponse } from './app/streaming/streamingResponse';
 /**
  * Defines a handler for processing and sending activities.
  * Used for middleware that needs to intercept or modify activities being sent.
@@ -66,6 +67,7 @@ export declare class TurnContext {
     private readonly _onDeleteActivity;
     private readonly _turn;
     private readonly _locale;
+    private readonly _streamingResponse;
     /**
      * Initializes a new instance of the TurnContext class.
      *
@@ -229,6 +231,7 @@ export declare class TurnContext {
      * the processing of the current turn.
      */
     get turnState(): TurnContextStateCollection;
+    get streamingResponse(): StreamingResponse;
     /**
      * Emits events to registered middleware handlers.
      *

package/dist/src/turnContext.js

@@ -5,6 +5,7 @@ exports.TurnContext = exports.AgentCallbackHandlerKey = void 0;
 const activityHandler_1 = require("./activityHandler");
 const agents_activity_1 = require("@microsoft/agents-activity");
 const turnContextStateCollection_1 = require("./turnContextStateCollection");
+const streamingResponse_1 = require("./app/streaming/streamingResponse");
 /**
  * Key for the agent callback handler in TurnState collection.
  */
@@ -48,6 +49,7 @@ class TurnContext {
             this._adapter = adapterOrContext;
             this._activity = request;
         }
+        this._streamingResponse = new streamingResponse_1.StreamingResponse(this);
     }
     /**
      * Sends a trace activity for debugging purposes.
@@ -327,6 +329,9 @@ class TurnContext {
     get turnState() {
         return this._turnState;
     }
+    get streamingResponse() {
+        return this._streamingResponse;
+    }
     /**
      * Emits events to registered middleware handlers.
      *

package/dist/src/turnContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"turnContext.js","sourceRoot":"","sources":["../../src/turnContext.ts"],"names":[],"mappings":";;;AAAA,oGAAoG;AACpG,uDAAuD;AAEvD,gEAAsH;AAEtH,6EAAyE;AAkCzE;;GAEG;AACU,QAAA,uBAAuB,GAAG,sBAAsB,CAAA;AAO7D;;;;;;;;;;;;;;;GAeG;AACH,MAAa,WAAW;IAmBtB,YAAa,gBAA2C,EAAE,OAAkB;QAhB3D,kBAAa,GAA2B,EAAE,SAAS,EAAE,KAAK,EAAE,CAAA;QAC5D,eAAU,GAAG,IAAI,uDAA0B,EAAE,CAAA;QAC7C,sBAAiB,GAA4B,EAAE,CAAA;QAC/C,sBAAiB,GAA4B,EAAE,CAAA;QAC/C,sBAAiB,GAA4B,EAAE,CAAA;QAC/C,UAAK,GAAG,MAAM,CAAA;QACd,YAAO,GAAG,QAAQ,CAAA;QAmBnC;;;;;WAKG;QACM,4BAAuB,GAAe,EAAE,CAAA;QAd/C,IAAI,gBAAgB,YAAY,WAAW,EAAE,CAAC;YAC5C,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAC/B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAA;YAChC,IAAI,CAAC,SAAS,GAAG,OAAmB,CAAA;QACtC,CAAC;IACH,CAAC;IAUD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,iBAAiB,CAAE,IAAY,EAAE,KAAW,EAAE,SAAkB,EAAE,KAAc;QACpF,MAAM,gBAAgB,GAAG;YACvB,IAAI,EAAE,+BAAa,CAAC,KAAK;YACzB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,IAAI;YACJ,KAAK;YACL,SAAS;YACT,KAAK;SACN,CAAA;QACD,MAAM,aAAa,GAAG,0BAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAA;QAC3D,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAA;IAC/C,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,YAAY,CAAE,cAAiC,EAAE,KAAc,EAAE,SAAkB;QACvF,IAAI,cAAkB,CAAA;QACtB,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YACvC,cAAc,GAAG,EAAE,IAAI,EAAE,+BAAa,CAAC,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,SAAS,EAAE,SAAS,IAAI,4BAAU,CAAC,cAAc,EAAE,CAAA;YACzH,IAAI,KAAK,EAAE,CAAC;gBACV,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,KAAK,EAAE,CAAA;YAC/C,CAAC;QACH,CAAC;aAAM,CAAC;YACN,cAAc,GAAG,cAAc,CAAA;QACjC,CAAC;QACD,MAAM,QAAQ,GAAG,0BAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;QAEpD,MAAM,SAAS,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;QAC/D,OAAO,SAAS,CAAC,CAAC,CAAC,CAAA;IACrB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,cAAc,CAAE,UAAsB;QAC1C,IAAI,oBAAoB,GAAG,KAAK,CAAA;QAChC,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,wBAAwB,EAAE,CAAA;QACpD,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YACzC,MAAM,MAAM,GAAG,QAAQ,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAA;YACvD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACjB,MAAM,CAAC,IAAI,GAAG,+BAAa,CAAC,OAAO,CAAA;YACrC,CAAC;YACD,IAAI,MAAM,CAAC,IAAI,KAAK,+BAAa,CAAC,cAAc,EAAE,CAAC;gBACjD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,qCAAmB,EAAE,QAAQ,CAAC,CAAA;YACnD,CAAC;YACD,IAAI,MAAM,CAAC,IAAI,KAAK,+BAAa,CAAC,KAAK,EAAE,CAAC;gBACxC,oBAAoB,GAAG,IAAI,CAAA;YAC7B,CAAC;YACD,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,OAAO,MAAM,CAAC,EAAE,CAAA;YAClB,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC,CAAC,CAAA;QACF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,KAAK,IAAI,EAAE;YAChE,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,KAAK,+BAAa,CAAC,aAAa,EAAE,CAAC;gBAC/D,MAAM,SAAS,GAAuB,EAAE,CAAA;gBACxC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;oBACnB,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;oBACpC,IAAI,CAAC,CAAC,IAAI,KAAK,+BAAa,CAAC,cAAc,EAAE,CAAC;wBAC5C,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,qCAAmB,EAAE,CAAC,CAAC,CAAA;oBAC5C,CAAC;oBACD,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAA;gBAC5B,CAAC,CAAC,CAAA;gBACF,IAAI,oBAAoB,EAAE,CAAC;oBACzB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;gBACvB,CAAC;gBACD,OAAO,SAAS,CAAA;YAClB,CAAC;iBAAM,CAAC;gBACN,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;gBACjE,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,IAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM,CAAA,EAAE,KAAK,EAAE,EAAE,CAAC;oBACvD,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;oBAC9B,QAAQ,CAAC,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAA;gBACnC,CAAC;gBACD,IAAI,oBAAoB,EAAE,CAAC;oBACzB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;gBACvB,CAAC;gBACD,OAAO,SAAS,CAAA;YAClB,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,cAAc,CAAE,QAAkB;QACtC,MAAM,GAAG,GAA0B,IAAI,CAAC,QAAQ,CAAC,wBAAwB,EAAE,CAAA;QAC3E,MAAM,CAAC,GAAa,QAAQ,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAA;QAC5D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,EAAE,KAAK,IAAI,EAAE,CAC3D,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAC1D,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAE,aAA6C;QACjE,IAAI,SAAgC,CAAA;QACpC,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;YACtC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,wBAAwB,EAAE,CAAA;YACpD,SAAS,CAAC,UAAU,GAAG,aAAa,CAAA;QACtC,CAAC;aAAM,CAAC;YACN,SAAS,GAAG,aAAa,CAAA;QAC3B,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAA;IAC3H,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CAAE,cAAsB,EAAE,cAA8B;QAC5E,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAA;IAC5E,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CAAE,YAAoB;QAC3C,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAA;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CAAE,YAAoB,EAAE,MAAc;QACvD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;IAC/D,CAAC;IAED;;;;;;;;OAQG;IACH,gBAAgB,CAAE,OAA8B;QAC9C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACpC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAE,OAA8B;QAC9C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACpC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAE,OAA8B;QAC9C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACpC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;OAOG;IACO,MAAM,CAAE,OAAoB;QACpC,CAAC,UAAU,EAAE,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,CAAE,OAAe,CAAC,IAAI,CAAC,GAAI,IAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAClM,CAAC;IAED;;;;;OAKG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAuB,CAAA;IACrC,CAAC;IAED;;;;;OAKG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAqB,CAAA;IACnC,CAAC;IAED;;;;;OAKG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAA;IACrC,CAAC;IAED,IAAI,SAAS,CAAE,KAAc;QAC3B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAA;QAC/E,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,SAAS,GAAG,IAAI,CAAA;IACrC,CAAC;IAED;;;;;OAKG;IACH,IAAI,MAAM;QACR,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/C,IAAI,OAAO,IAAI,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YACzD,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC9B,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,IAAI,MAAM,CAAE,KAAyB;QACnC,IAAI,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC7C,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,KAAK,CAAA;QAC/B,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAA;YACnC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QAC1C,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAED;;;;;;;;;;;;OAYG;IACK,KAAK,CAAC,IAAI,CAAO,QAAqF,EAAE,GAAM,EAAE,IAAsB;QAC5I,MAAM,WAAW,GAAG,KAAK,EAAE,CAAC,OAAO,EAAE,GAAG,SAAS,CAAkB,EAAc,EAAE;YACjF,IAAI,CAAC;gBACH,OAAO,OAAO,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;YACrH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,MAAM,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAClC,CAAC;QACH,CAAC,CAAA;QACD,OAAO,MAAM,WAAW,CAAC,QAAQ,CAAC,CAAA;IACpC,CAAC;CACF;AAnWD,kCAmWC"}
+{"version":3,"file":"turnContext.js","sourceRoot":"","sources":["../../src/turnContext.ts"],"names":[],"mappings":";;;AAAA,oGAAoG;AACpG,uDAAuD;AAEvD,gEAAsH;AAEtH,6EAAyE;AAGzE,yEAAqE;AAgCrE;;GAEG;AACU,QAAA,uBAAuB,GAAG,sBAAsB,CAAA;AAO7D;;;;;;;;;;;;;;;GAeG;AACH,MAAa,WAAW;IAmBtB,YAAa,gBAA2C,EAAE,OAAkB;QAhB3D,kBAAa,GAA2B,EAAE,SAAS,EAAE,KAAK,EAAE,CAAA;QAC5D,eAAU,GAAG,IAAI,uDAA0B,EAAE,CAAA;QAC7C,sBAAiB,GAA4B,EAAE,CAAA;QAC/C,sBAAiB,GAA4B,EAAE,CAAA;QAC/C,sBAAiB,GAA4B,EAAE,CAAA;QAC/C,UAAK,GAAG,MAAM,CAAA;QACd,YAAO,GAAG,QAAQ,CAAA;QAoBnC;;;;;WAKG;QACM,4BAAuB,GAAe,EAAE,CAAA;QAf/C,IAAI,gBAAgB,YAAY,WAAW,EAAE,CAAC;YAC5C,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QAC/B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAA;YAChC,IAAI,CAAC,SAAS,GAAG,OAAmB,CAAA;QACtC,CAAC;QACD,IAAI,CAAC,kBAAkB,GAAG,IAAI,qCAAiB,CAAC,IAAI,CAAC,CAAA;IACvD,CAAC;IAUD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,iBAAiB,CAAE,IAAY,EAAE,KAAW,EAAE,SAAkB,EAAE,KAAc;QACpF,MAAM,gBAAgB,GAAG;YACvB,IAAI,EAAE,+BAAa,CAAC,KAAK;YACzB,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YACnC,IAAI;YACJ,KAAK;YACL,SAAS;YACT,KAAK;SACN,CAAA;QACD,MAAM,aAAa,GAAG,0BAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAA;QAC3D,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,CAAA;IAC/C,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,YAAY,CAAE,cAAiC,EAAE,KAAc,EAAE,SAAkB;QACvF,IAAI,cAAkB,CAAA;QACtB,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YACvC,cAAc,GAAG,EAAE,IAAI,EAAE,+BAAa,CAAC,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,SAAS,EAAE,SAAS,IAAI,4BAAU,CAAC,cAAc,EAAE,CAAA;YACzH,IAAI,KAAK,EAAE,CAAC;gBACV,cAAc,GAAG,EAAE,GAAG,cAAc,EAAE,KAAK,EAAE,CAAA;YAC/C,CAAC;QACH,CAAC;aAAM,CAAC;YACN,cAAc,GAAG,cAAc,CAAA;QACjC,CAAC;QACD,MAAM,QAAQ,GAAG,0BAAQ,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;QAEpD,MAAM,SAAS,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;QAC/D,OAAO,SAAS,CAAC,CAAC,CAAC,CAAA;IACrB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,cAAc,CAAE,UAAsB;QAC1C,IAAI,oBAAoB,GAAG,KAAK,CAAA;QAChC,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,wBAAwB,EAAE,CAAA;QACpD,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YACzC,MAAM,MAAM,GAAG,QAAQ,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAA;YACvD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACjB,MAAM,CAAC,IAAI,GAAG,+BAAa,CAAC,OAAO,CAAA;YACrC,CAAC;YACD,IAAI,MAAM,CAAC,IAAI,KAAK,+BAAa,CAAC,cAAc,EAAE,CAAC;gBACjD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,qCAAmB,EAAE,QAAQ,CAAC,CAAA;YACnD,CAAC;YACD,IAAI,MAAM,CAAC,IAAI,KAAK,+BAAa,CAAC,KAAK,EAAE,CAAC;gBACxC,oBAAoB,GAAG,IAAI,CAAA;YAC7B,CAAC;YACD,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,OAAO,MAAM,CAAC,EAAE,CAAA;YAClB,CAAC;YACD,OAAO,MAAM,CAAA;QACf,CAAC,CAAC,CAAA;QACF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,MAAM,EAAE,KAAK,IAAI,EAAE;YAChE,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,KAAK,+BAAa,CAAC,aAAa,EAAE,CAAC;gBAC/D,MAAM,SAAS,GAAuB,EAAE,CAAA;gBACxC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;oBACnB,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;oBACpC,IAAI,CAAC,CAAC,IAAI,KAAK,+BAAa,CAAC,cAAc,EAAE,CAAC;wBAC5C,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,qCAAmB,EAAE,CAAC,CAAC,CAAA;oBAC5C,CAAC;oBACD,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAA;gBAC5B,CAAC,CAAC,CAAA;gBACF,IAAI,oBAAoB,EAAE,CAAC;oBACzB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;gBACvB,CAAC;gBACD,OAAO,SAAS,CAAA;YAClB,CAAC;iBAAM,CAAC;gBACN,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;gBACjE,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,IAAG,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM,CAAA,EAAE,KAAK,EAAE,EAAE,CAAC;oBACvD,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;oBAC9B,QAAQ,CAAC,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAA;gBACnC,CAAC;gBACD,IAAI,oBAAoB,EAAE,CAAC;oBACzB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;gBACvB,CAAC;gBACD,OAAO,SAAS,CAAA;YAClB,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,cAAc,CAAE,QAAkB;QACtC,MAAM,GAAG,GAA0B,IAAI,CAAC,QAAQ,CAAC,wBAAwB,EAAE,CAAA;QAC3E,MAAM,CAAC,GAAa,QAAQ,CAAC,0BAA0B,CAAC,GAAG,CAAC,CAAA;QAC5D,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,EAAE,KAAK,IAAI,EAAE,CAC3D,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAC1D,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAE,aAA6C;QACjE,IAAI,SAAgC,CAAA;QACpC,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;YACtC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,wBAAwB,EAAE,CAAA;YACpD,SAAS,CAAC,UAAU,GAAG,aAAa,CAAA;QACtC,CAAC;aAAM,CAAC;YACN,SAAS,GAAG,aAAa,CAAA;QAC3B,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAA;IAC3H,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CAAE,cAAsB,EAAE,cAA8B;QAC5E,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,cAAc,EAAE,cAAc,CAAC,CAAA;IAC5E,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CAAE,YAAoB;QAC3C,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAA;IAC3D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CAAE,YAAoB,EAAE,MAAc;QACvD,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;IAC/D,CAAC;IAED;;;;;;;;OAQG;IACH,gBAAgB,CAAE,OAA8B;QAC9C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACpC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAE,OAA8B;QAC9C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACpC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAE,OAA8B;QAC9C,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACpC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;OAOG;IACO,MAAM,CAAE,OAAoB;QACpC,CAAC,UAAU,EAAE,WAAW,EAAE,eAAe,EAAE,WAAW,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,mBAAmB,CAAC,CAAC,OAAO,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,CAAE,OAAe,CAAC,IAAI,CAAC,GAAI,IAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAClM,CAAC;IAED;;;;;OAKG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAuB,CAAA;IACrC,CAAC;IAED;;;;;OAKG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAqB,CAAA;IACnC,CAAC;IAED;;;;;OAKG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAA;IACrC,CAAC;IAED,IAAI,SAAS,CAAE,KAAc;QAC3B,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAA;QAC/E,CAAC;QACD,IAAI,CAAC,aAAa,CAAC,SAAS,GAAG,IAAI,CAAA;IACrC,CAAC;IAED;;;;;OAKG;IACH,IAAI,MAAM;QACR,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC/C,IAAI,OAAO,IAAI,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;YACzD,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC9B,CAAC;QACD,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,IAAI,MAAM,CAAE,KAAyB;QACnC,IAAI,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAC7C,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,KAAK,CAAA;QAC/B,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,CAAA;YACnC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QAC1C,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,IAAI,CAAC,kBAAkB,CAAA;IAChC,CAAC;IAED;;;;;;;;;;;;OAYG;IACK,KAAK,CAAC,IAAI,CAAO,QAAqF,EAAE,GAAM,EAAE,IAAsB;QAC5I,MAAM,WAAW,GAAG,KAAK,EAAE,CAAC,OAAO,EAAE,GAAG,SAAS,CAAkB,EAAc,EAAE;YACjF,IAAI,CAAC;gBACH,OAAO,OAAO,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;YACrH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,MAAM,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAClC,CAAC;QACH,CAAC,CAAA;QACD,OAAO,MAAM,WAAW,CAAC,QAAQ,CAAC,CAAA;IACpC,CAAC;CACF;AAxWD,kCAwWC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@microsoft/agents-hosting",
-  "version": "0.5.1-g2e246ff274",
+  "version": "0.5.4-ga4d0401645",
   "homepage": "https://github.com/microsoft/Agents-for-js",
   "repository": {
     "type": "git",
@@ -20,7 +20,7 @@
   "types": "dist/src/index.d.ts",
   "dependencies": {
     "@azure/msal-node": "^3.5.3",
-    "@microsoft/agents-activity": "0.5.1-g2e246ff274",
+    "@microsoft/agents-activity": "0.5.4-ga4d0401645",
     "axios": "^1.9.0",
     "debug": "^4.3.7",
     "jsonwebtoken": "^9.0.2",

package/src/app/streaming/AIEntity.ts

@@ -0,0 +1,44 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { ClientCitation } from './clientCitation'
+import { SensitivityUsageInfo } from './sensitivityUsageInfo'
+
+export interface AIEntity {
+  /**
+     * Required as 'https://schema.org/Message'
+     */
+  type: 'https://schema.org/Message';
+
+  /**
+     * Required as 'Message
+     */
+  '@type': 'Message';
+
+  /**
+     * Required as 'https://schema.org
+     */
+  '@context': 'https://schema.org';
+
+  /**
+     * Must be left blank. This is for Bot Framework schema.
+     */
+  '@id': '';
+
+  /**
+     * Indicate that the content was generated by AI.
+     */
+  additionalType: ['AIGeneratedContent'];
+
+  /**
+     * Optional; if citations object is included, the  sent activity will include the citations, referenced in the activity text.
+     */
+  citation?: ClientCitation[];
+
+  /**
+     * Optional; if usage_info object is included, the sent activity will include the sensitivity usage information.
+     */
+  usageInfo?: SensitivityUsageInfo;
+}

package/src/app/streaming/actionCall.ts

@@ -0,0 +1,37 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * An action call to be requested by the LLM model. This type is a generic meant to be the equivalent of OpenAI's [`ChatCompletionMessageToolCall`](https://github.com/openai/openai-node/blob/master/src/resources/chat/completions.ts#L477), but is not tied to OpenAI's implementation in order to allow for flexibility for other models in the future.
+ */
+export interface ActionCall {
+  /**
+     * The ID of the tool call.
+     */
+  id: string;
+
+  /**
+     * The function that the model called.
+     */
+  function: {
+    /**
+         * The name of the function.
+         */
+    name: string;
+
+    /**
+         * The arguments to call the function with, as generated by the model in JSON
+         * format. Note that the model does not always generate valid JSON, and may
+         * hallucinate parameters not defined by your function schema. Validate the
+         * arguments in your code before calling your function.
+         */
+    arguments: string;
+  };
+
+  /**
+     * The type of the tool. Currently, only `function` is supported.
+     */
+  type: 'function';
+}