Merge pull request #265 from Avanade/feat/newcartridges

feat: creates GenIA interfaces

Author: lucianareginalino

src/Liquid.Core/AbstractMappers/LiquidMapper.cs

@@ -0,0 +1,50 @@
+using Liquid.Core.Exceptions;
+using Liquid.Core.Interfaces;
+using System;
+using System.Diagnostics.CodeAnalysis;
+using System.Threading.Tasks;
+
+namespace Liquid.Core.AbstractMappers
+{
+    ///<inheritdoc/>
+    [ExcludeFromCodeCoverage]
+    public abstract class LiquidMapper<TFrom, TTo> : ILiquidMapper<TFrom, TTo>
+    {
+        private readonly string _mapperName;
+
+        /// <summary>
+        /// Create a new instance of <see cref="LiquidMapper{TFrom, TTo}"/>
+        /// </summary>
+        /// <param name="mapperName">Mapper implementation name.</param>
+        protected LiquidMapper(string mapperName)
+        {
+            _mapperName = mapperName;
+        }
+        ///<inheritdoc/>
+        public async Task<TTo> Map(TFrom dataObject, string entityName = null)
+        {
+            if (dataObject is null)
+            {
+                throw new ArgumentNullException(nameof(dataObject));
+            }
+
+            try
+            {
+                return await MapImpl(dataObject, entityName);
+            }
+            catch (Exception e)
+            {
+                var msg = $"{_mapperName} throw data mapping error: '{e.Message}'";
+
+                throw new DataMappingException(msg, e);
+            }
+        }
+        /// <summary>
+        /// 
+        /// </summary>
+        /// <param name="dataObject"></param>
+        /// <param name="entityName"></param>
+        /// <returns></returns>
+        protected abstract Task<TTo> MapImpl(TFrom dataObject, string entityName = null);
+    }
+}

src/Liquid.Core/AbstractMappers/OcrResultMapper.cs

@@ -25,7 +25,7 @@ public OcrResultMapper(string mapperName)
             _mapperName = mapperName;
         }
         ///<inheritdoc/>
-        public async Task<OcrResult> Map(TFrom dataObject)
+        public async Task<OcrResult> Map(TFrom dataObject, string entityName = null)
         {
             if (dataObject is null)
             {

src/Liquid.Core/Entities/ChatMessages.cs

@@ -0,0 +1,33 @@
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+
+namespace Liquid.Core.Entities
+{
+    /// <summary>
+    /// Set de propriedades referentes à um item do BlobStorage.
+    /// </summary>
+    [ExcludeFromCodeCoverage]
+    public class LiquidBlob
+    {
+        /// <summary>
+        /// Lista de tags referentes ao blob.
+        /// </summary>
+        public IDictionary<string, string> Tags { get; set; } = new Dictionary<string, string>();
+
+        /// <summary>
+        /// Conteúdo do blob.
+        /// </summary>
+        public byte[] Blob { get; set; }
+
+        /// <summary>
+        /// Nome do arquivo no Storage.
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Caminho do blob.
+        /// </summary>
+        public string AbsoluteUri { get; set; }
+
+    }
+}

src/Liquid.Core/Entities/LiquidBlob.cs

@@ -1,21 +1,36 @@
 using System;
+using System.Diagnostics.CodeAnalysis;
 
 namespace Liquid.Core.Exceptions
 {
-    [Serializable]
-    internal class DataMappingException : LiquidException
+    /// <summary>
+    /// Occurs when an exception is raised during data mapping.
+    /// </summary>
+    [ExcludeFromCodeCoverage]
+    public class DataMappingException : Exception
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DataMappingException"/> class.
+        /// </summary>
         public DataMappingException()
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DataMappingException"/> class with a specified error message.
+        /// </summary>
+        /// <param name="message"></param>
         public DataMappingException(string message) : base(message)
         {
         }
 
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DataMappingException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
+        /// </summary>
+        /// <param name="message"></param>
+        /// <param name="innerException"></param>
         public DataMappingException(string message, Exception innerException) : base(message, innerException)
         {
         }
-
     }
-}
+}

src/Liquid.Core/Exceptions/DataMappingException.cs

@@ -0,0 +1,29 @@
+using Liquid.Core.GenAi.Enums;
+using System;
+using System.Diagnostics.CodeAnalysis;
+
+namespace Liquid.Core.GenAi.Entities
+{
+    /// <summary>
+    /// The content of the chat message.
+    /// </summary>
+    [ExcludeFromCodeCoverage]
+    public class LiquidChatContent
+    {
+        /// <summary>
+        /// The kind of content.
+        /// </summary>
+        public LiquidContentKind Kind { get; set; }
+
+        /// <summary>
+        /// The text content of the message.
+        /// </summary>
+        public string Text { get; set; }
+
+        /// <summary>
+        /// The image content url of the message.
+        /// </summary>
+        public Uri ImageUri { get; set; }
+
+    }
+}

src/Liquid.Core/GenAi/Entities/LiquidChatContent.cs

@@ -0,0 +1,21 @@
+using System.Diagnostics.CodeAnalysis;
+
+namespace Liquid.Core.GenAi.Entities
+{
+    /// <summary>
+    /// Context message associated with a chat completions request.
+    /// </summary>
+    [ExcludeFromCodeCoverage]
+    public class LiquidChatMessage
+    {
+        /// <summary>
+        /// The chat role associated with this message.
+        /// </summary>
+        public string Role { get; set; }
+
+        /// <summary>
+        /// The contents of the message.
+        /// </summary>
+        public LiquidChatContent[] Content { get; set; }
+    }
+}

src/Liquid.Core/GenAi/Entities/LiquidChatMessage.cs

@@ -0,0 +1,17 @@
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+
+namespace Liquid.Core.GenAi.Entities
+{
+    /// <summary>
+    /// The object of context messages associated with a chat completions request
+    /// </summary>
+    [ExcludeFromCodeCoverage]
+    public class LiquidChatMessages
+    {
+        /// <summary>
+        /// The collection of context messages associated with a chat completions request.
+        /// </summary>
+        public List<LiquidChatMessage> Messages { get; set; } = new List<LiquidChatMessage>();
+    }
+}

src/Liquid.Core/GenAi/Entities/LiquidChatMessages.cs

@@ -0,0 +1,23 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Liquid.Core.GenAi.Enums
+{
+    /// <summary>
+    /// Represents the possibles of underlying data for a chat message's <c>Content</c> property.
+    /// </summary>
+    public enum LiquidContentKind
+    {
+        /// <summary>
+        /// Text content
+        /// </summary>
+        Text,
+        /// <summary>
+        /// Image content
+        /// </summary>
+        Image
+    }
+}

src/Liquid.Core/GenAi/Enums/LiquidContentKind.cs

@@ -1,24 +1,25 @@
 using Liquid.Core.Entities;
+using Liquid.Core.GenAi.Entities;
+using Liquid.Core.GenAi.Settings;
 using Liquid.Core.Settings;
 using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
 
-namespace Liquid.Core.Interfaces
+namespace Liquid.Core.GenAi
 {
     /// <summary>
     /// This service is the hub of Liquid adapter custom completions for Generative AI.
     /// </summary>
-    public interface ILiquidChatCompletions
+    public interface ILiquidGenAi
     {
-
         /// <summary>
         /// Get chat completions for provided content and functions.
         /// </summary>
         /// <param name="messages">Context messages associated with chat completions request.</param>
         /// <param name="functions"> A list of functions the model may generate JSON inputs for.</param>
         /// <param name="settings">The options for chat completions request.</param>
-        Task<ChatCompletionResult> FunctionCalling(ChatMessages messages, List<FunctionBody> functions, CompletionsSettings settings);
+        Task<ChatCompletionResult> FunctionCalling(LiquidChatMessages messages, List<FunctionBody> functions, CompletionsOptions settings);
 
         /// <summary>
         /// Get chat completions for provided chat context messages.
@@ -31,15 +32,15 @@ public interface ILiquidChatCompletions
         /// Typical usage begins with a chat message for the System role that provides instructions for
         /// the behavior of the assistant, followed by alternating messages between the User and
         /// Assistant roles.</param>
-        Task<ChatCompletionResult> ChatCompletions(string content, string prompt, CompletionsSettings settings, ChatMessages? chatHistory = null);
+        Task<ChatCompletionResult> CompleteChatAsync(string content, string prompt, CompletionsOptions settings, LiquidChatMessages chatHistory = null);
 
         /// <summary>
-        /// Return the computed embeddings for a given prompt.
+        /// Get chat completions for provided chat context messages and functions.
         /// </summary>
-        /// <param name="description">Input texts to get embeddings for, encoded as a an array of strings.</param>
-        /// <param name="modelName"></param>
-        /// <param name="clientId">Client connection alias to use for a chat completions request.
-        /// This connection must be configured in application previously <see cref="GenAiSettings"/></param>
-        Task<ReadOnlyMemory<float>> GetEmbeddings(string description, string modelName, string clientId);
+        /// <param name="messages">Messages associated with chat completions request.</param>
+        /// <param name="functions"> A list of functions the model may generate JSON inputs for.</param>
+        /// <param name="chatHistory"> The collection of context messages associated with this chat completions request. </param>
+        /// <param name="settings">The options for chat completions request.</param>
+        Task<ChatCompletionResult> CompleteChatAsync(LiquidChatMessages messages, CompletionsOptions settings, List<FunctionBody> functions = null, LiquidChatMessages chatHistory = null);
     }
 }