Skip to content

feat(sdk/cs): add Responses API client for OpenAI/OpenResponses compat #505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MaanavD wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(sdk/cs): add Responses API client for OpenAI/OpenResponses compat #505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions sdk_v2/cs/src/FoundryLocalManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,24 @@ await Utils.CallWithExceptionHandling(() => EnsureEpsDownloadedImplAsync(ct),
.ConfigureAwait(false);
}

/// <summary>
/// Creates an OpenAI Responses API client.
/// The web service must be started first via <see cref="StartWebServiceAsync"/>.
/// </summary>
/// <param name="modelId">Optional default model ID for requests.</param>
/// <returns>An <see cref="OpenAIResponsesClient"/> instance.</returns>
/// <exception cref="FoundryLocalException">If the web service is not running.</exception>
public OpenAIResponsesClient GetResponsesClient(string? modelId = null)
{
if (Urls == null || Urls.Length == 0)
{
throw new FoundryLocalException(
"Web service is not running. Call StartWebServiceAsync before creating a ResponsesClient.", _logger);
}

return new OpenAIResponsesClient(Urls[0], modelId);
}
Comment on lines +153 to +169
Copy link

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR adds a new public client + factory (GetResponsesClient) but there are existing client-focused tests for chat/audio under sdk_v2/cs/test. Consider adding at least basic coverage for the new factory (e.g., throws when Urls is null/empty, succeeds after StartWebServiceAsync) and one smoke test for create/stream parsing so regressions are caught.

Copilot uses AI. Check for mistakes.

private FoundryLocalManager(Configuration configuration, ILogger logger)
{
_config = configuration ?? throw new ArgumentNullException(nameof(configuration));
Expand Down
9 changes: 9 additions & 0 deletions sdk_v2/cs/src/IModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,13 @@ Task DownloadAsync(Action<float>? downloadProgress = null,
/// <param name="ct">Optional cancellation token.</param>
/// <returns>OpenAI.AudioClient</returns>
Task<OpenAIAudioClient> GetAudioClientAsync(CancellationToken? ct = null);

/// <summary>
/// Get an OpenAI Responses API client.
/// Unlike Chat/Audio clients (which use FFI), the Responses API is HTTP-based,
/// so the web service must be started first via <see cref="FoundryLocalManager.StartWebServiceAsync"/>.
/// </summary>
/// <param name="ct">Optional cancellation token.</param>
/// <returns>OpenAI.ResponsesClient</returns>
Task<OpenAIResponsesClient> GetResponsesClientAsync(CancellationToken? ct = null);
Comment on lines +71 to +78
Copy link

Copilot AI Mar 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding GetResponsesClientAsync(...) to the public IModel interface is a breaking change for any external implementers of IModel (they will no longer compile). If IModel is intended to be publicly implementable, consider using an extension method or a default interface implementation to preserve compatibility.

Copilot uses AI. Check for mistakes.
}
5 changes: 5 additions & 0 deletions sdk_v2/cs/src/Model.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,11 @@ public async Task<OpenAIAudioClient> GetAudioClientAsync(CancellationToken? ct =
return await SelectedVariant.GetAudioClientAsync(ct).ConfigureAwait(false);
}

public async Task<OpenAIResponsesClient> GetResponsesClientAsync(CancellationToken? ct = null)
{
return await SelectedVariant.GetResponsesClientAsync(ct).ConfigureAwait(false);
}

public async Task UnloadAsync(CancellationToken? ct = null)
{
await SelectedVariant.UnloadAsync(ct).ConfigureAwait(false);
Expand Down
24 changes: 24 additions & 0 deletions sdk_v2/cs/src/ModelVariant.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,13 @@ public async Task<OpenAIAudioClient> GetAudioClientAsync(CancellationToken? ct =
.ConfigureAwait(false);
}

public async Task<OpenAIResponsesClient> GetResponsesClientAsync(CancellationToken? ct = null)
{
return await Utils.CallWithExceptionHandling(() => GetResponsesClientImplAsync(ct),
"Error getting responses client for model", _logger)
.ConfigureAwait(false);
}

private async Task<bool> IsLoadedImplAsync(CancellationToken? ct = null)
{
var loadedModels = await _modelLoadManager.ListLoadedModelsAsync(ct).ConfigureAwait(false);
Expand Down Expand Up @@ -190,4 +197,21 @@ private async Task<OpenAIAudioClient> GetAudioClientImplAsync(CancellationToken?

return new OpenAIAudioClient(Id);
}

private async Task<OpenAIResponsesClient> GetResponsesClientImplAsync(CancellationToken? ct = null)
{
if (!await IsLoadedAsync(ct))
{
throw new FoundryLocalException($"Model {Id} is not loaded. Call LoadAsync first.");
}

var urls = FoundryLocalManager.Instance.Urls;
if (urls == null || urls.Length == 0)
{
throw new FoundryLocalException(
"Web service is not running. Call StartWebServiceAsync before creating a ResponsesClient.");
}

return new OpenAIResponsesClient(urls[0], Id);
}
}
Loading
Loading