Skip to content

Rename useJsonSchema parameter #6394

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
merged 2 commits into from
May 8, 2025
Merged

Rename useJsonSchema parameter #6394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6217ebd
Rename useJsonSchema parameter
stephentoub May 8, 2025
8011042
Update src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ChatClien…
stephentoub May 8, 2025
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
40 changes: 19 additions & 21 deletions src/Libraries/Microsoft.Extensions.AI/ChatCompletion/ChatClientStructuredOutputExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public static class ChatClientStructuredOutputExtensions
/// <param name="chatClient">The <see cref="IChatClient"/>.</param>
/// <param name="messages">The chat content to send.</param>
/// <param name="options">The chat options to configure the request.</param>
/// <param name="useJsonSchema">
/// <param name="useJsonSchemaResponseFormat">
/// <see langword="true" /> to set a JSON schema on the <see cref="ChatResponseFormat"/>; otherwise, <see langword="false" />. The default is <see langword="true" />.
/// Using a JSON schema improves reliability if the underlying model supports native structured output with a schema, but might cause an error if the model does not support it.
/// </param>
Expand All @@ -44,19 +44,17 @@ public static Task<ChatResponse<T>> GetResponseAsync<T>(
this IChatClient chatClient,
IEnumerable<ChatMessage> messages,
ChatOptions? options = null,
bool? useJsonSchema = null,
bool? useJsonSchemaResponseFormat = null,
CancellationToken cancellationToken = default) =>
GetResponseAsync<T>(chatClient, messages, AIJsonUtilities.DefaultOptions, options, useJsonSchema, cancellationToken);
GetResponseAsync<T>(chatClient, messages, AIJsonUtilities.DefaultOptions, options, useJsonSchemaResponseFormat, cancellationToken);

/// <summary>Sends a user chat text message, requesting a response matching the type <typeparamref name="T"/>.</summary>
/// <param name="chatClient">The <see cref="IChatClient"/>.</param>
/// <param name="chatMessage">The text content for the chat message to send.</param>
/// <param name="options">The chat options to configure the request.</param>
/// <param name="useJsonSchema">
/// <param name="useJsonSchemaResponseFormat">
/// <see langword="true" /> to set a JSON schema on the <see cref="ChatResponseFormat"/>; otherwise, <see langword="false" />.
/// Using a JSON schema improves reliability if the underlying model supports native structured output with a schema, but might cause an error if the model does not support it.
/// If not specified, the default value is determined by the implementation.
/// If a specific value is required, it must be specified by the caller.
/// </param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
/// <returns>The response messages generated by the client.</returns>
Expand All @@ -66,15 +64,15 @@ public static Task<ChatResponse<T>> GetResponseAsync<T>(
this IChatClient chatClient,
string chatMessage,
ChatOptions? options = null,
bool? useJsonSchema = null,
bool? useJsonSchemaResponseFormat = null,
CancellationToken cancellationToken = default) =>
GetResponseAsync<T>(chatClient, new ChatMessage(ChatRole.User, chatMessage), options, useJsonSchema, cancellationToken);
GetResponseAsync<T>(chatClient, new ChatMessage(ChatRole.User, chatMessage), options, useJsonSchemaResponseFormat, cancellationToken);

/// <summary>Sends a chat message, requesting a response matching the type <typeparamref name="T"/>.</summary>
/// <param name="chatClient">The <see cref="IChatClient"/>.</param>
/// <param name="chatMessage">The chat message to send.</param>
/// <param name="options">The chat options to configure the request.</param>
/// <param name="useJsonSchema">
/// <param name="useJsonSchemaResponseFormat">
/// <see langword="true" /> to set a JSON schema on the <see cref="ChatResponseFormat"/>; otherwise, <see langword="false" />. The default is <see langword="true" />.
/// Using a JSON schema improves reliability if the underlying model supports native structured output with a schema, but might cause an error if the model does not support it.
/// </param>
Expand All @@ -85,16 +83,16 @@ public static Task<ChatResponse<T>> GetResponseAsync<T>(
this IChatClient chatClient,
ChatMessage chatMessage,
ChatOptions? options = null,
bool? useJsonSchema = null,
bool? useJsonSchemaResponseFormat = null,
CancellationToken cancellationToken = default) =>
GetResponseAsync<T>(chatClient, [chatMessage], options, useJsonSchema, cancellationToken);
GetResponseAsync<T>(chatClient, [chatMessage], options, useJsonSchemaResponseFormat, cancellationToken);

/// <summary>Sends a user chat text message, requesting a response matching the type <typeparamref name="T"/>.</summary>
/// <param name="chatClient">The <see cref="IChatClient"/>.</param>
/// <param name="chatMessage">The text content for the chat message to send.</param>
/// <param name="serializerOptions">The JSON serialization options to use.</param>
/// <param name="options">The chat options to configure the request.</param>
/// <param name="useJsonSchema">
/// <param name="useJsonSchemaResponseFormat">
/// <see langword="true" /> to set a JSON schema on the <see cref="ChatResponseFormat"/>; otherwise, <see langword="false" />. The default is <see langword="true" />.
/// Using a JSON schema improves reliability if the underlying model supports native structured output with a schema, but might cause an error if the model does not support it.
/// </param>
Expand All @@ -106,16 +104,16 @@ public static Task<ChatResponse<T>> GetResponseAsync<T>(
string chatMessage,
JsonSerializerOptions serializerOptions,
ChatOptions? options = null,
bool? useJsonSchema = null,
bool? useJsonSchemaResponseFormat = null,
CancellationToken cancellationToken = default) =>
GetResponseAsync<T>(chatClient, new ChatMessage(ChatRole.User, chatMessage), serializerOptions, options, useJsonSchema, cancellationToken);
GetResponseAsync<T>(chatClient, new ChatMessage(ChatRole.User, chatMessage), serializerOptions, options, useJsonSchemaResponseFormat, cancellationToken);

/// <summary>Sends a chat message, requesting a response matching the type <typeparamref name="T"/>.</summary>
/// <param name="chatClient">The <see cref="IChatClient"/>.</param>
/// <param name="chatMessage">The chat message to send.</param>
/// <param name="serializerOptions">The JSON serialization options to use.</param>
/// <param name="options">The chat options to configure the request.</param>
/// <param name="useJsonSchema">
/// <param name="useJsonSchemaResponseFormat">
/// <see langword="true" /> to set a JSON schema on the <see cref="ChatResponseFormat"/>; otherwise, <see langword="false" />. The default is <see langword="true" />.
/// Using a JSON schema improves reliability if the underlying model supports native structured output with a schema, but might cause an error if the model does not support it.
/// </param>
Expand All @@ -127,16 +125,16 @@ public static Task<ChatResponse<T>> GetResponseAsync<T>(
ChatMessage chatMessage,
JsonSerializerOptions serializerOptions,
ChatOptions? options = null,
bool? useJsonSchema = null,
bool? useJsonSchemaResponseFormat = null,
CancellationToken cancellationToken = default) =>
GetResponseAsync<T>(chatClient, [chatMessage], serializerOptions, options, useJsonSchema, cancellationToken);
GetResponseAsync<T>(chatClient, [chatMessage], serializerOptions, options, useJsonSchemaResponseFormat, cancellationToken);

/// <summary>Sends chat messages, requesting a response matching the type <typeparamref name="T"/>.</summary>
/// <param name="chatClient">The <see cref="IChatClient"/>.</param>
/// <param name="messages">The chat content to send.</param>
/// <param name="serializerOptions">The JSON serialization options to use.</param>
/// <param name="options">The chat options to configure the request.</param>
/// <param name="useJsonSchema">
/// <param name="useJsonSchemaResponseFormat">
/// <see langword="true" /> to set a JSON schema on the <see cref="ChatResponseFormat"/>; otherwise, <see langword="false" />. The default is <see langword="true" />.
/// Using a JSON schema improves reliability if the underlying model supports native structured output with a schema, but might cause an error if the model does not support it.
/// </param>
Expand All @@ -149,7 +147,7 @@ public static async Task<ChatResponse<T>> GetResponseAsync<T>(
IEnumerable<ChatMessage> messages,
JsonSerializerOptions serializerOptions,
ChatOptions? options = null,
bool? useJsonSchema = null,
bool? useJsonSchemaResponseFormat = null,
CancellationToken cancellationToken = default)
{
_ = Throw.IfNull(chatClient);
Expand Down Expand Up @@ -192,8 +190,8 @@ public static async Task<ChatResponse<T>> GetResponseAsync<T>(

// We default to assuming that models support JSON schema because developers will normally use
// GetResponseAsync<T> only with models that do. If the model doesn't support JSON schema, it may
// throw or it may ignore the schema. In these cases developers should pass useJsonSchema: false.
if (useJsonSchema.GetValueOrDefault(true))
// throw or it may ignore the schema. In these cases developers should pass useJsonSchemaResponseFormat: false.
if (useJsonSchemaResponseFormat ?? true)
{
// When using native structured output, we don't add any additional prompt, because
// the LLM backend is meant to do whatever's needed to explain the schema to the LLM.
Expand Down
2 changes: 1 addition & 1 deletion test/Libraries/Microsoft.Extensions.AI.Integration.Tests/ChatClientIntegrationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -942,7 +942,7 @@ public virtual async Task GetResponseAsync_StructuredOutput_NonNative()

var response = await captureOutputChatClient.GetResponseAsync<Person>("""
Supply an object to represent Jimbo Smith from Cardiff.
""", useJsonSchema: false);
""", useJsonSchemaResponseFormat: false);

Assert.Equal("Jimbo Smith", response.Result.FullName);
Assert.Contains("Cardiff", response.Result.HomeTown);
Expand Down
2 changes: 1 addition & 1 deletion ...Microsoft.Extensions.AI.Tests/ChatCompletion/ChatClientStructuredOutputExtensionsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ public async Task SuccessUsage_NoJsonSchema()
};

var chatHistory = new List<ChatMessage> { new(ChatRole.User, "Hello") };
var response = await client.GetResponseAsync<Animal>(chatHistory, useJsonSchema: false, serializerOptions: JsonContext2.Default.Options);
var response = await client.GetResponseAsync<Animal>(chatHistory, useJsonSchemaResponseFormat: false, serializerOptions: JsonContext2.Default.Options);

// The response contains the deserialized result and other response properties
Assert.Equal(1, response.Result.Id);
Expand Down
Loading