AI-Studio/app/MindWork AI Studio/Chat/IContent.cs

using System.Text.Json.Serialization;

using AIStudio.Provider;

namespace AIStudio.Chat;

/// <summary>
/// The interface for any content in the chat.
/// </summary>
[JsonDerivedType(typeof(ContentText), typeDiscriminator: "text")]
[JsonDerivedType(typeof(ContentImage), typeDiscriminator: "image")]
public interface IContent
{
    /// <summary>
    /// Do we need to wait for the remote, i.e., the AI, to process the related request?
    /// Does not indicate that the stream is finished; it only indicates that we are
    /// waiting for the first response, i.e., wait for the remote to pick up the request.
    /// </summary>
    [JsonIgnore]
    public bool InitialRemoteWait { get; set; }

    /// <summary>
    /// Indicates whether the content is streaming right now. False, if the content is
    /// either static or the stream has finished.
    /// </summary>
    [JsonIgnore]
    public bool IsStreaming { get; set; }

    /// <summary>
    /// An action that is called when the content was changed during streaming.
    /// </summary>
    [JsonIgnore]
    public Func<Task> StreamingEvent { get; set; }

    /// <summary>
    /// An action that is called when the streaming is done.
    /// </summary>
    [JsonIgnore]
    public Func<Task> StreamingDone { get; set; }

    /// <summary>
    /// The provided sources, if any.
    /// </summary>
    /// <remarks>
    /// We cannot use ISource here because System.Text.Json does not support
    /// interface serialization. So we have to use a concrete class.
    /// </remarks>
    [JsonIgnore]
    public List<Source> Sources { get; set; }

    /// <summary>
    /// Represents a collection of file attachments associated with the content.
    /// This property contains a list of file attachments that are appended
    /// to the content to provide additional context or resources.
    /// </summary>
    public List<FileAttachment> FileAttachments { get; set; }
    
    /// <summary>
    /// Uses the provider to create the content.
    /// </summary>
    public Task<ChatThread> CreateFromProviderAsync(IProvider provider, Model chatModel, IContent? lastUserPrompt, ChatThread? chatChatThread, CancellationToken token = default);

    /// <summary>
    /// Creates a deep copy
    /// </summary>
    /// <returns>The copy</returns>
    public IContent DeepClone();
    
    /// <summary>
    /// Returns the corresponding ERI content type.
    /// </summary>
    public Tools.ERIClient.DataModel.ContentType ToERIContentType => this switch
    {
        ContentText => Tools.ERIClient.DataModel.ContentType.TEXT,
        ContentImage => Tools.ERIClient.DataModel.ContentType.IMAGE,
        
        _ => Tools.ERIClient.DataModel.ContentType.UNKNOWN,
    };
}