|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Text;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Shared.Diagnostics;
using OpenAI.Responses;
#pragma warning disable S907 // "goto" statement should not be used
#pragma warning disable S1067 // Expressions should not be too complex
#pragma warning disable S3011 // Reflection should not be used to increase accessibility of classes, methods, or fields
#pragma warning disable S3604 // Member initializer values should not be redundant
#pragma warning disable SA1202 // Elements should be ordered by access
#pragma warning disable SA1204 // Static elements should appear before instance elements
namespace Microsoft.Extensions.AI;
/// <summary>Represents an <see cref="IChatClient"/> for an <see cref="OpenAIResponseClient"/>.</summary>
internal sealed class OpenAIResponsesChatClient : IChatClient
{
/// <summary>Metadata about the client.</summary>
private readonly ChatClientMetadata _metadata;
/// <summary>The underlying <see cref="OpenAIResponseClient" />.</summary>
private readonly OpenAIResponseClient _responseClient;
/// <summary>Initializes a new instance of the <see cref="OpenAIResponsesChatClient"/> class for the specified <see cref="OpenAIResponseClient"/>.</summary>
/// <param name="responseClient">The underlying client.</param>
/// <exception cref="ArgumentNullException"><paramref name="responseClient"/> is <see langword="null"/>.</exception>
public OpenAIResponsesChatClient(OpenAIResponseClient responseClient)
{
_ = Throw.IfNull(responseClient);
_responseClient = responseClient;
// https://github.com/openai/openai-dotnet/issues/215
// The endpoint and model aren't currently exposed, so use reflection to get at them, temporarily. Once packages
// implement the abstractions directly rather than providing adapters on top of the public APIs,
// the package can provide such implementations separate from what's exposed in the public API.
Uri providerUrl = typeof(OpenAIResponseClient).GetField("_endpoint", BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance)
?.GetValue(responseClient) as Uri ?? OpenAIClientExtensions.DefaultOpenAIEndpoint;
string? model = typeof(OpenAIResponseClient).GetField("_model", BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance)
?.GetValue(responseClient) as string;
_metadata = new("openai", providerUrl, model);
}
/// <inheritdoc />
object? IChatClient.GetService(Type serviceType, object? serviceKey)
{
_ = Throw.IfNull(serviceType);
return
serviceKey is not null ? null :
serviceType == typeof(ChatClientMetadata) ? _metadata :
serviceType == typeof(OpenAIResponseClient) ? _responseClient :
serviceType.IsInstanceOfType(this) ? this :
null;
}
/// <inheritdoc />
public async Task<ChatResponse> GetResponseAsync(
IEnumerable<ChatMessage> messages, ChatOptions? options = null, CancellationToken cancellationToken = default)
{
_ = Throw.IfNull(messages);
// Convert the inputs into what OpenAIResponseClient expects.
var openAIResponseItems = ToOpenAIResponseItems(messages);
var openAIOptions = ToOpenAIResponseCreationOptions(options);
// Make the call to the OpenAIResponseClient.
var openAIResponse = (await _responseClient.CreateResponseAsync(openAIResponseItems, openAIOptions, cancellationToken).ConfigureAwait(false)).Value;
// Convert the response to a ChatResponse.
return FromOpenAIResponse(openAIResponse, openAIOptions);
}
internal static ChatResponse FromOpenAIResponse(OpenAIResponse openAIResponse, ResponseCreationOptions? openAIOptions)
{
// Convert and return the results.
ChatResponse response = new()
{
ConversationId = openAIOptions?.StoredOutputEnabled is false ? null : openAIResponse.Id,
CreatedAt = openAIResponse.CreatedAt,
FinishReason = ToFinishReason(openAIResponse.IncompleteStatusDetails?.Reason),
Messages = [new(ChatRole.Assistant, [])],
ModelId = openAIResponse.Model,
RawRepresentation = openAIResponse,
ResponseId = openAIResponse.Id,
Usage = ToUsageDetails(openAIResponse),
};
if (!string.IsNullOrEmpty(openAIResponse.EndUserId))
{
(response.AdditionalProperties ??= [])[nameof(openAIResponse.EndUserId)] = openAIResponse.EndUserId;
}
if (openAIResponse.Error is not null)
{
(response.AdditionalProperties ??= [])[nameof(openAIResponse.Error)] = openAIResponse.Error;
}
if (openAIResponse.OutputItems is not null)
{
ChatMessage message = response.Messages[0];
Debug.Assert(message.Contents is List<AIContent>, "Expected a List<AIContent> for message contents.");
foreach (ResponseItem outputItem in openAIResponse.OutputItems)
{
switch (outputItem)
{
case MessageResponseItem messageItem:
if (message.MessageId is not null && message.MessageId != messageItem.Id)
{
message = new ChatMessage();
response.Messages.Add(message);
}
message.MessageId = messageItem.Id;
message.RawRepresentation = messageItem;
message.Role = ToChatRole(messageItem.Role);
((List<AIContent>)message.Contents).AddRange(ToAIContents(messageItem.Content));
break;
case ReasoningResponseItem reasoningItem when reasoningItem.GetSummaryText() is string summary && !string.IsNullOrWhiteSpace(summary):
message.Contents.Add(new TextReasoningContent(summary)
{
RawRepresentation = reasoningItem
});
break;
case FunctionCallResponseItem functionCall:
response.FinishReason ??= ChatFinishReason.ToolCalls;
var fcc = FunctionCallContent.CreateFromParsedArguments(
functionCall.FunctionArguments.ToMemory(),
functionCall.CallId,
functionCall.FunctionName,
static json => JsonSerializer.Deserialize(json.Span, OpenAIJsonContext.Default.IDictionaryStringObject)!);
fcc.RawRepresentation = outputItem;
message.Contents.Add(fcc);
break;
default:
message.Contents.Add(new()
{
RawRepresentation = outputItem,
});
break;
}
}
if (openAIResponse.Error is { } error)
{
message.Contents.Add(new ErrorContent(error.Message) { ErrorCode = error.Code.ToString() });
}
}
return response;
}
/// <inheritdoc />
public async IAsyncEnumerable<ChatResponseUpdate> GetStreamingResponseAsync(
IEnumerable<ChatMessage> messages, ChatOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default)
{
_ = Throw.IfNull(messages);
// Convert the inputs into what OpenAIResponseClient expects.
var openAIResponseItems = ToOpenAIResponseItems(messages);
var openAIOptions = ToOpenAIResponseCreationOptions(options);
// Make the call to the OpenAIResponseClient and process the streaming results.
DateTimeOffset? createdAt = null;
string? responseId = null;
string? conversationId = null;
string? modelId = null;
string? lastMessageId = null;
ChatRole? lastRole = null;
Dictionary<int, MessageResponseItem> outputIndexToMessages = [];
Dictionary<int, FunctionCallInfo>? functionCallInfos = null;
await foreach (var streamingUpdate in _responseClient.CreateResponseStreamingAsync(openAIResponseItems, openAIOptions, cancellationToken).ConfigureAwait(false))
{
switch (streamingUpdate)
{
case StreamingResponseCreatedUpdate createdUpdate:
createdAt = createdUpdate.Response.CreatedAt;
responseId = createdUpdate.Response.Id;
conversationId = openAIOptions.StoredOutputEnabled is false ? null : responseId;
modelId = createdUpdate.Response.Model;
goto default;
case StreamingResponseCompletedUpdate completedUpdate:
yield return new()
{
Contents = ToUsageDetails(completedUpdate.Response) is { } usage ? [new UsageContent(usage)] : [],
ConversationId = conversationId,
CreatedAt = createdAt,
FinishReason =
ToFinishReason(completedUpdate.Response?.IncompleteStatusDetails?.Reason) ??
(functionCallInfos is not null ? ChatFinishReason.ToolCalls : ChatFinishReason.Stop),
MessageId = lastMessageId,
ModelId = modelId,
RawRepresentation = streamingUpdate,
ResponseId = responseId,
Role = lastRole,
};
break;
case StreamingResponseOutputItemAddedUpdate outputItemAddedUpdate:
switch (outputItemAddedUpdate.Item)
{
case MessageResponseItem mri:
outputIndexToMessages[outputItemAddedUpdate.OutputIndex] = mri;
break;
case FunctionCallResponseItem fcri:
(functionCallInfos ??= [])[outputItemAddedUpdate.OutputIndex] = new(fcri);
break;
}
goto default;
case StreamingResponseOutputItemDoneUpdate outputItemDoneUpdate:
_ = outputIndexToMessages.Remove(outputItemDoneUpdate.OutputIndex);
goto default;
case StreamingResponseOutputTextDeltaUpdate outputTextDeltaUpdate:
_ = outputIndexToMessages.TryGetValue(outputTextDeltaUpdate.OutputIndex, out MessageResponseItem? messageItem);
lastMessageId = messageItem?.Id;
lastRole = ToChatRole(messageItem?.Role);
yield return new ChatResponseUpdate(lastRole, outputTextDeltaUpdate.Delta)
{
ConversationId = conversationId,
CreatedAt = createdAt,
MessageId = lastMessageId,
ModelId = modelId,
RawRepresentation = streamingUpdate,
ResponseId = responseId,
};
break;
case StreamingResponseFunctionCallArgumentsDeltaUpdate functionCallArgumentsDeltaUpdate:
{
if (functionCallInfos?.TryGetValue(functionCallArgumentsDeltaUpdate.OutputIndex, out FunctionCallInfo? callInfo) is true)
{
_ = (callInfo.Arguments ??= new()).Append(functionCallArgumentsDeltaUpdate.Delta);
}
goto default;
}
case StreamingResponseFunctionCallArgumentsDoneUpdate functionCallOutputDoneUpdate:
{
if (functionCallInfos?.TryGetValue(functionCallOutputDoneUpdate.OutputIndex, out FunctionCallInfo? callInfo) is true)
{
_ = functionCallInfos.Remove(functionCallOutputDoneUpdate.OutputIndex);
var fci = FunctionCallContent.CreateFromParsedArguments(
callInfo.Arguments?.ToString() ?? string.Empty,
callInfo.ResponseItem.CallId,
callInfo.ResponseItem.FunctionName,
static json => JsonSerializer.Deserialize(json, OpenAIJsonContext.Default.IDictionaryStringObject)!);
lastMessageId = callInfo.ResponseItem.Id;
lastRole = ChatRole.Assistant;
yield return new ChatResponseUpdate(lastRole, [fci])
{
ConversationId = conversationId,
CreatedAt = createdAt,
MessageId = lastMessageId,
ModelId = modelId,
RawRepresentation = streamingUpdate,
ResponseId = responseId,
};
break;
}
goto default;
}
case StreamingResponseErrorUpdate errorUpdate:
yield return new ChatResponseUpdate
{
Contents =
[
new ErrorContent(errorUpdate.Message)
{
ErrorCode = errorUpdate.Code,
Details = errorUpdate.Param,
}
],
ConversationId = conversationId,
CreatedAt = createdAt,
MessageId = lastMessageId,
ModelId = modelId,
RawRepresentation = streamingUpdate,
ResponseId = responseId,
Role = lastRole,
};
break;
case StreamingResponseRefusalDoneUpdate refusalDone:
yield return new ChatResponseUpdate
{
Contents = [new ErrorContent(refusalDone.Refusal) { ErrorCode = nameof(ResponseContentPart.Refusal) }],
ConversationId = conversationId,
CreatedAt = createdAt,
MessageId = lastMessageId,
ModelId = modelId,
RawRepresentation = streamingUpdate,
ResponseId = responseId,
Role = lastRole,
};
break;
default:
yield return new ChatResponseUpdate
{
ConversationId = conversationId,
CreatedAt = createdAt,
MessageId = lastMessageId,
ModelId = modelId,
RawRepresentation = streamingUpdate,
ResponseId = responseId,
Role = lastRole,
};
break;
}
}
}
/// <inheritdoc />
void IDisposable.Dispose()
{
// Nothing to dispose. Implementation required for the IChatClient interface.
}
internal static ResponseTool ToResponseTool(AIFunction aiFunction, ChatOptions? options = null)
{
bool? strict =
OpenAIClientExtensions.HasStrict(aiFunction.AdditionalProperties) ??
OpenAIClientExtensions.HasStrict(options?.AdditionalProperties);
return ResponseTool.CreateFunctionTool(
aiFunction.Name,
aiFunction.Description,
OpenAIClientExtensions.ToOpenAIFunctionParameters(aiFunction, strict),
strict ?? false);
}
/// <summary>Creates a <see cref="ChatRole"/> from a <see cref="MessageRole"/>.</summary>
private static ChatRole ToChatRole(MessageRole? role) =>
role switch
{
MessageRole.System => ChatRole.System,
MessageRole.Developer => OpenAIClientExtensions.ChatRoleDeveloper,
MessageRole.User => ChatRole.User,
_ => ChatRole.Assistant,
};
/// <summary>Creates a <see cref="ChatFinishReason"/> from a <see cref="ResponseIncompleteStatusReason"/>.</summary>
private static ChatFinishReason? ToFinishReason(ResponseIncompleteStatusReason? statusReason) =>
statusReason == ResponseIncompleteStatusReason.ContentFilter ? ChatFinishReason.ContentFilter :
statusReason == ResponseIncompleteStatusReason.MaxOutputTokens ? ChatFinishReason.Length :
null;
/// <summary>Converts a <see cref="ChatOptions"/> to a <see cref="ResponseCreationOptions"/>.</summary>
private ResponseCreationOptions ToOpenAIResponseCreationOptions(ChatOptions? options)
{
if (options is null)
{
return new ResponseCreationOptions();
}
if (options.RawRepresentationFactory?.Invoke(this) is not ResponseCreationOptions result)
{
result = new ResponseCreationOptions();
}
// Handle strongly-typed properties.
result.MaxOutputTokenCount ??= options.MaxOutputTokens;
result.ParallelToolCallsEnabled ??= options.AllowMultipleToolCalls;
result.PreviousResponseId ??= options.ConversationId;
result.Temperature ??= options.Temperature;
result.TopP ??= options.TopP;
if (options.Instructions is { } instructions)
{
result.Instructions = string.IsNullOrEmpty(result.Instructions) ?
instructions :
$"{result.Instructions}{Environment.NewLine}{instructions}";
}
// Populate tools if there are any.
if (options.Tools is { Count: > 0 } tools)
{
foreach (AITool tool in tools)
{
switch (tool)
{
case AIFunction aiFunction:
result.Tools.Add(ToResponseTool(aiFunction, options));
break;
case HostedWebSearchTool:
WebSearchUserLocation? location = null;
if (tool.AdditionalProperties.TryGetValue(nameof(WebSearchUserLocation), out object? objLocation))
{
location = objLocation as WebSearchUserLocation;
}
WebSearchContextSize? size = null;
if (tool.AdditionalProperties.TryGetValue(nameof(WebSearchContextSize), out object? objSize) &&
objSize is WebSearchContextSize)
{
size = (WebSearchContextSize)objSize;
}
result.Tools.Add(ResponseTool.CreateWebSearchTool(location, size));
break;
}
}
if (result.ToolChoice is null && result.Tools.Count > 0)
{
switch (options.ToolMode)
{
case NoneChatToolMode:
result.ToolChoice = ResponseToolChoice.CreateNoneChoice();
break;
case AutoChatToolMode:
case null:
result.ToolChoice = ResponseToolChoice.CreateAutoChoice();
break;
case RequiredChatToolMode required:
result.ToolChoice = required.RequiredFunctionName is not null ?
ResponseToolChoice.CreateFunctionChoice(required.RequiredFunctionName) :
ResponseToolChoice.CreateRequiredChoice();
break;
}
}
}
if (result.TextOptions is null)
{
if (options.ResponseFormat is ChatResponseFormatText)
{
result.TextOptions = new()
{
TextFormat = ResponseTextFormat.CreateTextFormat()
};
}
else if (options.ResponseFormat is ChatResponseFormatJson jsonFormat)
{
result.TextOptions = new()
{
TextFormat = OpenAIClientExtensions.StrictSchemaTransformCache.GetOrCreateTransformedSchema(jsonFormat) is { } jsonSchema ?
ResponseTextFormat.CreateJsonSchemaFormat(
jsonFormat.SchemaName ?? "json_schema",
BinaryData.FromBytes(JsonSerializer.SerializeToUtf8Bytes(jsonSchema, OpenAIJsonContext.Default.JsonElement)),
jsonFormat.SchemaDescription,
OpenAIClientExtensions.HasStrict(options.AdditionalProperties)) :
ResponseTextFormat.CreateJsonObjectFormat(),
};
}
}
return result;
}
/// <summary>Convert a sequence of <see cref="ChatMessage"/>s to <see cref="ResponseItem"/>s.</summary>
internal static IEnumerable<ResponseItem> ToOpenAIResponseItems(IEnumerable<ChatMessage> inputs)
{
foreach (ChatMessage input in inputs)
{
if (input.Role == ChatRole.System ||
input.Role == OpenAIClientExtensions.ChatRoleDeveloper)
{
string text = input.Text;
if (!string.IsNullOrWhiteSpace(text))
{
yield return input.Role == ChatRole.System ?
ResponseItem.CreateSystemMessageItem(text) :
ResponseItem.CreateDeveloperMessageItem(text);
}
continue;
}
if (input.Role == ChatRole.User)
{
yield return ResponseItem.CreateUserMessageItem(ToOpenAIResponsesContent(input.Contents));
continue;
}
if (input.Role == ChatRole.Tool)
{
foreach (AIContent item in input.Contents)
{
switch (item)
{
case FunctionResultContent resultContent:
string? result = resultContent.Result as string;
if (result is null && resultContent.Result is not null)
{
try
{
result = JsonSerializer.Serialize(resultContent.Result, AIJsonUtilities.DefaultOptions.GetTypeInfo(typeof(object)));
}
catch (NotSupportedException)
{
// If the type can't be serialized, skip it.
}
}
yield return ResponseItem.CreateFunctionCallOutputItem(resultContent.CallId, result ?? string.Empty);
break;
}
}
continue;
}
if (input.Role == ChatRole.Assistant)
{
foreach (AIContent item in input.Contents)
{
switch (item)
{
case TextContent textContent:
yield return ResponseItem.CreateAssistantMessageItem(textContent.Text);
break;
case TextReasoningContent reasoningContent:
yield return ResponseItem.CreateReasoningItem(reasoningContent.Text);
break;
case FunctionCallContent callContent:
yield return ResponseItem.CreateFunctionCallItem(
callContent.CallId,
callContent.Name,
BinaryData.FromBytes(JsonSerializer.SerializeToUtf8Bytes(
callContent.Arguments,
AIJsonUtilities.DefaultOptions.GetTypeInfo(typeof(IDictionary<string, object?>)))));
break;
case AIContent when item.RawRepresentation is ResponseItem rawRep:
yield return rawRep;
break;
}
}
continue;
}
}
}
/// <summary>Extract usage details from an <see cref="OpenAIResponse"/>.</summary>
private static UsageDetails? ToUsageDetails(OpenAIResponse? openAIResponse)
{
UsageDetails? ud = null;
if (openAIResponse?.Usage is { } usage)
{
ud = new()
{
InputTokenCount = usage.InputTokenCount,
OutputTokenCount = usage.OutputTokenCount,
TotalTokenCount = usage.TotalTokenCount,
};
if (usage.InputTokenDetails is { } inputDetails)
{
ud.AdditionalCounts ??= [];
ud.AdditionalCounts.Add($"{nameof(usage.InputTokenDetails)}.{nameof(inputDetails.CachedTokenCount)}", inputDetails.CachedTokenCount);
}
if (usage.OutputTokenDetails is { } outputDetails)
{
ud.AdditionalCounts ??= [];
ud.AdditionalCounts.Add($"{nameof(usage.OutputTokenDetails)}.{nameof(outputDetails.ReasoningTokenCount)}", outputDetails.ReasoningTokenCount);
}
}
return ud;
}
/// <summary>Convert a sequence of <see cref="ResponseContentPart"/>s to a list of <see cref="AIContent"/>.</summary>
private static List<AIContent> ToAIContents(IEnumerable<ResponseContentPart> contents)
{
List<AIContent> results = [];
foreach (ResponseContentPart part in contents)
{
switch (part.Kind)
{
case ResponseContentPartKind.OutputText:
results.Add(new TextContent(part.Text)
{
RawRepresentation = part,
});
break;
case ResponseContentPartKind.Refusal:
results.Add(new ErrorContent(part.Refusal)
{
ErrorCode = nameof(ResponseContentPartKind.Refusal),
RawRepresentation = part,
});
break;
default:
results.Add(new()
{
RawRepresentation = part,
});
break;
}
}
return results;
}
/// <summary>Convert a list of <see cref="AIContent"/>s to a list of <see cref="ResponseContentPart"/>.</summary>
private static List<ResponseContentPart> ToOpenAIResponsesContent(IList<AIContent> contents)
{
List<ResponseContentPart> parts = [];
foreach (var content in contents)
{
switch (content)
{
case TextContent textContent:
parts.Add(ResponseContentPart.CreateInputTextPart(textContent.Text));
break;
case UriContent uriContent when uriContent.HasTopLevelMediaType("image"):
parts.Add(ResponseContentPart.CreateInputImagePart(uriContent.Uri));
break;
case DataContent dataContent when dataContent.HasTopLevelMediaType("image"):
parts.Add(ResponseContentPart.CreateInputImagePart(BinaryData.FromBytes(dataContent.Data), dataContent.MediaType));
break;
case DataContent dataContent when dataContent.MediaType.StartsWith("application/pdf", StringComparison.OrdinalIgnoreCase):
parts.Add(ResponseContentPart.CreateInputFilePart(BinaryData.FromBytes(dataContent.Data), dataContent.MediaType, dataContent.Name ?? $"{Guid.NewGuid():N}.pdf"));
break;
case ErrorContent errorContent when errorContent.ErrorCode == nameof(ResponseContentPartKind.Refusal):
parts.Add(ResponseContentPart.CreateRefusalPart(errorContent.Message));
break;
case AIContent when content.RawRepresentation is ResponseContentPart rawRep:
parts.Add(rawRep);
break;
}
}
if (parts.Count == 0)
{
parts.Add(ResponseContentPart.CreateInputTextPart(string.Empty));
}
return parts;
}
/// <summary>POCO representing function calling info.</summary>
/// <remarks>Used to concatenation information for a single function call from across multiple streaming updates.</remarks>
private sealed class FunctionCallInfo(FunctionCallResponseItem item)
{
public readonly FunctionCallResponseItem ResponseItem = item;
public StringBuilder? Arguments;
}
}
|