@microsoft/agents-hosting 0.4.3 → 0.5.4-ga4d0401645

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

@@ -0,0 +1,106 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ActionCall } from './actionCall';
+/**
+ * A message object sent to or received from an LLM.
+ * @param TContent Optional. Type of the message content. Defaults to `string`
+ */
+export interface Message<TContent = string> {
+    /**
+       * The messages role. Typically 'system', 'user', 'assistant', 'tool', 'function'.
+       */
+    role: string;
+    /**
+       * Text of the message.
+       */
+    content: TContent | undefined;
+    /**
+       * Optional. A named function to call.
+       */
+    function_call?: FunctionCall;
+    /**
+       * The context used for the message.
+       */
+    context?: MessageContext;
+    /**
+       * Optional. Name of the function that was called.
+       */
+    name?: string;
+    /**
+       * Optional. The action or tool to be called by the model when using 'tools' augmentation. In OpenAI, this is the tool_calls property returned from the model.
+       */
+    action_calls?: ActionCall[];
+    /**
+       * Optional. The id of the action called.
+       */
+    action_call_id?: string | undefined;
+}
+/**
+ * A named function to call.
+ */
+export interface FunctionCall {
+    /**
+       * Name of the function to call.
+       */
+    name?: string;
+    /**
+       * Optional. Arguments to pass to the function. Must be deserialized.
+       */
+    arguments?: string;
+}
+export type MessageContentParts = TextContentPart | ImageContentPart;
+export interface TextContentPart {
+    /**
+       * Type of the message content. Should always be 'text'.
+       */
+    type: 'text';
+    /**
+       * The text of the message.
+       */
+    text: string;
+}
+export interface ImageContentPart {
+    /**
+       * Type of the message content. Should always be 'image_url'.
+       */
+    type: 'image_url';
+    /**
+       * The URL of the image.
+       */
+    image_url: string | {
+        url: string;
+    };
+}
+/**
+ * Citations returned by the model.
+ */
+export interface Citation {
+    /**
+       * The content of the citation.
+       */
+    content: string;
+    /**
+       * The title of the citation.
+       */
+    title: string | null;
+    /**
+       * The URL of the citation.
+       */
+    url: string | null;
+    /**
+       * The filepath of the document.
+       */
+    filepath: string | null;
+}
+export interface MessageContext {
+    /**
+       * Citations used in the message.
+       */
+    citations: Citation[];
+    /**
+       * The intent of the message (what the user wrote).
+       */
+    intent: string;
+}

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

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=message.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"message.js","sourceRoot":"","sources":["../../../../src/app/streaming/message.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

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

@@ -0,0 +1,40 @@
+/**
+ * Sensitivity usage info for content sent to the user. This is used to provide information about the content to the user. See ClientCitation for more information.
+ */
+export interface SensitivityUsageInfo {
+    /**
+       * Must be "https://schema.org/Message"
+       */
+    type: 'https://schema.org/Message';
+    /**
+       * Required; Set to CreativeWork;
+       */
+    '@type': 'CreativeWork';
+    /**
+       * Sensitivity description of the content
+       */
+    description?: string;
+    /**
+       * Sensitivity title of the content
+       */
+    name: string;
+    /**
+       * Optional; ignored in Teams.
+       */
+    position?: number;
+    pattern?: {
+        /**
+             * Set to DefinedTerm
+             */
+        '@type': 'DefinedTerm';
+        inDefinedTermSet: string;
+        /**
+             * Color
+             */
+        name: string;
+        /**
+             * e.g. #454545
+             */
+        termCode: string;
+    };
+}

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

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=sensitivityUsageInfo.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sensitivityUsageInfo.js","sourceRoot":"","sources":["../../../../src/app/streaming/sensitivityUsageInfo.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,141 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Attachment } from '@microsoft/agents-activity';
+import { TurnContext } from '../../turnContext';
+import { ClientCitation } from './clientCitation';
+import { SensitivityUsageInfo } from './sensitivityUsageInfo';
+import { Citation } from './message';
+/**
+ * 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.
+ */
+export declare class StreamingResponse {
+    private readonly _context;
+    private _nextSequence;
+    private _streamId?;
+    private _message;
+    private _attachments?;
+    private _ended;
+    private _queue;
+    private _queueSync;
+    private _chunkQueued;
+    private _enableFeedbackLoop;
+    private _feedbackLoopType?;
+    private _enableGeneratedByAILabel;
+    private _citations?;
+    private _sensitivityLabel?;
+    /**
+       * 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: TurnContext);
+    /**
+       * 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(): string | undefined;
+    /**
+       * Gets the citations of the current response.
+       */
+    get citations(): ClientCitation[] | undefined;
+    /**
+       * Gets the number of updates sent for the stream.
+       * @returns {number} - The number of updates sent for the stream.
+       */
+    get updatesSent(): number;
+    /**
+       * Queues an informative update to be sent to the client.
+       * @param {string} text Text of the update to send.
+       */
+    queueInformativeUpdate(text: string): void;
+    /**
+       * 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: string, citations?: Citation[]): void;
+    /**
+       * Ends the stream by sending the final message to the client.
+       * @returns {Promise<void>} - A promise representing the async operation
+       */
+    endStream(): Promise<void>;
+    /**
+       * Sets the attachments to attach to the final chunk.
+       * @param attachments List of attachments.
+       */
+    setAttachments(attachments: Attachment[]): void;
+    /**
+       * Sets the sensitivity label to attach to the final chunk.
+       * @param sensitivityLabel The sensitivty label.
+       */
+    setSensitivityLabel(sensitivityLabel: SensitivityUsageInfo): void;
+    /**
+       * Sets the citations for the full message.
+       * @param {Citation[]} citations Citations to be included in the message.
+       */
+    setCitations(citations: Citation[]): void;
+    /**
+       * 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: boolean): void;
+    /**
+       * Sets the type of UI to use for the feedback loop.
+       * @param feedbackLoopType The type of the feedback loop.
+       */
+    setFeedbackLoopType(feedbackLoopType: 'default' | 'custom'): void;
+    /**
+       * Sets the the Generated by AI label in Teams
+       * Default is `false`.
+       * @param enableGeneratedByAILabel If true, the label is added.
+       */
+    setGeneratedByAILabel(enableGeneratedByAILabel: boolean): void;
+    /**
+       * Returns the most recently streamed message.
+       * @returns The streamed message.
+       */
+    getMessage(): string;
+    /**
+       * Waits for the outgoing activity queue to be empty.
+       * @returns {Promise<void>} - A promise representing the async operation.
+       */
+    waitForQueue(): Promise<void>;
+    /**
+       * Queues the next chunk of text to be sent to the client.
+       * @private
+       */
+    private queueNextChunk;
+    /**
+       * Queues an activity to be sent to the client.
+       */
+    private queueActivity;
+    /**
+       * 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
+       */
+    private drainQueue;
+    /**
+       * 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
+       */
+    private sendActivity;
+}

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;
+}