Skip to content

fix(prompt): keep requiredProperties of nested objects in OpenAI-compatible tool schema #2256

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
Aditya Nikam (adityaanikam) wants to merge 1 commit into
base: develop
Choose a base branch
from
+74 −2
Open

fix(prompt): keep requiredProperties of nested objects in OpenAI-compatible tool schema #2256

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
5 changes: 5 additions & 0 deletions ...koog/prompt/executor/clients/openai/base/OpenAICompatibleToolDescriptorSchemaGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,11 @@ public open class OpenAICompatibleToolDescriptorSchemaGenerator : ToolDescriptor
}
}
}
if (type.requiredProperties.isNotEmpty()) {
putJsonArray("required") {
type.requiredProperties.forEach { add(it) }
}
}
}

is ToolParameterType.AnyOf -> {
Expand Down
71 changes: 69 additions & 2 deletions ...i/koog/prompt/executor/clients/openai/base/OpenAICompatibleToolDescriptorConverterTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ class OpenAICompatibleToolDescriptorConverterTest {

val actual = json.encodeToString(OpenAICompatibleToolDescriptorSchemaGenerator().generate(descriptor))

// Note: OpenAI converter does not emit "required" inside nested object; it preserves order: type, additionalProperties, properties
// Note: the converter preserves order: type, additionalProperties, properties, required
val expected = """
{
"type": "object",
Expand All @@ -176,7 +176,10 @@ class OpenAICompatibleToolDescriptorConverterTest {
"type": "number",
"description": "Threshold value"
}
}
},
"required": [
"enabled"
]
}
},
"required": [
Expand All @@ -188,6 +191,70 @@ class OpenAICompatibleToolDescriptorConverterTest {
assertEquals(expected, actual)
}

@Test
fun testNestedObjectInListKeepsRequiredProperties() {
val descriptor = ToolDescriptor(
name = "add_events",
description = "Add events",
requiredParameters = listOf(
ToolParameterDescriptor(
name = "events",
description = "Events to add",
type = ToolParameterType.List(
ToolParameterType.Object(
properties = listOf(
ToolParameterDescriptor("type", "Event type", ToolParameterType.String),
ToolParameterDescriptor("at", "YYYY-MM", ToolParameterType.String),
ToolParameterDescriptor("note", "Optional note", ToolParameterType.String),
),
requiredProperties = listOf("type", "at"),
)
)
)
)
)

val actual = json.encodeToString(OpenAICompatibleToolDescriptorSchemaGenerator().generate(descriptor))

val expected = """
{
"type": "object",
"properties": {
"events": {
"description": "Events to add",
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Event type"
},
"at": {
"type": "string",
"description": "YYYY-MM"
},
"note": {
"type": "string",
"description": "Optional note"
}
},
"required": [
"type",
"at"
]
}
}
},
"required": [
"events"
]
}
""".trimIndent()

assertEquals(expected, actual)
}

@Test
fun anyOf_mapping() {
val descriptor = ToolDescriptor(
Expand Down