Skip to content

.Net: Fix Google Gemini API compatibility by filtering unsupported format fields #12972

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

Closed
Copilot wants to merge 2 commits into from
Closed

.Net: Fix Google Gemini API compatibility by filtering unsupported format fields #12972

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
6f30395
Initial plan
Copilot Aug 19, 2025
3d1a5db
Fix Google Gemini API format validation by stripping unsupported form…
Copilot Aug 19, 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
80 changes: 80 additions & 0 deletions dotnet/src/Connectors/Connectors.Google.UnitTests/Core/Gemini/GeminiRequestTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -694,6 +694,86 @@ public void FromPromptAndExecutionSettingsWithThinkingConfigReturnsInGenerationC
Assert.Equal(executionSettings.ThinkingConfig.ThinkingBudget, request.Configuration?.ThinkingConfig?.ThinkingBudget);
}

[Fact]
public void ResponseSchemaStripsUnsupportedFormatFields()
{
// Arrange
var prompt = "prompt-example";
var schemaWithUnsupportedFormats = """
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "unique identifier"
},
"email": {
"type": "string",
"format": "email",
"description": "user email"
},
"status": {
"type": "string",
"format": "enum",
"enum": ["active", "inactive"],
"description": "user status"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "creation timestamp"
},
"phoneNumber": {
"type": "string",
"format": "phone",
"description": "phone number"
}
}
}
""";

var executionSettings = new GeminiPromptExecutionSettings
{
ResponseMimeType = "application/json",
ResponseSchema = JsonSerializer.Deserialize<JsonElement>(schemaWithUnsupportedFormats)
};

// Act
var request = GeminiRequest.FromPromptAndExecutionSettings(prompt, executionSettings);

// Assert
Assert.NotNull(request.Configuration?.ResponseSchema);
var properties = request.Configuration.ResponseSchema.Value.GetProperty("properties");

// UUID format should be stripped
var idProperty = properties.GetProperty("id");
Assert.Equal("string", idProperty.GetProperty("type").GetString());
Assert.False(idProperty.TryGetProperty("format", out _));

// Email format should be stripped
var emailProperty = properties.GetProperty("email");
Assert.Equal("string", emailProperty.GetProperty("type").GetString());
Assert.False(emailProperty.TryGetProperty("format", out _));

// Enum format should be preserved
var statusProperty = properties.GetProperty("status");
Assert.Equal("string", statusProperty.GetProperty("type").GetString());
Assert.True(statusProperty.TryGetProperty("format", out var statusFormat));
Assert.Equal("enum", statusFormat.GetString());

// Date-time format should be preserved
var createdAtProperty = properties.GetProperty("createdAt");
Assert.Equal("string", createdAtProperty.GetProperty("type").GetString());
Assert.True(createdAtProperty.TryGetProperty("format", out var createdAtFormat));
Assert.Equal("date-time", createdAtFormat.GetString());

// Phone format should be stripped
var phoneProperty = properties.GetProperty("phoneNumber");
Assert.Equal("string", phoneProperty.GetProperty("type").GetString());
Assert.False(phoneProperty.TryGetProperty("format", out _));
}

private sealed class DummyContent(object? innerContent, string? modelId = null, IReadOnlyDictionary<string, object?>? metadata = null) :
KernelContent(innerContent, modelId, metadata);

Expand Down
20 changes: 18 additions & 2 deletions dotnet/src/Connectors/Connectors.Google/Core/Gemini/Models/GeminiRequest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,23 @@ static void TransformOpenApi3Object(JsonObject obj)
{
propertyObj["type"] = JsonValue.Create("string");
}
else if (propertyObj.TryGetPropertyValue("type", out JsonNode? typeNode))

// Strip unsupported format fields for string types
// Google API only supports "enum" and "date-time" formats for string types
if (propertyObj.TryGetPropertyValue("type", out JsonNode? typeNode) &&
typeNode is JsonValue typeValue &&
typeValue.GetValue<string>() == "string" &&
propertyObj.TryGetPropertyValue("format", out JsonNode? formatNode) &&
formatNode is JsonValue formatValue)
{
var format = formatValue.GetValue<string>();
if (format != "enum" && format != "date-time")
{
propertyObj.Remove("format");
}
}

if (propertyObj.TryGetPropertyValue("type", out typeNode))
{
if (typeNode is JsonArray typeArray)
{
Expand All @@ -387,7 +403,7 @@ static void TransformOpenApi3Object(JsonObject obj)
propertyObj["nullable"] = JsonValue.Create(true);
}
}
else if (typeNode is JsonValue typeValue && typeValue.GetValue<string>() == "array")
else if (typeNode is JsonValue typeVal && typeVal.GetValue<string>() == "array")
{
if (propertyObj.TryGetPropertyValue("items", out JsonNode? itemsNode) && itemsNode is JsonObject itemsObj)
{
Expand Down
Loading