Added the exact token count for the OpenAI Responses API

This commit is contained in:
Thorsten Sommer committed 2026-09-24 13:07:04 +02:00
1 parent 4becb98ee2
commit 4990bc116c
10 files changed
+363 -12

No files matched your search

@@ -1157,17 +1157,44 @@ public abstract class BaseProvider : IProvider, ISecretId
// Check if annotations are supported:
var annotationSupported = typeof(TAnnotation) != typeof(NoResponsesAnnotationStreamLine) && typeof(TAnnotation) != typeof(NoChatCompletionAnnotationStreamLine);
var isCompleted = false;
await foreach (var serverSentEvent in this.ReadServerSentEventsAsync(providerName, "responses call", requestBuilder, token))
{
// Check if the line is the end of the stream. This one is read off the raw line
// rather than off a payload, because it has none:
// Check if the line announces the end of the stream. This one is read off the raw
// line rather than off a payload, because it has none:
if (serverSentEvent.Line.StartsWith("event: response.completed", StringComparison.InvariantCulture))
yield break;
{
isCompleted = true;
continue;
}
// Skip lines without a payload:
if (serverSentEvent.Data.Length is 0)
continue;
//
// The payload after the announcement is the whole response, and the only line which
// states what the request cost. The stream ends here whether that can be read or not,
// which keeps the end independent of how a gateway orders the fields of the payload.
//
if (isCompleted)
{
var usage = TokenUsage.UNKNOWN;
try
{
usage = JsonSerializer.Deserialize<ResponsesCompletedStreamLine>(serverSentEvent.Data, JSON_SERIALIZER_OPTIONS)?.GetUsage() ?? TokenUsage.UNKNOWN;
}
catch
{
// Invalid JSON data states nothing, and the answer is complete either way.
}
if (usage.IsKnown)
yield return new(string.Empty, [], Usage: usage);
yield break;
}
//
// Find delta lines:
//
@@ -10,4 +10,15 @@ namespace AIStudio.Provider.OpenAI;
/// </remarks>
/// <param name="Type">The type of the stream event.</param>
/// <param name="Response">The response as a non-streamed call would have returned it.</param>
public sealed record ResponsesCompletedStreamLine(string Type, ResponsesResponse? Response);
public sealed record ResponsesCompletedStreamLine(string Type, ResponsesResponse? Response)
{
/// <summary>
/// States what the request of this call carried, as far as it can be believed.
/// </summary>
/// <remarks>
/// The one way from the wire to a usage, shared by the plain text path and the tool calling
/// path, so that what counts as believable is decided in a single place.
/// </remarks>
/// <returns>The usage, or TokenUsage.UNKNOWN when the line states nothing usable.</returns>
public TokenUsage GetUsage() => this.Response?.GetUsage() ?? TokenUsage.UNKNOWN;
}
@@ -7,6 +7,16 @@ namespace AIStudio.Provider.OpenAI;
/// </summary>
public sealed record ResponsesResponse
{
/// <summary>
/// The output items after which the usage still describes the request as it was sent.
/// </summary>
/// <remarks>
/// A list of the items which are known to leave the input alone, rather than one of those which
/// do not: a hosted tool OpenAI adds later would otherwise inflate the number without anybody
/// noticing.
/// </remarks>
private static readonly HashSet<string> OUTPUT_ITEMS_LEAVING_THE_INPUT_ALONE = ["message", "reasoning", "function_call"];
public string Id { get; init; } = string.Empty;
public string Model { get; init; } = string.Empty;
@@ -15,6 +25,30 @@ public sealed record ResponsesResponse
public IList<JsonElement> Output { get; init; } = [];
/// <summary>
/// What OpenAI says the response cost. Only the completed response carries it.
/// </summary>
public ResponsesUsage? Usage { get; init; }
/// <summary>
/// States what the request of this response carried, as far as it can be believed.
/// </summary>
/// <remarks>
/// Only for a response which ran no hosted tool. When OpenAI runs one, such as its web search,
/// what the tool found is charged as input tokens of the same response, cf. the pricing read on
/// 2026-09-24 at https://developers.openai.com/api/docs/pricing. No later request carries what
/// the tool found, so the number would describe a conversation larger than the one there is --
/// the same reason why the tool calling loop keeps only the usage of its first round.
///
/// A response put back together from its items, for a gateway which never sent the completed
/// event, has no usage. Nor is one read off a response which ended as incomplete, because it
/// ran out of output tokens: that is rare enough for the estimate to cover it.
/// </remarks>
/// <returns>The usage, or TokenUsage.UNKNOWN when the response states nothing usable.</returns>
public TokenUsage GetUsage() => this.Output.All(x => OUTPUT_ITEMS_LEAVING_THE_INPUT_ALONE.Contains(ReadString(x, "type")))
? this.Usage?.ToTokenUsage() ?? TokenUsage.UNKNOWN
: TokenUsage.UNKNOWN;
public IReadOnlyList<ResponsesFunctionCallItem> GetFunctionCalls() => this.Output
.Where(x => ReadString(x, "type").Equals("function_call", StringComparison.Ordinal))
.Select(x => new ResponsesFunctionCallItem
@@ -27,7 +27,7 @@ public sealed class ResponsesStreamAccumulator
/// Takes the next event of the stream and returns what it has to show.
/// </summary>
/// <param name="serverSentEvent">The event to read.</param>
/// <returns>The text and sources of this event, both empty when it carried neither.</returns>
/// <returns>The text and sources of this event, both empty when it carried neither, and the usage of the completed event.</returns>
public ResponsesStreamPart Process(ServerSentEvent serverSentEvent)
{
if (serverSentEvent.Data.Length is 0)
@@ -61,8 +61,15 @@ public sealed class ResponsesStreamAccumulator
switch (eventType)
{
case EVENT_COMPLETED:
this.completedResponse = TryDeserialize<ResponsesCompletedStreamLine>(serverSentEvent.Data)?.Response ?? this.completedResponse;
return ResponsesStreamPart.Nothing;
var completedLine = TryDeserialize<ResponsesCompletedStreamLine>(serverSentEvent.Data);
this.completedResponse = completedLine?.Response ?? this.completedResponse;
//
// What the request carried, read the same way as on the plain text path and with
// the same exception, a response which ran a hosted tool, cf. ResponsesResponse.
//
var usage = completedLine?.GetUsage() ?? TokenUsage.UNKNOWN;
return usage.IsKnown ? new ResponsesStreamPart(string.Empty, [], usage) : ResponsesStreamPart.Nothing;
case EVENT_TEXT_DELTA:
var deltaLine = TryDeserialize<ResponsesDeltaStreamLine>(serverSentEvent.Data);
@@ -5,15 +5,20 @@ namespace AIStudio.Provider.OpenAI;
/// </summary>
/// <param name="TextDelta">The text this line carried, empty when it carried none.</param>
/// <param name="Sources">The sources this line announced, empty when it announced none.</param>
public readonly record struct ResponsesStreamPart(string TextDelta, IList<ISource> Sources)
/// <param name="Usage">What the provider said the request cost, unknown on every line but the completed event.</param>
public readonly record struct ResponsesStreamPart(string TextDelta, IList<ISource> Sources, TokenUsage Usage = default)
{
/// <summary>
/// The part of a line which says nothing to the user, such as a bookkeeping event.
/// </summary>
public static ResponsesStreamPart Nothing => new(string.Empty, []);
/// <summary>
/// Whether this part has anything to show at all.
/// </summary>
/// <remarks>
/// The usage is not part of that: it is nothing to show, and whether it reaches the answer at
/// all is the tool calling loop's decision, which knows which round this is.
/// </remarks>
public bool HasContent => this.TextDelta.Length > 0 || this.Sources.Count > 0;
}
@@ -59,14 +59,16 @@ public sealed class ResponsesToolCallingAdapter(Model chatModel, IList<object> b
//
// The text goes out while it is being written, the round only once the stream closed it.
// Sources travel with the text because the API announces them as it cites them.
// Sources travel with the text because the API announces them as it cites them. The usage
// goes out with every round: which of them describes the conversation is the loop's
// decision, which knows which round this is.
//
var accumulator = new ResponsesStreamAccumulator();
await foreach (var serverSentEvent in streamRequestAsync(request, token))
{
var part = accumulator.Process(serverSentEvent);
if (part.HasContent)
yield return ToolCallingStreamEvent.TextDelta(new ContentStreamChunk(part.TextDelta, part.Sources));
if (part.HasContent || part.Usage.IsKnown)
yield return ToolCallingStreamEvent.TextDelta(new ContentStreamChunk(part.TextDelta, part.Sources, Usage: part.Usage));
}
var response = accumulator.Build();
@@ -0,0 +1,31 @@
// ReSharper disable ClassNeverInstantiated.Global
namespace AIStudio.Provider.OpenAI;
/// <summary>
/// What OpenAI reports a Responses API call cost, as it closes the stream.
/// </summary>
/// <remarks>
/// The input tokens are the whole request. What the API took from its cache is a share of them,
/// not an addition to them, which is why that detail stays unread. Read on 2026-09-24 at
/// https://developers.openai.com/api/docs/guides/prompt-caching.
///
/// The block states more than this, the output and its reasoning share among it. Those are left
/// unread on purpose, for the reason given at TokenUsage: no later request carries them.
/// </remarks>
public sealed record ResponsesUsage
{
/// <summary>
/// What everything sent to the model cost, the cached part included.
/// </summary>
public int? InputTokens { get; init; }
/// <summary>
/// States what this block reports, as far as it can be believed.
/// </summary>
/// <remarks>
/// Whether the block describes the request at all is not decided here but by the response
/// around it, cf. ResponsesResponse.
/// </remarks>
/// <returns>The usage, or TokenUsage.UNKNOWN when the block states nothing usable.</returns>
public TokenUsage ToTokenUsage() => TokenUsage.OfReported(this.InputTokens);
}