Skip to content

fix: prevent empty WebSearch.action when maxToolCalls is exceeded (#600) #627

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

fix: prevent empty WebSearch.action when maxToolCalls is exceeded (#600) #627

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
11 changes: 10 additions & 1 deletion openai-java-core/src/main/kotlin/com/openai/models/responses/ResponseFunctionWebSearch.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,15 @@ private constructor(
*/
fun action(): Action = action.getRequired("action")

/**
* Returns the action if present.
*
* Unlike [action], this method returns an empty optional when the server omits the field,
* allowing callers to gracefully handle scenarios where the model did not provide tool
* parameters (for example, when `maxToolCalls` limits are reached).
*/
fun actionOptional(): Optional<Action> = action.getOptional("action")

/**
* The status of the web search tool call.
*
Expand Down Expand Up @@ -287,7 +296,7 @@ private constructor(
}

id()
action().validate()
action.getOptional("action").ifPresent { it.validate() }
status().validate()
_type().let {
if (it != JsonValue.from("web_search_call")) {
Expand Down
17 changes: 17 additions & 0 deletions ...ai-java-core/src/test/kotlin/com/openai/models/responses/ResponseFunctionWebSearchTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package com.openai.models.responses
import com.fasterxml.jackson.module.kotlin.jacksonTypeRef
import com.openai.core.jsonMapper
import org.assertj.core.api.Assertions.assertThat
import org.assertj.core.api.Assertions.assertThatCode
import org.junit.jupiter.api.Test

internal class ResponseFunctionWebSearchTest {
Expand Down Expand Up @@ -72,4 +73,20 @@ internal class ResponseFunctionWebSearchTest {

assertThat(roundtrippedResponseFunctionWebSearch).isEqualTo(responseFunctionWebSearch)
}

@Test
fun deserializeWithoutAction() {
val jsonMapper = jsonMapper()
val payload = """
{"id":"ws_missing","status":"completed","type":"web_search_call"}
""".trimIndent()

val responseFunctionWebSearch =
jsonMapper.readValue(payload, jacksonTypeRef<ResponseFunctionWebSearch>())

assertThat(responseFunctionWebSearch.actionOptional()).isEmpty
assertThat(responseFunctionWebSearch.status())
.isEqualTo(ResponseFunctionWebSearch.Status.COMPLETED)
assertThatCode { responseFunctionWebSearch.validate() }.doesNotThrowAnyException()
}
}