AI-Studio/app/MindWork AI Studio/Provider/OpenAI/ChatCompletionAPIRequest.cs

using System.Text.Json.Serialization;

namespace AIStudio.Provider.OpenAI;

/// <summary>
/// The OpenAI's legacy chat completion request model.
/// </summary>
/// <param name="Model">Which model to use for chat completion.</param>
/// <param name="Messages">The chat messages.</param>
/// <param name="Stream">Whether to stream the chat completion.</param>
public record ChatCompletionAPIRequest(
    string Model,
    IList<IMessageBase> Messages,
    bool Stream
)
{
    public ChatCompletionAPIRequest() : this(string.Empty, [], true)
    {
    }

    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
    public IList<object>? Tools { get; init; }

    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
    public bool? ParallelToolCalls { get; init; }

    /// <summary>
    /// Asks a streamed request to end with what it cost.
    /// </summary>
    /// <remarks>
    /// Derived rather than set, so that every provider which builds one of these asks for it
    /// without having to know that it exists. A request which is not streamed carries no such
    /// line, and then the block would only be a field the provider has to ignore.
    /// </remarks>
    [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
    public ChatCompletionStreamOptions? StreamOptions => this.Stream ? ChatCompletionStreamOptions.INCLUDE_USAGE : null;
    
    // Attention: The "required" modifier is not supported for [JsonExtensionData].
    [JsonExtensionData]
    public IDictionary<string, object> AdditionalApiParameters { get; init; } = new Dictionary<string, object>();
}