LLamaSharp/LLama/LLamaTransforms.cs

using LLama.Abstractions;
using LLama.Common;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Text.Json.Serialization;

namespace LLama
{
    /// <summary>
    /// A class that contains all the transforms provided internally by LLama.
    /// </summary>
    public class LLamaTransforms
    {
        /// <summary>
        /// The default history transform.
        /// Uses plain text with the following format:
        /// [Author]: [Message]
        /// </summary>
        public class DefaultHistoryTransform : IHistoryTransform
        {
            private const string defaultUserName = "User";
            private const string defaultAssistantName = "Assistant";
            private const string defaultSystemName = "System";
            private const string defaultUnknownName = "??";

            private readonly string _userName;
            private readonly string _assistantName;
            private readonly string _systemName;
            private readonly string _unknownName;
            private readonly bool _isInstructMode;

            public string UserName => _userName;
            public string AssistantName => _assistantName;
            public string SystemName => _systemName;
            public string UnknownName => _unknownName;
            public bool IsInstructMode => _isInstructMode;

            /// <summary>
            /// 
            /// </summary>
            /// <param name="userName"></param>
            /// <param name="assistantName"></param>
            /// <param name="systemName"></param>
            /// <param name="unknownName"></param>
            /// <param name="isInstructMode"></param>
            public DefaultHistoryTransform(string? userName = null, string? assistantName = null, 
                string? systemName = null, string? unknownName = null, bool isInstructMode = false)
            {
                _userName = userName ?? defaultUserName;
                _assistantName = assistantName ?? defaultAssistantName;
                _systemName = systemName ?? defaultSystemName;
                _unknownName = unknownName ?? defaultUnknownName;
                _isInstructMode = isInstructMode;
            }

            /// <inheritdoc />
            public IHistoryTransform Clone()
            {
                return new DefaultHistoryTransform(_userName, _assistantName, _systemName, _unknownName, _isInstructMode);
            }

            /// <inheritdoc />
            public virtual string HistoryToText(ChatHistory history)
            {
                StringBuilder sb = new();
                foreach (var message in history.Messages)
                {
                    if (message.AuthorRole == AuthorRole.User)
                    {
                        sb.AppendLine($"{_userName}: {message.Content}");
                    }
                    else if (message.AuthorRole == AuthorRole.System)
                    {
                        sb.AppendLine($"{_systemName}: {message.Content}");
                    }
                    else if (message.AuthorRole == AuthorRole.Unknown)
                    {
                        sb.AppendLine($"{_unknownName}: {message.Content}");
                    }
                    else if (message.AuthorRole == AuthorRole.Assistant)
                    {
                        sb.AppendLine($"{_assistantName}: {message.Content}");
                    }
                }
                return sb.ToString();
            }

            /// <inheritdoc />
            public virtual ChatHistory TextToHistory(AuthorRole role, string text)
            {
                ChatHistory history = new ChatHistory();
                history.AddMessage(role, TrimNamesFromText(text, role));
                return history;
            }

            /// <summary>
            /// Drop the name at the beginning and the end of the text.
            /// </summary>
            /// <param name="text"></param>
            /// <param name="role"></param>
            /// <returns></returns>
            public virtual string TrimNamesFromText(string text, AuthorRole role)
            {
                if (role == AuthorRole.User && text.StartsWith($"{_userName}:"))
                {
                    text = text.Substring($"{_userName}:".Length).TrimStart();
                }
                else if (role == AuthorRole.Assistant && text.EndsWith($"{_assistantName}:"))
                {
                    text = text.Substring(0, text.Length - $"{_assistantName}:".Length).TrimEnd();
                }
                if (_isInstructMode && role == AuthorRole.Assistant && text.EndsWith("\n> "))
                {
                    text = text.Substring(0, text.Length - "\n> ".Length).TrimEnd();
                }
                return text;
            }
        }

        /// <summary>
        /// A text input transform that only trims the text.
        /// </summary>
        public class NaiveTextInputTransform
            : ITextTransform
        {
            /// <inheritdoc />
            public string Transform(string text)
            {
                return text.Trim();
            }

            /// <inheritdoc />
            public ITextTransform Clone()
            {
                return new NaiveTextInputTransform();
            }
        }

        /// <summary>
        /// A no-op text input transform.
        /// </summary>
        public class EmptyTextOutputStreamTransform
            : ITextStreamTransform
        {
            /// <inheritdoc />
            public IAsyncEnumerable<string> TransformAsync(IAsyncEnumerable<string> tokens)
            {
                return tokens;
            }

            /// <inheritdoc />
            public ITextStreamTransform Clone()
            {
                return new EmptyTextOutputStreamTransform();
            }
        }

        /// <summary>
        /// A text output transform that removes the keywords from the response.
        /// </summary>
        public class KeywordTextOutputStreamTransform : ITextStreamTransform
        {
            private readonly HashSet<string> _keywords;
            private readonly int _maxKeywordLength;
            private readonly bool _removeAllMatchedTokens;

            /// <summary>
            /// Keywords that you want to remove from the response.
            /// This property is used for JSON serialization.
            /// </summary>
            [JsonPropertyName("keywords")]
            public HashSet<string> Keywords => _keywords;

            /// <summary>
            /// Maximum length of the keywords.
            /// This property is used for JSON serialization.
            /// </summary>
            [JsonPropertyName("maxKeywordLength")]
            public int MaxKeywordLength => _maxKeywordLength;

            /// <summary>
            /// If set to true, when getting a matched keyword, all the related tokens will be removed. 
            /// Otherwise only the part of keyword will be removed.
            /// This property is used for JSON serialization.
            /// </summary>
            [JsonPropertyName("removeAllMatchedTokens")]
            public bool RemoveAllMatchedTokens => _removeAllMatchedTokens;

            /// <summary>
            /// JSON constructor.
            /// </summary>
            [JsonConstructor]
            public KeywordTextOutputStreamTransform(
                HashSet<string> keywords,
                int maxKeywordLength,
                bool removeAllMatchedTokens)
            {
                _keywords = new(keywords);
                _maxKeywordLength = maxKeywordLength;
                _removeAllMatchedTokens = removeAllMatchedTokens;
            }

            /// <summary>
            /// 
            /// </summary>
            /// <param name="keywords">Keywords that you want to remove from the response.</param>
            /// <param name="redundancyLength">The extra length when searching for the keyword. For example, if your only keyword is "highlight", 
            /// maybe the token you get is "\r\nhighligt". In this condition, if redundancyLength=0, the token cannot be successfully matched because the length of "\r\nhighligt" (10)
            /// has already exceeded the maximum length of the keywords (8). On the contrary, setting redundancyLengyh &gt;= 2 leads to successful match.
            /// The larger the redundancyLength is, the lower the processing speed. But as an experience, it won't introduce too much performance impact when redundancyLength &lt;= 5 </param>
            /// <param name="removeAllMatchedTokens">If set to true, when getting a matched keyword, all the related tokens will be removed. Otherwise only the part of keyword will be removed.</param>
            public KeywordTextOutputStreamTransform(IEnumerable<string> keywords, int redundancyLength = 3, bool removeAllMatchedTokens = false)
            {
                _keywords = new(keywords);
                _maxKeywordLength = _keywords.Max(x => x.Length) + redundancyLength;
                _maxKeywordLength = _keywords.Select(x => x.Length).Max() + redundancyLength;
                _removeAllMatchedTokens = removeAllMatchedTokens;
            }

            /// <inheritdoc />
            public ITextStreamTransform Clone()
            {
                return new KeywordTextOutputStreamTransform(_keywords, _maxKeywordLength, _removeAllMatchedTokens);
            }

            /// <inheritdoc />
            public async IAsyncEnumerable<string> TransformAsync(IAsyncEnumerable<string> tokens)
            {
                var window = new Queue<string>();

                await foreach (var s in tokens)
                {
                    window.Enqueue(s);
                    var current = string.Join("", window);
                    if (_keywords.Any(x => current.Contains(x)))
                    {
                        var matchedKeywords = _keywords.Where(x => current.Contains(x));
                        int total = window.Count;
                        for (int i = 0; i < total; i++)
                        {
                            window.Dequeue();
                        }
                        if (!_removeAllMatchedTokens)
                        {
                            foreach(var keyword in matchedKeywords)
                            {
                                current = current.Replace(keyword, "");
                            }
                            yield return current;
                        }
                    }
                    if (current.Length >= _maxKeywordLength)
                    {
                        int total = window.Count;
                        for (int i = 0; i < total; i++)
                        {
                            yield return window.Dequeue();
                        }
                    }
                }
                int totalCount = window.Count;
                for (int i = 0; i < totalCount; i++)
                {
                    yield return window.Dequeue();
                }
            }
        }
    }
}