AI-Studio/app/MindWork AI Studio/Provider/Fireworks/ResponseStreamLine.cs

using AIStudio.Provider.OpenAI;

namespace AIStudio.Provider.Fireworks;

/// <summary>
/// Data model for a line in the response stream, for streaming completions.
/// </summary>
/// <param name="Id">The id of the response.</param>
/// <param name="Object">The object describing the response.</param>
/// <param name="Created">The timestamp of the response.</param>
/// <param name="Model">The model used for the response.</param>
/// <param name="Choices">The choices made by the AI.</param>
public readonly record struct ResponseStreamLine(string Id, string Object, uint Created, string Model, IList<Choice> Choices) : IResponseStreamLine
{
    /// <inheritdoc />
    public bool ContainsContent() => this != default && this.Choices.Count > 0;

    /// <inheritdoc />
    public ContentStreamChunk GetContent() => new(this.Choices[0].Delta.Content, []);

    /// <summary>
    /// What Fireworks says the request cost, on the one line which carries it.
    /// </summary>
    /// <remarks>
    /// The same block the OpenAI chat completion API sends, because this is that wire format.
    /// Not a positional parameter: the struct is built from JSON, and a further parameter would
    /// only be a value nobody passes.
    /// </remarks>
    public ChatCompletionUsage? Usage { get; init; }

    /// <inheritdoc />
    public TokenUsage GetUsage() => this.Usage?.ToTokenUsage() ?? TokenUsage.UNKNOWN;

    #region Implementation of IAnnotationStreamLine

    //
    // Currently, Fireworks does not provide source citations in their response stream.
    //
    
    /// <inheritdoc />
    public bool ContainsSources() => false;

    /// <inheritdoc />
    public IList<ISource> GetSources() => [];

    #endregion
}