Skip to content

feat: Updated OpenAPI spec #384

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

Merged
github-actions merged 1 commit into from
Aug 25, 2026
Merged

feat: Updated OpenAPI spec #384

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
1 change: 1 addition & 0 deletions src/libs/tryAGI.OpenAI.CLI/GeneratedApi/Commands/AudioApiGroupCommand.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ public static Command Create()
{
var command = new Command(@"audio", @"Audio endpoint commands.");
command.Subcommands.Add(AudioCreateSpeechCommandApiCommand.Create());
command.Subcommands.Add(AudioCreateSpeechAsStreamCommandApiCommand.Create());
command.Subcommands.Add(AudioCreateTranscriptionCommandApiCommand.Create());
command.Subcommands.Add(AudioCreateTranscriptionAsStreamCommandApiCommand.Create());
command.Subcommands.Add(AudioCreateTranslationCommandApiCommand.Create());
Expand Down
109 changes: 109 additions & 0 deletions ...s/tryAGI.OpenAI.CLI/GeneratedApi/Commands/AudioCreateSpeechAsStreamCommandApiCommand.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
#nullable enable
#pragma warning disable CS0618

using System.CommandLine;

namespace tryAGI.OpenAI.Cli.GeneratedApi.Commands;

internal static partial class AudioCreateSpeechAsStreamCommandApiCommand
{
private static Option<global::tryAGI.OpenAI.AnyOf<string, global::tryAGI.OpenAI.CreateSpeechRequestModel?>> Model { get; } = new(
name: @"--model")
{
Description = @"One of the available [TTS models](/docs/models#tts): `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`.
",
Required = true,
};

private static Option<global::tryAGI.OpenAI.VoiceIdsOrCustomVoice> Voice { get; } = new(
name: @"--voice")
{
Description = @"The voice to use when generating the audio. Supported built-in voices are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice object with an `id`, for example `{ ""id"": ""voice_1234"" }`. Previews of the voices are available in the [Text to speech guide](/docs/guides/text-to-speech#voice-options).",
Required = true,
};
private static readonly CreateSpeechRequestOptionSet CreateSpeechRequestOptionSetOptions = CreateSpeechRequestOptionSet.Create();
private static Option<string?> RequestInput { get; } = new(@"--request-input")
{
Description = "Load request JSON from a file path, '-' for stdin, or an inline JSON object/array string.",
};

private static Option<string?> RequestJson { get; } = new(@"--request-json")
{
Description = "Request body as JSON.",
Hidden = true,
};

private static Option<string?> RequestFile { get; } = new(@"--request-file")
{
Description = "Path to a JSON request file, or '-' for stdin.",
Hidden = true,
};

public static Command Create()
{
var command = new Command(@"create-speech-as-stream", @"Generates audio from the input text.

Returns the audio file content, or a stream of audio events.
");
command.Options.Add(Model);
command.Options.Add(Voice); command.Options.Add(CreateSpeechRequestOptionSetOptions.InputOption);
command.Options.Add(CreateSpeechRequestOptionSetOptions.Instructions);
command.Options.Add(CreateSpeechRequestOptionSetOptions.ResponseFormat);
command.Options.Add(CreateSpeechRequestOptionSetOptions.Speed);
command.Options.Add(CreateSpeechRequestOptionSetOptions.StreamFormat);
command.Options.Add(RequestInput);
command.Options.Add(RequestJson);
command.Options.Add(RequestFile);
command.Validators.Add(result =>
{
var hasInput = result.GetResult(RequestInput) is not null;
var hasRequestJson = result.GetResult(RequestJson) is not null;
var hasRequestFile = result.GetResult(RequestFile) is not null;
var specifiedCount = (hasInput ? 1 : 0) + (hasRequestJson ? 1 : 0) + (hasRequestFile ? 1 : 0);
if (specifiedCount > 1)
{
result.AddError(@"Specify at most one of --request-input, --request-json, or --request-file.");
}
});

command.SetAction(async (ParseResult parseResult, CancellationToken cancellationToken) =>
await CliRuntime.RunAsync(async () =>
{
var __requestBase = await CliRuntime.ReadRequestOrDefaultAsync<global::tryAGI.OpenAI.CreateSpeechRequest>(
parseResult,
RequestInput,
RequestJson,
RequestFile,
global::tryAGI.OpenAI.SourceGenerationContext.Default,
cancellationToken).ConfigureAwait(false);
var model = parseResult.GetRequiredValue(Model);
var voice = parseResult.GetRequiredValue(Voice); var input = parseResult.GetRequiredValue(CreateSpeechRequestOptionSetOptions.InputOption);
var instructions = CliRuntime.WasSpecified(parseResult, CreateSpeechRequestOptionSetOptions.Instructions) ? parseResult.GetValue(CreateSpeechRequestOptionSetOptions.Instructions) : (__requestBase is { } __InstructionsBaseValue ? __InstructionsBaseValue.Instructions : default);
var responseFormat = CliRuntime.WasSpecified(parseResult, CreateSpeechRequestOptionSetOptions.ResponseFormat) ? parseResult.GetValue(CreateSpeechRequestOptionSetOptions.ResponseFormat) : (__requestBase is { } __ResponseFormatBaseValue ? __ResponseFormatBaseValue.ResponseFormat : default);
var speed = CliRuntime.WasSpecified(parseResult, CreateSpeechRequestOptionSetOptions.Speed) ? parseResult.GetValue(CreateSpeechRequestOptionSetOptions.Speed) : (__requestBase is { } __SpeedBaseValue ? __SpeedBaseValue.Speed : default);
var streamFormat = CliRuntime.WasSpecified(parseResult, CreateSpeechRequestOptionSetOptions.StreamFormat) ? parseResult.GetValue(CreateSpeechRequestOptionSetOptions.StreamFormat) : (__requestBase is { } __StreamFormatBaseValue ? __StreamFormatBaseValue.StreamFormat : default);
using var client = await CliRuntime.CreateClientAsync(parseResult, cancellationToken).ConfigureAwait(false);


var response = client.Audio.CreateSpeechAsStreamAsync(
model: model,
voice: voice,
input: input,
instructions: instructions,
responseFormat: responseFormat,
speed: speed,
streamFormat: streamFormat,
cancellationToken: cancellationToken);

await foreach (var item in response.WithCancellation(cancellationToken).ConfigureAwait(false))
{
await CliRuntime.WriteResponseLineAsync(
parseResult,
item,
global::tryAGI.OpenAI.SourceGenerationContext.Default,
cancellationToken: cancellationToken).ConfigureAwait(false);
}
}, cancellationToken).ConfigureAwait(false));
return command;
}
}
69 changes: 15 additions & 54 deletions src/libs/tryAGI.OpenAI.CLI/GeneratedApi/Commands/AudioCreateSpeechCommandApiCommand.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,43 +15,13 @@ internal static partial class AudioCreateSpeechCommandApiCommand
Required = true,
};

private static Option<string> InputOption { get; } = new(
name: @"--input")
{
Description = @"The text to generate audio for. The maximum length is 4096 characters.",
Required = true,
};

private static Option<string?> Instructions { get; } = new(
name: @"--instructions")
{
Description = @"Control the voice of your generated audio with additional instructions. Does not work with `tts-1` or `tts-1-hd`.",
};

private static Option<global::tryAGI.OpenAI.VoiceIdsOrCustomVoice> Voice { get; } = new(
name: @"--voice")
{
Description = @"The voice to use when generating the audio. Supported built-in voices are `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice object with an `id`, for example `{ ""id"": ""voice_1234"" }`. Previews of the voices are available in the [Text to speech guide](/docs/guides/text-to-speech#voice-options).",
Required = true,
};

private static Option<global::tryAGI.OpenAI.CreateSpeechRequestResponseFormat?> ResponseFormat { get; } = new(
name: @"--response-format")
{
Description = @"The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`.",
};

private static Option<double?> Speed { get; } = new(
name: @"--speed")
{
Description = @"The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the default.",
};

private static Option<global::tryAGI.OpenAI.CreateSpeechRequestStreamFormat?> StreamFormat { get; } = new(
name: @"--stream-format")
{
Description = @"The format to stream the audio in. Supported formats are `sse` and `audio`. `sse` is not supported for `tts-1` or `tts-1-hd`.",
};
private static readonly CreateSpeechRequestOptionSet CreateSpeechRequestOptionSetOptions = CreateSpeechRequestOptionSet.Create();
private static Option<string?> RequestInput { get; } = new(@"--request-input")
{
Description = "Load request JSON from a file path, '-' for stdin, or an inline JSON object/array string.",
Expand All @@ -76,12 +46,11 @@ public static Command Create()
Returns the audio file content, or a stream of audio events.
");
command.Options.Add(Model);
command.Options.Add(InputOption);
command.Options.Add(Instructions);
command.Options.Add(Voice);
command.Options.Add(ResponseFormat);
command.Options.Add(Speed);
command.Options.Add(StreamFormat);
command.Options.Add(Voice); command.Options.Add(CreateSpeechRequestOptionSetOptions.InputOption);
command.Options.Add(CreateSpeechRequestOptionSetOptions.Instructions);
command.Options.Add(CreateSpeechRequestOptionSetOptions.ResponseFormat);
command.Options.Add(CreateSpeechRequestOptionSetOptions.Speed);
command.Options.Add(CreateSpeechRequestOptionSetOptions.StreamFormat);
command.Options.Add(RequestInput);
command.Options.Add(RequestJson);
command.Options.Add(RequestFile);
Expand All @@ -108,33 +77,25 @@ await CliRuntime.RunAsync(async () =>
global::tryAGI.OpenAI.SourceGenerationContext.Default,
cancellationToken).ConfigureAwait(false);
var model = parseResult.GetRequiredValue(Model);
var input = parseResult.GetRequiredValue(InputOption);
var instructions = CliRuntime.WasSpecified(parseResult, Instructions) ? parseResult.GetValue(Instructions) : (__requestBase is { } __InstructionsBaseValue ? __InstructionsBaseValue.Instructions : default);
var voice = parseResult.GetRequiredValue(Voice);
var responseFormat = CliRuntime.WasSpecified(parseResult, ResponseFormat) ? parseResult.GetValue(ResponseFormat) : (__requestBase is { } __ResponseFormatBaseValue ? __ResponseFormatBaseValue.ResponseFormat : default);
var speed = CliRuntime.WasSpecified(parseResult, Speed) ? parseResult.GetValue(Speed) : (__requestBase is { } __SpeedBaseValue ? __SpeedBaseValue.Speed : default);
var streamFormat = CliRuntime.WasSpecified(parseResult, StreamFormat) ? parseResult.GetValue(StreamFormat) : (__requestBase is { } __StreamFormatBaseValue ? __StreamFormatBaseValue.StreamFormat : default);
var voice = parseResult.GetRequiredValue(Voice); var input = parseResult.GetRequiredValue(CreateSpeechRequestOptionSetOptions.InputOption);
var instructions = CliRuntime.WasSpecified(parseResult, CreateSpeechRequestOptionSetOptions.Instructions) ? parseResult.GetValue(CreateSpeechRequestOptionSetOptions.Instructions) : (__requestBase is { } __InstructionsBaseValue ? __InstructionsBaseValue.Instructions : default);
var responseFormat = CliRuntime.WasSpecified(parseResult, CreateSpeechRequestOptionSetOptions.ResponseFormat) ? parseResult.GetValue(CreateSpeechRequestOptionSetOptions.ResponseFormat) : (__requestBase is { } __ResponseFormatBaseValue ? __ResponseFormatBaseValue.ResponseFormat : default);
var speed = CliRuntime.WasSpecified(parseResult, CreateSpeechRequestOptionSetOptions.Speed) ? parseResult.GetValue(CreateSpeechRequestOptionSetOptions.Speed) : (__requestBase is { } __SpeedBaseValue ? __SpeedBaseValue.Speed : default);
var streamFormat = CliRuntime.WasSpecified(parseResult, CreateSpeechRequestOptionSetOptions.StreamFormat) ? parseResult.GetValue(CreateSpeechRequestOptionSetOptions.StreamFormat) : (__requestBase is { } __StreamFormatBaseValue ? __StreamFormatBaseValue.StreamFormat : default);
using var client = await CliRuntime.CreateClientAsync(parseResult, cancellationToken).ConfigureAwait(false);


var response = client.Audio.CreateSpeechAsync(
var response = await client.Audio.CreateSpeechAsync(
model: model,
voice: voice,
input: input,
instructions: instructions,
voice: voice,
responseFormat: responseFormat,
speed: speed,
streamFormat: streamFormat,
cancellationToken: cancellationToken);
cancellationToken: cancellationToken).ConfigureAwait(false);

await foreach (var item in response.WithCancellation(cancellationToken).ConfigureAwait(false))
{
await CliRuntime.WriteResponseLineAsync(
parseResult,
item,
global::tryAGI.OpenAI.SourceGenerationContext.Default,
cancellationToken: cancellationToken).ConfigureAwait(false);
}
await CliRuntime.WriteBinaryAsync(parseResult, response, cancellationToken).ConfigureAwait(false);
}, cancellationToken).ConfigureAwait(false));
return command;
}
Expand Down
43 changes: 43 additions & 0 deletions src/libs/tryAGI.OpenAI.CLI/GeneratedApi/Commands/CreateSpeechRequestOptionSet.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
#nullable enable

using System.CommandLine;

namespace tryAGI.OpenAI.Cli.GeneratedApi.Commands;

internal sealed record CreateSpeechRequestOptionSet(
Option<string> InputOption,
Option<string?> Instructions,
Option<global::tryAGI.OpenAI.CreateSpeechRequestResponseFormat?> ResponseFormat,
Option<double?> Speed,
Option<global::tryAGI.OpenAI.CreateSpeechRequestStreamFormat?> StreamFormat)
{
public static CreateSpeechRequestOptionSet Create(string? prefix = null)
{
var normalizedPrefix = string.IsNullOrWhiteSpace(prefix)
? string.Empty
: prefix.Trim().Trim('-') + "-";
return new CreateSpeechRequestOptionSet(
InputOption: new Option<string>($"--{normalizedPrefix}input")
{
Description = @"The text to generate audio for. The maximum length is 4096 characters.",
Required = true,
},
Instructions: new Option<string?>($"--{normalizedPrefix}instructions")
{
Description = @"Control the voice of your generated audio with additional instructions. Does not work with `tts-1` or `tts-1-hd`.",
},
ResponseFormat: new Option<global::tryAGI.OpenAI.CreateSpeechRequestResponseFormat?>($"--{normalizedPrefix}response-format")
{
Description = @"The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`.",
},
Speed: new Option<double?>($"--{normalizedPrefix}speed")
{
Description = @"The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the default.",
},
StreamFormat: new Option<global::tryAGI.OpenAI.CreateSpeechRequestStreamFormat?>($"--{normalizedPrefix}stream-format")
{
Description = @"The format to stream the audio in. Supported formats are `sse` and `audio`. `sse` is not supported for `tts-1` or `tts-1-hd`.",
}
);
}
}
28 changes: 1 addition & 27 deletions src/libs/tryAGI.OpenAI.CLI/GeneratedApi/Commands/RealtimeCreateCallCommandApiCommand.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,26 +31,6 @@ internal static partial class RealtimeCreateCallCommandApiCommand
Hidden = true,
};

private static string FormatResponse(ParseResult parseResult, string value, global::System.Text.Json.Serialization.JsonSerializerContext context, bool truncateLongStrings)
{
string? text = null;
CustomizeResponseText(parseResult, value, ref text);
if (!string.IsNullOrWhiteSpace(text))
{
return text;
}

var hints = new Dictionary<string, CliFormatHint>(StringComparer.OrdinalIgnoreCase)
{
};
CustomizeResponseFormatHints(hints);
return CliRuntime.FormatHumanReadable(value, context, truncateLongStrings, hints);
}

static partial void CustomizeResponseText(ParseResult parseResult, string value, ref string? text);
static partial void CustomizeResponseFormatHints(Dictionary<string, CliFormatHint> hints);


public static Command Create()
{
var command = new Command(@"create-call", @"Create a new Realtime API call over WebRTC and receive the SDP answer needed
Expand Down Expand Up @@ -113,13 +93,7 @@ await CliRuntime.RunAsync(async () =>
session: session,
cancellationToken: cancellationToken).ConfigureAwait(false);


await CliRuntime.WriteResponseAsync(
parseResult,
response,
global::tryAGI.OpenAI.SourceGenerationContext.Default,
FormatResponse,
cancellationToken).ConfigureAwait(false);
await CliRuntime.WriteBinaryAsync(parseResult, response, cancellationToken).ConfigureAwait(false);
}, cancellationToken).ConfigureAwait(false));
return command;
}
Expand Down
Loading
Loading