Skip to content

fix(prompt): support Anthropic anyOf tool schemas #2261

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
kyboi wants to merge 1 commit into
base: develop
Choose a base branch
from
+163 −18
Open

fix(prompt): support Anthropic anyOf tool schemas #2261

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
14 changes: 13 additions & 1 deletion ...ent/src/commonMain/kotlin/ai/koog/prompt/executor/clients/anthropic/AnthropicLLMClient.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -786,7 +786,19 @@ public open class AnthropicLLMClient @JvmOverloads constructor(
is ToolParameterType.AnyOf -> {
// FIXME this is hack, represent union types properly in ToolDescriptor
type.hackRepresentAnyOfWithNullAsTypeUnionWithNull(::getTypeMapForParameter)
?: throw LLMClientException(clientName, "AnyOf type is not supported")
?: JsonObject(
mapOf(
"anyOf" to JsonArray(
type.types.map { option ->
val optionSchema = getTypeMapForParameter(option.type).toMutableMap()
if (option.description.isNotBlank()) {
optionSchema["description"] = JsonPrimitive(option.description)
}
JsonObject(optionSchema)
}
)
)
)
}
}
}
Expand Down
167 changes: 150 additions & 17 deletions ...vmTest/kotlin/ai/koog/prompt/executor/clients/anthropic/AnthropicToolSerializationTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import ai.koog.agents.core.tools.ToolDescriptor
import ai.koog.agents.core.tools.ToolParameterDescriptor
import ai.koog.agents.core.tools.ToolParameterType
import ai.koog.prompt.Prompt
import ai.koog.prompt.executor.clients.LLMClientException
import ai.koog.prompt.message.AttachmentContent
import ai.koog.prompt.message.AttachmentSource
import ai.koog.prompt.message.Message
Expand All @@ -17,9 +16,7 @@ import kotlinx.serialization.json.jsonArray
import kotlinx.serialization.json.jsonObject
import kotlinx.serialization.json.jsonPrimitive
import kotlin.test.Test
import kotlin.test.assertContains
import kotlin.test.assertEquals
import kotlin.test.assertFailsWith
import kotlin.test.assertNotNull
import kotlin.test.assertTrue

Expand Down Expand Up @@ -78,7 +75,7 @@ class AnthropicToolSerializationTest {
}

@Test
fun `createAnthropicRequest should throw exception for AnyOf parameter type`() {
fun testCreateAnthropicRequestSerialisesAnyOfParameterType() {
val client = AnthropicLLMClient(apiKey = "test-key")
val model = AnthropicModels.Sonnet_4

Expand All @@ -99,24 +96,160 @@ class AnthropicToolSerializationTest {
)
)

val exception = assertFailsWith<LLMClientException> {
client.createAnthropicRequest(
prompt = Prompt(
messages = emptyList(),
id = "id"
),
tools = listOf(tool),
model = model,
stream = false
val requestJson = client.createAnthropicRequest(
prompt = Prompt(messages = emptyList(), id = "id"),
tools = listOf(tool),
model = model,
stream = false
)

val valueSchema = json.parseToJsonElement(requestJson).jsonObject["tools"]
?.jsonArray?.single()?.jsonObject?.get("input_schema")?.jsonObject
?.get("properties")?.jsonObject?.get("value")?.jsonObject

assertEquals(
json.parseToJsonElement(
"""{
"description":"A value that can be string or number",
"anyOf":[
{"type":"string","description":"String option"},
{"type":"number","description":"Number option"}
]
}"""
).jsonObject,
assertNotNull(valueSchema)
)
}

@Test
fun testCreateAnthropicRequestSerialisesCalculatorNumberOrReferenceAnyOf() {
val client = AnthropicLLMClient(apiKey = "test-key")
val tool = ToolDescriptor(
name = "calculate",
description = "Calculate a value",
requiredParameters = listOf(
ToolParameterDescriptor(
name = "operand",
description = "A number or prior result reference",
type = ToolParameterType.AnyOf(
types = arrayOf(
ToolParameterDescriptor(
name = "number",
description = "Finite numeric literal",
type = ToolParameterType.Float
),
ToolParameterDescriptor(
name = "reference",
description = "Prior-step reference",
type = ToolParameterType.Object(
properties = listOf(
ToolParameterDescriptor(
name = "ref",
description = "Prior successful step ID",
type = ToolParameterType.String
)
),
requiredProperties = listOf("ref"),
additionalProperties = false
)
)
)
)
)
)
}
)

val requestJson = client.createAnthropicRequest(
prompt = Prompt(messages = emptyList(), id = "id"),
tools = listOf(tool),
model = AnthropicModels.Sonnet_4,
stream = false
)

val message = exception.message
val operandSchema = json.parseToJsonElement(requestJson).jsonObject["tools"]
?.jsonArray?.single()?.jsonObject?.get("input_schema")?.jsonObject
?.get("properties")?.jsonObject?.get("operand")?.jsonObject

assertEquals(
json.parseToJsonElement(
"""{
"description":"A number or prior result reference",
"anyOf":[
{"type":"number","description":"Finite numeric literal"},
{
"type":"object",
"properties":{
"ref":{"type":"string","description":"Prior successful step ID"}
},
"required":["ref"],
"additionalProperties":false,
"description":"Prior-step reference"
}
]
}"""
).jsonObject,
assertNotNull(operandSchema)
)
}

assertNotNull(message)
assertContains(message, "AnyOf type is not supported")
@Test
fun testCreateAnthropicRequestPreservesNullableUnion() {
val type = ToolParameterType.AnyOf(
arrayOf(
ToolParameterDescriptor("", "", ToolParameterType.String),
ToolParameterDescriptor("", "", ToolParameterType.Null),
)
)
assertEquals(
json.parseToJsonElement("""{"type":["string","null"],"description":"Value"}"""),
parameterSchema(type),
)
}

@Test
fun testCreateAnthropicRequestSerialisesNestedAnyOfWithoutBlankDescriptions() {
val type = ToolParameterType.AnyOf(
arrayOf(
ToolParameterDescriptor(
"",
" ",
ToolParameterType.AnyOf(
arrayOf(
ToolParameterDescriptor("", "", ToolParameterType.String),
ToolParameterDescriptor("", "", ToolParameterType.Float),
)
)
),
ToolParameterDescriptor("", "", ToolParameterType.Boolean),
)
)
assertEquals(
json.parseToJsonElement(
"""{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"boolean"}],"description":"Value"}"""
),
parameterSchema(type),
)
}

private fun parameterSchema(type: ToolParameterType) =
AnthropicLLMClient(apiKey = "test-key").use { client ->
val request = client.createAnthropicRequest(
prompt = Prompt(messages = emptyList(), id = "anyof-regression"),
tools = listOf(
ToolDescriptor(
name = "test_tool",
description = "Test tool",
requiredParameters = listOf(ToolParameterDescriptor("value", "Value", type)),
)
),
model = AnthropicModels.Sonnet_4,
stream = false,
)
json.parseToJsonElement(request).jsonObject.getValue("tools").jsonArray.single()
.jsonObject.getValue("input_schema").jsonObject.getValue("properties")
.jsonObject.getValue("value")
}

@Test
fun `createAnthropicRequest should handle multiple parameter types including Null`() {
val client = AnthropicLLMClient(apiKey = "test-key")
Expand Down