Skip to content

feat:Update OpenAPI spec to use explicit null types; reformat docs #226

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
HavenDV merged 1 commit into from
Sep 15, 2025
Merged

feat:Update OpenAPI spec to use explicit null types; reformat docs #226

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
64 changes: 20 additions & 44 deletions src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI..JsonSerializerContext.g.cs
View file
Open in desktop

Large diffs are not rendered by default.

13 changes: 4 additions & 9 deletions src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.AssistantsClient.CreateAssistant.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ partial void ProcessCreateAssistantResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand All @@ -194,19 +194,14 @@ partial void ProcessCreateAssistantResponseContent(
/// The name of the assistant. The maximum length is 256 characters.
/// </param>
/// <param name="reasoningEffort">
/// Constrains effort on reasoning for <br/>
/// Constrains effort on reasoning for<br/>
/// [reasoning models](https://platform.openai.com/docs/guides/reasoning).<br/>
/// Currently supported values are `minimal`, `low`, `medium`, and `high`. Reducing<br/>
/// reasoning effort can result in faster responses and fewer tokens used<br/>
/// on reasoning in a response.<br/>
/// Default Value: medium
/// </param>
/// <param name="responseFormat">
/// Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.<br/>
/// Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).<br/>
/// Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON.<br/>
/// **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.
/// </param>
/// <param name="responseFormat"></param>
/// <param name="temperature">
/// What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.<br/>
/// Default Value: 1<br/>
Expand Down Expand Up @@ -236,7 +231,7 @@ partial void ProcessCreateAssistantResponseContent(
global::System.Collections.Generic.Dictionary<string, string>? metadata = default,
string? name = default,
global::tryAGI.OpenAI.ReasoningEffort? reasoningEffort = default,
global::tryAGI.OpenAI.AssistantsApiResponseFormatOption? responseFormat = default,
object? responseFormat = default,
double? temperature = default,
global::tryAGI.OpenAI.CreateAssistantRequestToolResources? toolResources = default,
global::System.Collections.Generic.IList<global::tryAGI.OpenAI.AssistantTool>? tools = default,
Expand Down
2 changes: 1 addition & 1 deletion src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.AssistantsClient.CreateMessage.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ partial void ProcessCreateMessageResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand Down
4 changes: 2 additions & 2 deletions src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.AssistantsClient.CreateRun.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ partial void ProcessCreateRunResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand All @@ -222,7 +222,7 @@ partial void ProcessCreateRunResponseContent(
/// Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling#configuring-parallel-function-calling) during tool use.
/// </param>
/// <param name="reasoningEffort">
/// Constrains effort on reasoning for <br/>
/// Constrains effort on reasoning for<br/>
/// [reasoning models](https://platform.openai.com/docs/guides/reasoning).<br/>
/// Currently supported values are `minimal`, `low`, `medium`, and `high`. Reducing<br/>
/// reasoning effort can result in faster responses and fewer tokens used<br/>
Expand Down
2 changes: 1 addition & 1 deletion src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.AssistantsClient.CreateThread.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ partial void ProcessCreateThreadResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand Down
4 changes: 2 additions & 2 deletions src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.AssistantsClient.CreateThreadAndRun.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ partial void ProcessCreateThreadAndRunResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand All @@ -213,7 +213,7 @@ partial void ProcessCreateThreadAndRunResponseContent(
/// Example: 1
/// </param>
/// <param name="thread">
/// Options to create a new thread. If no thread is provided when running a <br/>
/// Options to create a new thread. If no thread is provided when running a<br/>
/// request, an empty thread will be created.
/// </param>
/// <param name="toolChoice">
Expand Down
13 changes: 4 additions & 9 deletions src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.AssistantsClient.ModifyAssistant.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ partial void ProcessModifyAssistantResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand All @@ -200,19 +200,14 @@ partial void ProcessModifyAssistantResponseContent(
/// The name of the assistant. The maximum length is 256 characters.
/// </param>
/// <param name="reasoningEffort">
/// Constrains effort on reasoning for <br/>
/// Constrains effort on reasoning for<br/>
/// [reasoning models](https://platform.openai.com/docs/guides/reasoning).<br/>
/// Currently supported values are `minimal`, `low`, `medium`, and `high`. Reducing<br/>
/// reasoning effort can result in faster responses and fewer tokens used<br/>
/// on reasoning in a response.<br/>
/// Default Value: medium
/// </param>
/// <param name="responseFormat">
/// Specifies the format that the model must output. Compatible with [GPT-4o](https://platform.openai.com/docs/models#gpt-4o), [GPT-4 Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.<br/>
/// Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).<br/>
/// Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the message the model generates is valid JSON.<br/>
/// **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.
/// </param>
/// <param name="responseFormat"></param>
/// <param name="temperature">
/// What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.<br/>
/// Default Value: 1<br/>
Expand Down Expand Up @@ -243,7 +238,7 @@ partial void ProcessModifyAssistantResponseContent(
global::tryAGI.OpenAI.AnyOf<string, global::tryAGI.OpenAI.AssistantSupportedModels?>? model = default,
string? name = default,
global::tryAGI.OpenAI.ReasoningEffort? reasoningEffort = default,
global::tryAGI.OpenAI.AssistantsApiResponseFormatOption? responseFormat = default,
object? responseFormat = default,
double? temperature = default,
global::tryAGI.OpenAI.ModifyAssistantRequestToolResources? toolResources = default,
global::System.Collections.Generic.IList<global::tryAGI.OpenAI.AssistantTool>? tools = default,
Expand Down
2 changes: 1 addition & 1 deletion src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.AssistantsClient.ModifyMessage.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ partial void ProcessModifyMessageResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand Down
2 changes: 1 addition & 1 deletion src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.AssistantsClient.ModifyRun.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ partial void ProcessModifyRunResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand Down
2 changes: 1 addition & 1 deletion src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.AssistantsClient.ModifyThread.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ partial void ProcessModifyThreadResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand Down
18 changes: 8 additions & 10 deletions src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.AudioClient.CreateTranscription.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ partial void ProcessCreateTranscriptionResponseContent(
if (request.ChunkingStrategy != default)
{
__httpRequestContent.Add(
content: new global::System.Net.Http.StringContent(request.ChunkingStrategy?.ToString() ?? string.Empty),
content: new global::System.Net.Http.StringContent($"{request.ChunkingStrategy}"),
name: "chunking_strategy");
}
__httpRequestContent.Add(
Expand Down Expand Up @@ -221,20 +221,18 @@ partial void ProcessCreateTranscriptionResponseContent(
/// Create transcription<br/>
/// Transcribes audio into the input language.
/// </summary>
/// <param name="chunkingStrategy">
/// Controls how the audio is cut into chunks. When set to `"auto"`, the server first normalizes loudness and then uses voice activity detection (VAD) to choose boundaries. `server_vad` object can be provided to tweak VAD detection parameters manually. If unset, the audio is transcribed as a single block.
/// </param>
/// <param name="chunkingStrategy"></param>
/// <param name="file">
/// The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
/// </param>
/// <param name="filename">
/// The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
/// </param>
/// <param name="include">
/// Additional information to include in the transcription response. <br/>
/// `logprobs` will return the log probabilities of the tokens in the <br/>
/// response to understand the model's confidence in the transcription. <br/>
/// `logprobs` only works with response_format set to `json` and only with <br/>
/// Additional information to include in the transcription response.<br/>
/// `logprobs` will return the log probabilities of the tokens in the<br/>
/// response to understand the model's confidence in the transcription.<br/>
/// `logprobs` only works with response_format set to `json` and only with<br/>
/// the models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe`.
/// </param>
/// <param name="language">
Expand All @@ -253,7 +251,7 @@ partial void ProcessCreateTranscriptionResponseContent(
/// </param>
/// <param name="stream">
/// If set to true, the model response data will be streamed to the client<br/>
/// as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). <br/>
/// as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).<br/>
/// See the [Streaming section of the Speech-to-Text guide](https://platform.openai.com/docs/guides/speech-to-text?lang=curl#streaming-transcriptions)<br/>
/// for more information.<br/>
/// Note: Streaming is not supported for the `whisper-1` model and will be ignored.<br/>
Expand All @@ -273,7 +271,7 @@ partial void ProcessCreateTranscriptionResponseContent(
byte[] file,
string filename,
global::tryAGI.OpenAI.AnyOf<string, global::tryAGI.OpenAI.CreateTranscriptionRequestModel?> model,
global::tryAGI.OpenAI.TranscriptionChunkingStrategy? chunkingStrategy = default,
object? chunkingStrategy = default,
global::System.Collections.Generic.IList<global::tryAGI.OpenAI.TranscriptionInclude>? include = default,
string? language = default,
string? prompt = default,
Expand Down
2 changes: 1 addition & 1 deletion src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.BatchClient.CreateBatch.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ partial void ProcessCreateBatchResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand Down
2 changes: 1 addition & 1 deletion src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.ChatClient.ListChatCompletions.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ partial void ProcessListChatCompletionsResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand Down
2 changes: 1 addition & 1 deletion src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.ChatClient.UpdateChatCompletion.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ partial void ProcessUpdateChatCompletionResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand Down
2 changes: 1 addition & 1 deletion src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.ConversationsClient.CreateConversation.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ partial void ProcessCreateConversationResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand Down
2 changes: 1 addition & 1 deletion src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.EvalsClient.CreateEval.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ partial void ProcessCreateEvalResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand Down
2 changes: 1 addition & 1 deletion src/libs/tryAGI.OpenAI/Generated/tryAGI.OpenAI.EvalsClient.CreateEvalRun.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ partial void ProcessCreateEvalRunResponseContent(
/// <param name="metadata">
/// Set of 16 key-value pairs that can be attached to an object. This can be<br/>
/// useful for storing additional information about the object in a structured<br/>
/// format, and querying for objects via API or the dashboard. <br/>
/// format, and querying for objects via API or the dashboard.<br/>
/// Keys are strings with a maximum length of 64 characters. Values are strings<br/>
/// with a maximum length of 512 characters.
/// </param>
Expand Down
Loading
Loading