mirror of
https://github.com/MindWorkAI/AI-Studio.git
synced 2026-09-27 02:13:36 +00:00
35 lines
1.3 KiB
C#
35 lines
1.3 KiB
C#
namespace AIStudio.Provider;
|
|
|
|
/// <summary>
|
|
/// A contract for a streamed response line that may contain content and annotations.
|
|
/// </summary>
|
|
public interface IResponseStreamLine : IAnnotationStreamLine
|
|
{
|
|
/// <summary>
|
|
/// Checks if the response line contains any content.
|
|
/// </summary>
|
|
/// <returns>True when the response line contains content, false otherwise.</returns>
|
|
public bool ContainsContent();
|
|
|
|
/// <summary>
|
|
/// Gets the content of the response line.
|
|
/// </summary>
|
|
/// <returns>The content of the response line.</returns>
|
|
public ContentStreamChunk GetContent();
|
|
|
|
/// <summary>
|
|
/// Checks whether the response line states what the request cost.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Answered here for every wire format which says nothing about it, which is most of them: a
|
|
/// provider who reports no usage is the normal case, not a gap somebody has to fill in.
|
|
/// </remarks>
|
|
/// <returns>True when the response line carries a token usage, false otherwise.</returns>
|
|
public bool ContainsUsage() => false;
|
|
|
|
/// <summary>
|
|
/// Gets what the provider said the request cost.
|
|
/// </summary>
|
|
/// <returns>The usage, or TokenUsage.UNKNOWN when the line carries none.</returns>
|
|
public TokenUsage GetUsage() => TokenUsage.UNKNOWN;
|
|
} |