Skip to content

fix(prompt): update OpenAI JSON schema generation for serialization o… #1943

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
grantlerduck wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

fix(prompt): update OpenAI JSON schema generation for serialization o… #1943

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
35 changes: 35 additions & 0 deletions ...i/koog/prompt/executor/clients/openai/base/structure/OpenAIStandardJsonSchemaGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,41 @@ public open class OpenAIStandardJsonSchemaGenerator : StandardJsonSchemaGenerato
throw UnsupportedOperationException("OpenAI JSON schema doesn't support maps")
}

/*
OpenAI strict-mode validators (notably the GPT-5 family) reject nullable arrays encoded as
a type union `{"type": ["array", "null"], "items": {...}}`. Emit `anyOf` instead, which is
accepted by all current OpenAI strict validators. Non-nullable lists are unchanged.
*/
override fun processList(context: GenerationContext): JsonObject {
if (!context.descriptor.isNullable) {
return super.processList(context)
}

val itemDescriptor = context.descriptor.getElementDescriptor(0)
return buildJsonObject {
put(
JsonSchemaConsts.Keys.ANY_OF,
buildJsonArray {
add(
buildJsonObject {
put(JsonSchemaConsts.Keys.TYPE, JsonSchemaConsts.Types.ARRAY)
put(
JsonSchemaConsts.Keys.ITEMS,
process(context.copy(descriptor = itemDescriptor, currentDescription = null))
)
}
)
add(
buildJsonObject {
put(JsonSchemaConsts.Keys.TYPE, JsonSchemaConsts.Types.NULL)
}
)
}
)
context.currentDescription?.let { put(JsonSchemaConsts.Keys.DESCRIPTION, it) }
}
}

override fun processObject(context: GenerationContext): JsonObject {
val refObject = super.processObject(context).toMutableMap()

Expand Down
131 changes: 131 additions & 0 deletions ...ai/koog/prompt/executor/clients/openai/structure/OpenAIStandardJsonSchemaGeneratorTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,137 @@ class OpenAIStandardJsonSchemaGeneratorTest {
}
}

@Serializable
@SerialName("Tag")
data class Tag(
val name: String
)

@Serializable
@SerialName("NullableListContainer")
data class NullableListContainer(
val name: String,
@property:LLMDescription("Optional list of tags")
val tags: List<String>? = null,
@property:LLMDescription("Optional list of complex tags")
val complexTags: List<Tag>? = null
)

@Test
fun testGenerateOpenAIStandardJsonSchemaForNullableLists() {
val result = fullGenerator.generate(
json,
"NullableListContainer",
serializer<NullableListContainer>(),
emptyMap()
)
val schema = json.encodeToString(result.schema)

val expectedSchema = """
{
"${"$"}id": "NullableListContainer",
"${"$"}defs": {
"Tag": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"additionalProperties": false
},
"NullableListContainer": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"description": "Optional list of tags"
},
"complexTags": {
"anyOf": [
{
"type": "array",
"items": {
"${"$"}ref": "#/${"$"}defs/Tag"
}
},
{
"type": "null"
}
],
"description": "Optional list of complex tags"
}
},
"required": [
"name",
"tags",
"complexTags"
],
"additionalProperties": false
}
},
"type": "object",
"properties": {
"name": {
"type": "string"
},
"tags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"description": "Optional list of tags"
},
"complexTags": {
"anyOf": [
{
"type": "array",
"items": {
"${"$"}ref": "#/${"$"}defs/Tag"
}
},
{
"type": "null"
}
],
"description": "Optional list of complex tags"
}
},
"required": [
"name",
"tags",
"complexTags"
],
"additionalProperties": false
}
""".trimIndent()

assertEquals(expectedSchema, schema)
}

@Test
fun testGenerateOpenAIStandardJsonSchemaWeatherForecast() {
val result = fullGenerator.generate(json, "WeatherForecast", serializer<WeatherForecast>(), emptyMap())
Expand Down
Loading