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

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

@@ -0,0 +1,36 @@
+/**
+ * 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/dist/src/app/streaming/AIEntity.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=AIEntity.js.map

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

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

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

@@ -0,0 +1,33 @@
+/**
+ * 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';
+}

package/dist/src/app/streaming/actionCall.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=actionCall.js.map

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

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

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

@@ -0,0 +1,68 @@
+/**
+ * @module teams-ai
+ */
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { SensitivityUsageInfo } from './sensitivityUsageInfo';
+export type ClientCitationIconName = 'Microsoft Word' | 'Microsoft Excel' | 'Microsoft PowerPoint' | 'Microsoft OneNote' | 'Microsoft SharePoint' | 'Microsoft Visio' | 'Microsoft Loop' | 'Microsoft Whiteboard' | 'Adobe Illustrator' | 'Adobe Photoshop' | 'Adobe InDesign' | 'Adobe Flash' | 'Sketch' | 'Source Code' | 'Image' | 'GIF' | 'Video' | 'Sound' | 'ZIP' | 'Text' | 'PDF';
+/**
+ * Represents a Teams client citation to be included in a message. See Bot messages with AI-generated content for more details.
+ * https://learn.microsoft.com/en-us/microsoftteams/platform/bots/how-to/bot-messages-ai-generated-content?tabs=before%2Cbotmessage
+ */
+export interface ClientCitation {
+    /**
+       * Required; must be "Claim"
+       */
+    '@type': 'Claim';
+    /**
+       * Required. Number and position of the citation.
+       */
+    position: number;
+    appearance: {
+        /**
+             * Required; Must be 'DigitalDocument'
+             */
+        '@type': 'DigitalDocument';
+        /**
+             * Name of the document. (max length 80)
+             */
+        name: string;
+        /**
+             * Stringified adaptive card with additional information about the citation.
+             * It is rendered within the modal.
+             */
+        text?: string;
+        /**
+             * URL of the document. This will make the name of the citation clickable and direct the user to the specified URL.
+             */
+        url?: string;
+        /**
+             * Extract of the referenced content. (max length 160)
+             */
+        abstract: string;
+        /**
+             * Encoding format of the `citation.appearance.text` field.
+             */
+        encodingFormat?: 'application/vnd.microsoft.card.adaptive';
+        /**
+             * Information about the citation’s icon.
+             */
+        image?: {
+            '@type': 'ImageObject';
+            /**
+                   * The image/icon name
+                   */
+            name: ClientCitationIconName;
+        };
+        /**
+             * Optional; set by developer. (max length 3) (max keyword length 28)
+             */
+        keywords?: string[];
+        /**
+             * Optional sensitivity content information.
+             */
+        usageInfo?: SensitivityUsageInfo;
+    };
+}

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

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

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

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

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