@microsoft/teams-ai/lib/Utilities.js

SDK focused on building AI based applications for Microsoft Teams.

"use strict";
/**
 * @module teams-ai
 */
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */
Object.defineProperty(exports, "__esModule", { value: true });
exports.Utilities = void 0;
const yaml_1 = require("yaml");
/**
 * 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.
     */
    static toString(tokenizer, value, asJSON = false) {
        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 = (0, yaml_1.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) => {
            citations.find((citation) => {
                `[${citation.position}]` === match && usedCitations.push(citation);
            });
        });
        return usedCitations;
    }
}
exports.Utilities = Utilities;
//# sourceMappingURL=Utilities.js.map