().configureEach {
+ isZip64 = true
}
diff --git a/scripts/build b/scripts/build
index f406348..16a2b00 100755
--- a/scripts/build
+++ b/scripts/build
@@ -5,4 +5,4 @@ set -e
cd "$(dirname "$0")/.."
echo "==> Building classes"
-./gradlew build testClasses -x test
+./gradlew build testClasses "$@" -x test
diff --git a/scripts/upload-artifacts b/scripts/upload-artifacts
index 729e6f2..10f3c70 100755
--- a/scripts/upload-artifacts
+++ b/scripts/upload-artifacts
@@ -7,6 +7,8 @@ GREEN='\033[32m'
RED='\033[31m'
NC='\033[0m' # No Color
+MAVEN_REPO_PATH="./build/local-maven-repo"
+
log_error() {
local msg="$1"
local headers="$2"
@@ -24,7 +26,7 @@ upload_file() {
if [ -f "$file_name" ]; then
echo -e "${GREEN}Processing file: $file_name${NC}"
- pkg_file_name="mvn${file_name#./build/local-maven-repo}"
+ pkg_file_name="mvn${file_name#"${MAVEN_REPO_PATH}"}"
# Get signed URL for uploading artifact file
signed_url_response=$(curl -X POST -G "$URL" \
@@ -47,18 +49,20 @@ upload_file() {
md5|sha1|sha256|sha512) content_type="text/plain" ;;
module) content_type="application/json" ;;
pom|xml) content_type="application/xml" ;;
+ html) content_type="text/html" ;;
*) content_type="application/octet-stream" ;;
esac
# Upload file
upload_response=$(curl -v -X PUT \
--retry 5 \
+ --retry-all-errors \
-D "$tmp_headers" \
-H "Content-Type: $content_type" \
--data-binary "@${file_name}" "$signed_url" 2>&1)
if ! echo "$upload_response" | grep -q "HTTP/[0-9.]* 200"; then
- log_error "Failed upload artifact file" "$tmp_headers" "$upload_response"
+ log_error "Failed to upload artifact file" "$tmp_headers" "$upload_response"
fi
# Insert small throttle to reduce rate limiting risk
@@ -81,6 +85,99 @@ walk_tree() {
done
}
+generate_instructions() {
+ cat << EOF > "$MAVEN_REPO_PATH/index.html"
+
+
+
+ Maven Repo
+
+
+ Stainless SDK Maven Repository
+ This is the Maven repository for your Stainless Java SDK build.
+
+ Project configuration
+
+ The details depend on whether you're using Maven or Gradle as your build tool.
+
+ Maven
+
+ Add the following to your project's pom.xml:
+ <repositories>
+ <repository>
+ <id>stainless-sdk-repo</id>
+ <url>https://pkg.stainless.com/s/${PROJECT}/${SHA}/mvn</url>
+ </repository>
+</repositories>
+
+ Gradle
+ Add the following to your build.gradle file:
+ repositories {
+ maven {
+ url "https://pkg.stainless.com/s/${PROJECT}/${SHA}/mvn"
+ }
+}
+
+
+ Configuring authentication (if required)
+
+ Some accounts may require authentication to access the repository. If so, use the
+ following instructions, replacing YOUR_STAINLESS_API_TOKEN with your actual token.
+
+ Maven with authentication
+
+ First, ensure you have the following in your Maven settings.xml for repo authentication:
+ <servers>
+ <server>
+ <id>stainless-sdk-repo</id>
+ <configuration>
+ <httpHeaders>
+ <property>
+ <name>Authorization</name>
+ <value>Bearer YOUR_STAINLESS_API_TOKEN</value>
+ </property>
+ </httpHeaders>
+ </configuration>
+ </server>
+</servers>
+
+ Then, add the following to your project's pom.xml:
+ <repositories>
+ <repository>
+ <id>stainless-sdk-repo</id>
+ <url>https://pkg.stainless.com/s/${PROJECT}/${SHA}/mvn</url>
+ </repository>
+</repositories>
+
+ Gradle with authentication
+ Add the following to your build.gradle file:
+ repositories {
+ maven {
+ url "https://pkg.stainless.com/s/${PROJECT}/${SHA}/mvn"
+ credentials(HttpHeaderCredentials) {
+ name = "Authorization"
+ value = "Bearer YOUR_STAINLESS_API_TOKEN"
+ }
+ authentication {
+ header(HttpHeaderAuthentication)
+ }
+ }
+}
+
+
+ Using the repository
+ Once you've configured the repository, you can include dependencies from it as usual. See your
+ project README
+ for more details.
+
+
+EOF
+ upload_file "${MAVEN_REPO_PATH}/index.html"
+
+ echo "Configure maven or gradle to use the repo located at 'https://pkg.stainless.com/s/${PROJECT}/${SHA}/mvn'"
+ echo "For more details, see the directions in https://pkg.stainless.com/s/${PROJECT}/${SHA}/mvn/index.html"
+}
+
cd "$(dirname "$0")/.."
echo "::group::Creating local Maven content"
@@ -88,9 +185,9 @@ echo "::group::Creating local Maven content"
echo "::endgroup::"
echo "::group::Uploading to pkg.stainless.com"
-walk_tree "./build/local-maven-repo"
+walk_tree "$MAVEN_REPO_PATH"
echo "::endgroup::"
echo "::group::Generating instructions"
-echo "Configure maven or gradle to use the repo located at 'https://pkg.stainless.com/s/${PROJECT}/${SHA}/mvn'"
+generate_instructions
echo "::endgroup::"
diff --git a/stagehand-java-client-okhttp/src/main/kotlin/com/browserbase/api/client/okhttp/OkHttpClient.kt b/stagehand-java-client-okhttp/src/main/kotlin/com/browserbase/api/client/okhttp/OkHttpClient.kt
index 116714c..dadd500 100644
--- a/stagehand-java-client-okhttp/src/main/kotlin/com/browserbase/api/client/okhttp/OkHttpClient.kt
+++ b/stagehand-java-client-okhttp/src/main/kotlin/com/browserbase/api/client/okhttp/OkHttpClient.kt
@@ -234,6 +234,8 @@ private constructor(@JvmSynthetic internal val okHttpClient: okhttp3.OkHttpClien
fun build(): OkHttpClient =
OkHttpClient(
okhttp3.OkHttpClient.Builder()
+ // `RetryingHttpClient` handles retries if the user enabled them.
+ .retryOnConnectionFailure(false)
.connectTimeout(timeout.connect())
.readTimeout(timeout.read())
.writeTimeout(timeout.write())
diff --git a/stagehand-java-core/build.gradle.kts b/stagehand-java-core/build.gradle.kts
index 38bcf47..3cfe35b 100644
--- a/stagehand-java-core/build.gradle.kts
+++ b/stagehand-java-core/build.gradle.kts
@@ -5,14 +5,16 @@ plugins {
configurations.all {
resolutionStrategy {
- // Compile and test against a lower Jackson version to ensure we're compatible with it.
- // We publish with a higher version (see below) to ensure users depend on a secure version by default.
- force("com.fasterxml.jackson.core:jackson-core:2.13.4")
- force("com.fasterxml.jackson.core:jackson-databind:2.13.4")
- force("com.fasterxml.jackson.core:jackson-annotations:2.13.4")
- force("com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.13.4")
- force("com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.13.4")
- force("com.fasterxml.jackson.module:jackson-module-kotlin:2.13.4")
+ // Compile and test against a lower Jackson version to ensure we're compatible with it. Note that
+ // we generally support 2.13.4, but test against 2.14.0 because 2.13.4 has some annoying (but
+ // niche) bugs (users should upgrade if they encounter them). We publish with a higher version
+ // (see below) to ensure users depend on a secure version by default.
+ force("com.fasterxml.jackson.core:jackson-core:2.14.0")
+ force("com.fasterxml.jackson.core:jackson-databind:2.14.0")
+ force("com.fasterxml.jackson.core:jackson-annotations:2.14.0")
+ force("com.fasterxml.jackson.datatype:jackson-datatype-jdk8:2.14.0")
+ force("com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.14.0")
+ force("com.fasterxml.jackson.module:jackson-module-kotlin:2.14.0")
}
}
diff --git a/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/ClientOptions.kt b/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/ClientOptions.kt
index 732c468..8b1c7f0 100644
--- a/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/ClientOptions.kt
+++ b/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/ClientOptions.kt
@@ -484,6 +484,7 @@ private constructor(
headers.put("X-Stainless-Package-Version", getPackageVersion())
headers.put("X-Stainless-Runtime", "JRE")
headers.put("X-Stainless-Runtime-Version", getJavaVersion())
+ headers.put("X-Stainless-Kotlin-Version", KotlinVersion.CURRENT.toString())
browserbaseApiKey.let {
if (!it.isEmpty()) {
headers.put("x-bb-api-key", it)
diff --git a/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/ObjectMappers.kt b/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/ObjectMappers.kt
index 9ed574e..5200d47 100644
--- a/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/ObjectMappers.kt
+++ b/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/ObjectMappers.kt
@@ -24,7 +24,8 @@ import java.io.InputStream
import java.time.DateTimeException
import java.time.LocalDate
import java.time.LocalDateTime
-import java.time.ZonedDateTime
+import java.time.OffsetDateTime
+import java.time.ZoneId
import java.time.format.DateTimeFormatter
import java.time.temporal.ChronoField
@@ -36,7 +37,7 @@ fun jsonMapper(): JsonMapper =
.addModule(
SimpleModule()
.addSerializer(InputStreamSerializer)
- .addDeserializer(LocalDateTime::class.java, LenientLocalDateTimeDeserializer())
+ .addDeserializer(OffsetDateTime::class.java, LenientOffsetDateTimeDeserializer())
)
.withCoercionConfig(LogicalType.Boolean) {
it.setCoercion(CoercionInputShape.Integer, CoercionAction.Fail)
@@ -47,6 +48,7 @@ fun jsonMapper(): JsonMapper =
}
.withCoercionConfig(LogicalType.Integer) {
it.setCoercion(CoercionInputShape.Boolean, CoercionAction.Fail)
+ .setCoercion(CoercionInputShape.Float, CoercionAction.Fail)
.setCoercion(CoercionInputShape.String, CoercionAction.Fail)
.setCoercion(CoercionInputShape.Array, CoercionAction.Fail)
.setCoercion(CoercionInputShape.Object, CoercionAction.Fail)
@@ -64,6 +66,12 @@ fun jsonMapper(): JsonMapper =
.setCoercion(CoercionInputShape.Array, CoercionAction.Fail)
.setCoercion(CoercionInputShape.Object, CoercionAction.Fail)
}
+ .withCoercionConfig(LogicalType.DateTime) {
+ it.setCoercion(CoercionInputShape.Integer, CoercionAction.Fail)
+ .setCoercion(CoercionInputShape.Float, CoercionAction.Fail)
+ .setCoercion(CoercionInputShape.Array, CoercionAction.Fail)
+ .setCoercion(CoercionInputShape.Object, CoercionAction.Fail)
+ }
.withCoercionConfig(LogicalType.Array) {
it.setCoercion(CoercionInputShape.Boolean, CoercionAction.Fail)
.setCoercion(CoercionInputShape.Integer, CoercionAction.Fail)
@@ -124,10 +132,10 @@ private object InputStreamSerializer : BaseSerializer(InputStream::
}
/**
- * A deserializer that can deserialize [LocalDateTime] from datetimes, dates, and zoned datetimes.
+ * A deserializer that can deserialize [OffsetDateTime] from datetimes, dates, and zoned datetimes.
*/
-private class LenientLocalDateTimeDeserializer :
- StdDeserializer(LocalDateTime::class.java) {
+private class LenientOffsetDateTimeDeserializer :
+ StdDeserializer(OffsetDateTime::class.java) {
companion object {
@@ -141,7 +149,7 @@ private class LenientLocalDateTimeDeserializer :
override fun logicalType(): LogicalType = LogicalType.DateTime
- override fun deserialize(p: JsonParser, context: DeserializationContext?): LocalDateTime {
+ override fun deserialize(p: JsonParser, context: DeserializationContext): OffsetDateTime {
val exceptions = mutableListOf()
for (formatter in DATE_TIME_FORMATTERS) {
@@ -150,17 +158,20 @@ private class LenientLocalDateTimeDeserializer :
return when {
!temporal.isSupported(ChronoField.HOUR_OF_DAY) ->
- LocalDate.from(temporal).atStartOfDay()
+ LocalDate.from(temporal)
+ .atStartOfDay()
+ .atZone(ZoneId.of("UTC"))
+ .toOffsetDateTime()
!temporal.isSupported(ChronoField.OFFSET_SECONDS) ->
- LocalDateTime.from(temporal)
- else -> ZonedDateTime.from(temporal).toLocalDateTime()
+ LocalDateTime.from(temporal).atZone(ZoneId.of("UTC")).toOffsetDateTime()
+ else -> OffsetDateTime.from(temporal)
}
} catch (e: DateTimeException) {
exceptions.add(e)
}
}
- throw JsonParseException(p, "Cannot parse `LocalDateTime` from value: ${p.text}").apply {
+ throw JsonParseException(p, "Cannot parse `OffsetDateTime` from value: ${p.text}").apply {
exceptions.forEach { addSuppressed(it) }
}
}
diff --git a/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/handlers/SseHandler.kt b/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/handlers/SseHandler.kt
index 039faae..f8e870e 100644
--- a/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/handlers/SseHandler.kt
+++ b/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/handlers/SseHandler.kt
@@ -28,7 +28,7 @@ internal fun sseHandler(jsonMapper: JsonMapper): Handler {
+ message.data.startsWith("{\"data\":{\"status\":\"finished\"") -> {
// In this case we don't break because we still want to iterate through the full
// stream.
done = true
diff --git a/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/http/RetryingHttpClient.kt b/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/http/RetryingHttpClient.kt
index 7e1a7aa..1305c6a 100644
--- a/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/http/RetryingHttpClient.kt
+++ b/stagehand-java-core/src/main/kotlin/com/browserbase/api/core/http/RetryingHttpClient.kt
@@ -31,10 +31,6 @@ private constructor(
) : HttpClient {
override fun execute(request: HttpRequest, requestOptions: RequestOptions): HttpResponse {
- if (!isRetryable(request) || maxRetries <= 0) {
- return httpClient.execute(request, requestOptions)
- }
-
var modifiedRequest = maybeAddIdempotencyHeader(request)
// Don't send the current retry count in the headers if the caller set their own value.
@@ -48,6 +44,10 @@ private constructor(
modifiedRequest = setRetryCountHeader(modifiedRequest, retries)
}
+ if (!isRetryable(modifiedRequest)) {
+ return httpClient.execute(modifiedRequest, requestOptions)
+ }
+
val response =
try {
val response = httpClient.execute(modifiedRequest, requestOptions)
@@ -75,10 +75,6 @@ private constructor(
request: HttpRequest,
requestOptions: RequestOptions,
): CompletableFuture {
- if (!isRetryable(request) || maxRetries <= 0) {
- return httpClient.executeAsync(request, requestOptions)
- }
-
val modifiedRequest = maybeAddIdempotencyHeader(request)
// Don't send the current retry count in the headers if the caller set their own value.
@@ -94,8 +90,12 @@ private constructor(
val requestWithRetryCount =
if (shouldSendRetryCount) setRetryCountHeader(request, retries) else request
- return httpClient
- .executeAsync(requestWithRetryCount, requestOptions)
+ val responseFuture = httpClient.executeAsync(requestWithRetryCount, requestOptions)
+ if (!isRetryable(requestWithRetryCount)) {
+ return responseFuture
+ }
+
+ return responseFuture
.handleAsync(
fun(
response: HttpResponse?,
diff --git a/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/ModelConfig.kt b/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/ModelConfig.kt
index ce0785b..49a3d65 100644
--- a/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/ModelConfig.kt
+++ b/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/ModelConfig.kt
@@ -2,449 +2,372 @@
package com.browserbase.api.models.sessions
-import com.browserbase.api.core.BaseDeserializer
-import com.browserbase.api.core.BaseSerializer
import com.browserbase.api.core.Enum
import com.browserbase.api.core.ExcludeMissing
import com.browserbase.api.core.JsonField
import com.browserbase.api.core.JsonMissing
import com.browserbase.api.core.JsonValue
-import com.browserbase.api.core.allMaxBy
import com.browserbase.api.core.checkRequired
-import com.browserbase.api.core.getOrThrow
import com.browserbase.api.errors.StagehandInvalidDataException
import com.fasterxml.jackson.annotation.JsonAnyGetter
import com.fasterxml.jackson.annotation.JsonAnySetter
import com.fasterxml.jackson.annotation.JsonCreator
import com.fasterxml.jackson.annotation.JsonProperty
-import com.fasterxml.jackson.core.JsonGenerator
-import com.fasterxml.jackson.core.ObjectCodec
-import com.fasterxml.jackson.databind.JsonNode
-import com.fasterxml.jackson.databind.SerializerProvider
-import com.fasterxml.jackson.databind.annotation.JsonDeserialize
-import com.fasterxml.jackson.databind.annotation.JsonSerialize
-import com.fasterxml.jackson.module.kotlin.jacksonTypeRef
import java.util.Collections
import java.util.Objects
import java.util.Optional
import kotlin.jvm.optionals.getOrNull
-/**
- * Model name string with provider prefix (e.g., 'openai/gpt-5-nano', 'anthropic/claude-4.5-opus')
- */
-@JsonDeserialize(using = ModelConfig.Deserializer::class)
-@JsonSerialize(using = ModelConfig.Serializer::class)
class ModelConfig
+@JsonCreator(mode = JsonCreator.Mode.DISABLED)
private constructor(
- private val name: String? = null,
- private val modelConfigObject: ModelConfigObject? = null,
- private val _json: JsonValue? = null,
+ private val modelName: JsonField,
+ private val apiKey: JsonField,
+ private val baseUrl: JsonField,
+ private val provider: JsonField,
+ private val additionalProperties: MutableMap,
) {
+ @JsonCreator
+ private constructor(
+ @JsonProperty("modelName") @ExcludeMissing modelName: JsonField = JsonMissing.of(),
+ @JsonProperty("apiKey") @ExcludeMissing apiKey: JsonField = JsonMissing.of(),
+ @JsonProperty("baseURL") @ExcludeMissing baseUrl: JsonField = JsonMissing.of(),
+ @JsonProperty("provider") @ExcludeMissing provider: JsonField = JsonMissing.of(),
+ ) : this(modelName, apiKey, baseUrl, provider, mutableMapOf())
+
/**
- * Model name string with provider prefix (e.g., 'openai/gpt-5-nano',
- * 'anthropic/claude-4.5-opus')
+ * Model name string with provider prefix (e.g., 'openai/gpt-5-nano')
+ *
+ * @throws StagehandInvalidDataException if the JSON field has an unexpected type or is
+ * unexpectedly missing or null (e.g. if the server responded with an unexpected value).
*/
- fun name(): Optional = Optional.ofNullable(name)
-
- fun modelConfigObject(): Optional = Optional.ofNullable(modelConfigObject)
-
- fun isName(): Boolean = name != null
-
- fun isModelConfigObject(): Boolean = modelConfigObject != null
+ fun modelName(): String = modelName.getRequired("modelName")
/**
- * Model name string with provider prefix (e.g., 'openai/gpt-5-nano',
- * 'anthropic/claude-4.5-opus')
+ * API key for the model provider
+ *
+ * @throws StagehandInvalidDataException if the JSON field has an unexpected type (e.g. if the
+ * server responded with an unexpected value).
*/
- fun asName(): String = name.getOrThrow("name")
-
- fun asModelConfigObject(): ModelConfigObject = modelConfigObject.getOrThrow("modelConfigObject")
-
- fun _json(): Optional = Optional.ofNullable(_json)
+ fun apiKey(): Optional = apiKey.getOptional("apiKey")
- fun accept(visitor: Visitor): T =
- when {
- name != null -> visitor.visitName(name)
- modelConfigObject != null -> visitor.visitModelConfigObject(modelConfigObject)
- else -> visitor.unknown(_json)
- }
-
- private var validated: Boolean = false
+ /**
+ * Base URL for the model provider
+ *
+ * @throws StagehandInvalidDataException if the JSON field has an unexpected type (e.g. if the
+ * server responded with an unexpected value).
+ */
+ fun baseUrl(): Optional = baseUrl.getOptional("baseURL")
- fun validate(): ModelConfig = apply {
- if (validated) {
- return@apply
- }
+ /**
+ * AI provider for the model (or provide a baseURL endpoint instead)
+ *
+ * @throws StagehandInvalidDataException if the JSON field has an unexpected type (e.g. if the
+ * server responded with an unexpected value).
+ */
+ fun provider(): Optional = provider.getOptional("provider")
- accept(
- object : Visitor {
- override fun visitName(name: String) {}
+ /**
+ * Returns the raw JSON value of [modelName].
+ *
+ * Unlike [modelName], this method doesn't throw if the JSON field has an unexpected type.
+ */
+ @JsonProperty("modelName") @ExcludeMissing fun _modelName(): JsonField = modelName
- override fun visitModelConfigObject(modelConfigObject: ModelConfigObject) {
- modelConfigObject.validate()
- }
- }
- )
- validated = true
- }
+ /**
+ * Returns the raw JSON value of [apiKey].
+ *
+ * Unlike [apiKey], this method doesn't throw if the JSON field has an unexpected type.
+ */
+ @JsonProperty("apiKey") @ExcludeMissing fun _apiKey(): JsonField = apiKey
- fun isValid(): Boolean =
- try {
- validate()
- true
- } catch (e: StagehandInvalidDataException) {
- false
- }
+ /**
+ * Returns the raw JSON value of [baseUrl].
+ *
+ * Unlike [baseUrl], this method doesn't throw if the JSON field has an unexpected type.
+ */
+ @JsonProperty("baseURL") @ExcludeMissing fun _baseUrl(): JsonField = baseUrl
/**
- * Returns a score indicating how many valid values are contained in this object recursively.
+ * Returns the raw JSON value of [provider].
*
- * Used for best match union deserialization.
+ * Unlike [provider], this method doesn't throw if the JSON field has an unexpected type.
*/
- @JvmSynthetic
- internal fun validity(): Int =
- accept(
- object : Visitor {
- override fun visitName(name: String) = 1
+ @JsonProperty("provider") @ExcludeMissing fun _provider(): JsonField = provider
- override fun visitModelConfigObject(modelConfigObject: ModelConfigObject) =
- modelConfigObject.validity()
+ @JsonAnySetter
+ private fun putAdditionalProperty(key: String, value: JsonValue) {
+ additionalProperties.put(key, value)
+ }
- override fun unknown(json: JsonValue?) = 0
- }
- )
+ @JsonAnyGetter
+ @ExcludeMissing
+ fun _additionalProperties(): Map =
+ Collections.unmodifiableMap(additionalProperties)
- override fun equals(other: Any?): Boolean {
- if (this === other) {
- return true
- }
+ fun toBuilder() = Builder().from(this)
- return other is ModelConfig &&
- name == other.name &&
- modelConfigObject == other.modelConfigObject
+ companion object {
+
+ /**
+ * Returns a mutable builder for constructing an instance of [ModelConfig].
+ *
+ * The following fields are required:
+ * ```java
+ * .modelName()
+ * ```
+ */
+ @JvmStatic fun builder() = Builder()
}
- override fun hashCode(): Int = Objects.hash(name, modelConfigObject)
+ /** A builder for [ModelConfig]. */
+ class Builder internal constructor() {
+
+ private var modelName: JsonField? = null
+ private var apiKey: JsonField = JsonMissing.of()
+ private var baseUrl: JsonField = JsonMissing.of()
+ private var provider: JsonField = JsonMissing.of()
+ private var additionalProperties: MutableMap = mutableMapOf()
- override fun toString(): String =
- when {
- name != null -> "ModelConfig{name=$name}"
- modelConfigObject != null -> "ModelConfig{modelConfigObject=$modelConfigObject}"
- _json != null -> "ModelConfig{_unknown=$_json}"
- else -> throw IllegalStateException("Invalid ModelConfig")
+ @JvmSynthetic
+ internal fun from(modelConfig: ModelConfig) = apply {
+ modelName = modelConfig.modelName
+ apiKey = modelConfig.apiKey
+ baseUrl = modelConfig.baseUrl
+ provider = modelConfig.provider
+ additionalProperties = modelConfig.additionalProperties.toMutableMap()
}
- companion object {
+ /** Model name string with provider prefix (e.g., 'openai/gpt-5-nano') */
+ fun modelName(modelName: String) = modelName(JsonField.of(modelName))
/**
- * Model name string with provider prefix (e.g., 'openai/gpt-5-nano',
- * 'anthropic/claude-4.5-opus')
+ * Sets [Builder.modelName] to an arbitrary JSON value.
+ *
+ * You should usually call [Builder.modelName] with a well-typed [String] value instead.
+ * This method is primarily for setting the field to an undocumented or not yet supported
+ * value.
*/
- @JvmStatic fun ofName(name: String) = ModelConfig(name = name)
+ fun modelName(modelName: JsonField) = apply { this.modelName = modelName }
- @JvmStatic
- fun ofModelConfigObject(modelConfigObject: ModelConfigObject) =
- ModelConfig(modelConfigObject = modelConfigObject)
- }
-
- /**
- * An interface that defines how to map each variant of [ModelConfig] to a value of type [T].
- */
- interface Visitor {
+ /** API key for the model provider */
+ fun apiKey(apiKey: String) = apiKey(JsonField.of(apiKey))
/**
- * Model name string with provider prefix (e.g., 'openai/gpt-5-nano',
- * 'anthropic/claude-4.5-opus')
+ * Sets [Builder.apiKey] to an arbitrary JSON value.
+ *
+ * You should usually call [Builder.apiKey] with a well-typed [String] value instead. This
+ * method is primarily for setting the field to an undocumented or not yet supported value.
*/
- fun visitName(name: String): T
+ fun apiKey(apiKey: JsonField) = apply { this.apiKey = apiKey }
- fun visitModelConfigObject(modelConfigObject: ModelConfigObject): T
+ /** Base URL for the model provider */
+ fun baseUrl(baseUrl: String) = baseUrl(JsonField.of(baseUrl))
/**
- * Maps an unknown variant of [ModelConfig] to a value of type [T].
+ * Sets [Builder.baseUrl] to an arbitrary JSON value.
*
- * An instance of [ModelConfig] can contain an unknown variant if it was deserialized from
- * data that doesn't match any known variant. For example, if the SDK is on an older version
- * than the API, then the API may respond with new variants that the SDK is unaware of.
+ * You should usually call [Builder.baseUrl] with a well-typed [String] value instead. This
+ * method is primarily for setting the field to an undocumented or not yet supported value.
+ */
+ fun baseUrl(baseUrl: JsonField) = apply { this.baseUrl = baseUrl }
+
+ /** AI provider for the model (or provide a baseURL endpoint instead) */
+ fun provider(provider: Provider) = provider(JsonField.of(provider))
+
+ /**
+ * Sets [Builder.provider] to an arbitrary JSON value.
*
- * @throws StagehandInvalidDataException in the default implementation.
+ * You should usually call [Builder.provider] with a well-typed [Provider] value instead.
+ * This method is primarily for setting the field to an undocumented or not yet supported
+ * value.
*/
- fun unknown(json: JsonValue?): T {
- throw StagehandInvalidDataException("Unknown ModelConfig: $json")
+ fun provider(provider: JsonField) = apply { this.provider = provider }
+
+ fun additionalProperties(additionalProperties: Map) = apply {
+ this.additionalProperties.clear()
+ putAllAdditionalProperties(additionalProperties)
}
- }
- internal class Deserializer : BaseDeserializer(ModelConfig::class) {
-
- override fun ObjectCodec.deserialize(node: JsonNode): ModelConfig {
- val json = JsonValue.fromJsonNode(node)
-
- val bestMatches =
- sequenceOf(
- tryDeserialize(node, jacksonTypeRef())?.let {
- ModelConfig(modelConfigObject = it, _json = json)
- },
- tryDeserialize(node, jacksonTypeRef())?.let {
- ModelConfig(name = it, _json = json)
- },
- )
- .filterNotNull()
- .allMaxBy { it.validity() }
- .toList()
- return when (bestMatches.size) {
- // This can happen if what we're deserializing is completely incompatible with all
- // the possible variants (e.g. deserializing from array).
- 0 -> ModelConfig(_json = json)
- 1 -> bestMatches.single()
- // If there's more than one match with the highest validity, then use the first
- // completely valid match, or simply the first match if none are completely valid.
- else -> bestMatches.firstOrNull { it.isValid() } ?: bestMatches.first()
- }
+ fun putAdditionalProperty(key: String, value: JsonValue) = apply {
+ additionalProperties.put(key, value)
}
- }
- internal class Serializer : BaseSerializer(ModelConfig::class) {
-
- override fun serialize(
- value: ModelConfig,
- generator: JsonGenerator,
- provider: SerializerProvider,
- ) {
- when {
- value.name != null -> generator.writeObject(value.name)
- value.modelConfigObject != null -> generator.writeObject(value.modelConfigObject)
- value._json != null -> generator.writeObject(value._json)
- else -> throw IllegalStateException("Invalid ModelConfig")
- }
+ fun putAllAdditionalProperties(additionalProperties: Map) = apply {
+ this.additionalProperties.putAll(additionalProperties)
}
- }
- class ModelConfigObject
- @JsonCreator(mode = JsonCreator.Mode.DISABLED)
- private constructor(
- private val modelName: JsonField,
- private val apiKey: JsonField,
- private val baseUrl: JsonField,
- private val provider: JsonField,
- private val additionalProperties: MutableMap,
- ) {
-
- @JsonCreator
- private constructor(
- @JsonProperty("modelName")
- @ExcludeMissing
- modelName: JsonField = JsonMissing.of(),
- @JsonProperty("apiKey") @ExcludeMissing apiKey: JsonField = JsonMissing.of(),
- @JsonProperty("baseURL") @ExcludeMissing baseUrl: JsonField = JsonMissing.of(),
- @JsonProperty("provider")
- @ExcludeMissing
- provider: JsonField = JsonMissing.of(),
- ) : this(modelName, apiKey, baseUrl, provider, mutableMapOf())
+ fun removeAdditionalProperty(key: String) = apply { additionalProperties.remove(key) }
- /**
- * Model name string (e.g., 'openai/gpt-5-nano', 'anthropic/claude-4.5-opus')
- *
- * @throws StagehandInvalidDataException if the JSON field has an unexpected type or is
- * unexpectedly missing or null (e.g. if the server responded with an unexpected value).
- */
- fun modelName(): String = modelName.getRequired("modelName")
+ fun removeAllAdditionalProperties(keys: Set) = apply {
+ keys.forEach(::removeAdditionalProperty)
+ }
/**
- * API key for the model provider
+ * Returns an immutable instance of [ModelConfig].
*
- * @throws StagehandInvalidDataException if the JSON field has an unexpected type (e.g. if
- * the server responded with an unexpected value).
- */
- fun apiKey(): Optional = apiKey.getOptional("apiKey")
-
- /**
- * Base URL for the model provider
+ * Further updates to this [Builder] will not mutate the returned instance.
*
- * @throws StagehandInvalidDataException if the JSON field has an unexpected type (e.g. if
- * the server responded with an unexpected value).
- */
- fun baseUrl(): Optional = baseUrl.getOptional("baseURL")
-
- /**
- * AI provider for the model (or provide a baseURL endpoint instead)
+ * The following fields are required:
+ * ```java
+ * .modelName()
+ * ```
*
- * @throws StagehandInvalidDataException if the JSON field has an unexpected type (e.g. if
- * the server responded with an unexpected value).
+ * @throws IllegalStateException if any required field is unset.
*/
- fun provider(): Optional = provider.getOptional("provider")
+ fun build(): ModelConfig =
+ ModelConfig(
+ checkRequired("modelName", modelName),
+ apiKey,
+ baseUrl,
+ provider,
+ additionalProperties.toMutableMap(),
+ )
+ }
- /**
- * Returns the raw JSON value of [modelName].
- *
- * Unlike [modelName], this method doesn't throw if the JSON field has an unexpected type.
- */
- @JsonProperty("modelName") @ExcludeMissing fun _modelName(): JsonField = modelName
+ private var validated: Boolean = false
- /**
- * Returns the raw JSON value of [apiKey].
- *
- * Unlike [apiKey], this method doesn't throw if the JSON field has an unexpected type.
- */
- @JsonProperty("apiKey") @ExcludeMissing fun _apiKey(): JsonField = apiKey
+ fun validate(): ModelConfig = apply {
+ if (validated) {
+ return@apply
+ }
- /**
- * Returns the raw JSON value of [baseUrl].
- *
- * Unlike [baseUrl], this method doesn't throw if the JSON field has an unexpected type.
- */
- @JsonProperty("baseURL") @ExcludeMissing fun _baseUrl(): JsonField = baseUrl
+ modelName()
+ apiKey()
+ baseUrl()
+ provider().ifPresent { it.validate() }
+ validated = true
+ }
+
+ fun isValid(): Boolean =
+ try {
+ validate()
+ true
+ } catch (e: StagehandInvalidDataException) {
+ false
+ }
+
+ /**
+ * Returns a score indicating how many valid values are contained in this object recursively.
+ *
+ * Used for best match union deserialization.
+ */
+ @JvmSynthetic
+ internal fun validity(): Int =
+ (if (modelName.asKnown().isPresent) 1 else 0) +
+ (if (apiKey.asKnown().isPresent) 1 else 0) +
+ (if (baseUrl.asKnown().isPresent) 1 else 0) +
+ (provider.asKnown().getOrNull()?.validity() ?: 0)
+
+ /** AI provider for the model (or provide a baseURL endpoint instead) */
+ class Provider @JsonCreator private constructor(private val value: JsonField) : Enum {
/**
- * Returns the raw JSON value of [provider].
+ * Returns this class instance's raw value.
*
- * Unlike [provider], this method doesn't throw if the JSON field has an unexpected type.
+ * This is usually only useful if this instance was deserialized from data that doesn't
+ * match any known member, and you want to know that value. For example, if the SDK is on an
+ * older version than the API, then the API may respond with new members that the SDK is
+ * unaware of.
*/
- @JsonProperty("provider") @ExcludeMissing fun _provider(): JsonField = provider
+ @com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
- @JsonAnySetter
- private fun putAdditionalProperty(key: String, value: JsonValue) {
- additionalProperties.put(key, value)
- }
+ companion object {
- @JsonAnyGetter
- @ExcludeMissing
- fun _additionalProperties(): Map =
- Collections.unmodifiableMap(additionalProperties)
+ @JvmField val OPENAI = of("openai")
- fun toBuilder() = Builder().from(this)
+ @JvmField val ANTHROPIC = of("anthropic")
- companion object {
+ @JvmField val GOOGLE = of("google")
+
+ @JvmField val MICROSOFT = of("microsoft")
- /**
- * Returns a mutable builder for constructing an instance of [ModelConfigObject].
- *
- * The following fields are required:
- * ```java
- * .modelName()
- * ```
- */
- @JvmStatic fun builder() = Builder()
+ @JvmStatic fun of(value: String) = Provider(JsonField.of(value))
}
- /** A builder for [ModelConfigObject]. */
- class Builder internal constructor() {
-
- private var modelName: JsonField? = null
- private var apiKey: JsonField = JsonMissing.of()
- private var baseUrl: JsonField = JsonMissing.of()
- private var provider: JsonField = JsonMissing.of()
- private var additionalProperties: MutableMap = mutableMapOf()
-
- @JvmSynthetic
- internal fun from(modelConfigObject: ModelConfigObject) = apply {
- modelName = modelConfigObject.modelName
- apiKey = modelConfigObject.apiKey
- baseUrl = modelConfigObject.baseUrl
- provider = modelConfigObject.provider
- additionalProperties = modelConfigObject.additionalProperties.toMutableMap()
- }
+ /** An enum containing [Provider]'s known values. */
+ enum class Known {
+ OPENAI,
+ ANTHROPIC,
+ GOOGLE,
+ MICROSOFT,
+ }
- /** Model name string (e.g., 'openai/gpt-5-nano', 'anthropic/claude-4.5-opus') */
- fun modelName(modelName: String) = modelName(JsonField.of(modelName))
-
- /**
- * Sets [Builder.modelName] to an arbitrary JSON value.
- *
- * You should usually call [Builder.modelName] with a well-typed [String] value instead.
- * This method is primarily for setting the field to an undocumented or not yet
- * supported value.
- */
- fun modelName(modelName: JsonField) = apply { this.modelName = modelName }
-
- /** API key for the model provider */
- fun apiKey(apiKey: String) = apiKey(JsonField.of(apiKey))
-
- /**
- * Sets [Builder.apiKey] to an arbitrary JSON value.
- *
- * You should usually call [Builder.apiKey] with a well-typed [String] value instead.
- * This method is primarily for setting the field to an undocumented or not yet
- * supported value.
- */
- fun apiKey(apiKey: JsonField) = apply { this.apiKey = apiKey }
-
- /** Base URL for the model provider */
- fun baseUrl(baseUrl: String) = baseUrl(JsonField.of(baseUrl))
-
- /**
- * Sets [Builder.baseUrl] to an arbitrary JSON value.
- *
- * You should usually call [Builder.baseUrl] with a well-typed [String] value instead.
- * This method is primarily for setting the field to an undocumented or not yet
- * supported value.
- */
- fun baseUrl(baseUrl: JsonField) = apply { this.baseUrl = baseUrl }
-
- /** AI provider for the model (or provide a baseURL endpoint instead) */
- fun provider(provider: Provider) = provider(JsonField.of(provider))
-
- /**
- * Sets [Builder.provider] to an arbitrary JSON value.
- *
- * You should usually call [Builder.provider] with a well-typed [Provider] value
- * instead. This method is primarily for setting the field to an undocumented or not yet
- * supported value.
- */
- fun provider(provider: JsonField) = apply { this.provider = provider }
-
- fun additionalProperties(additionalProperties: Map) = apply {
- this.additionalProperties.clear()
- putAllAdditionalProperties(additionalProperties)
- }
+ /**
+ * An enum containing [Provider]'s known values, as well as an [_UNKNOWN] member.
+ *
+ * An instance of [Provider] can contain an unknown value in a couple of cases:
+ * - It was deserialized from data that doesn't match any known member. For example, if the
+ * SDK is on an older version than the API, then the API may respond with new members that
+ * the SDK is unaware of.
+ * - It was constructed with an arbitrary value using the [of] method.
+ */
+ enum class Value {
+ OPENAI,
+ ANTHROPIC,
+ GOOGLE,
+ MICROSOFT,
+ /** An enum member indicating that [Provider] was instantiated with an unknown value. */
+ _UNKNOWN,
+ }
- fun putAdditionalProperty(key: String, value: JsonValue) = apply {
- additionalProperties.put(key, value)
+ /**
+ * Returns an enum member corresponding to this class instance's value, or [Value._UNKNOWN]
+ * if the class was instantiated with an unknown value.
+ *
+ * Use the [known] method instead if you're certain the value is always known or if you want
+ * to throw for the unknown case.
+ */
+ fun value(): Value =
+ when (this) {
+ OPENAI -> Value.OPENAI
+ ANTHROPIC -> Value.ANTHROPIC
+ GOOGLE -> Value.GOOGLE
+ MICROSOFT -> Value.MICROSOFT
+ else -> Value._UNKNOWN
}
- fun putAllAdditionalProperties(additionalProperties: Map) = apply {
- this.additionalProperties.putAll(additionalProperties)
+ /**
+ * Returns an enum member corresponding to this class instance's value.
+ *
+ * Use the [value] method instead if you're uncertain the value is always known and don't
+ * want to throw for the unknown case.
+ *
+ * @throws StagehandInvalidDataException if this class instance's value is a not a known
+ * member.
+ */
+ fun known(): Known =
+ when (this) {
+ OPENAI -> Known.OPENAI
+ ANTHROPIC -> Known.ANTHROPIC
+ GOOGLE -> Known.GOOGLE
+ MICROSOFT -> Known.MICROSOFT
+ else -> throw StagehandInvalidDataException("Unknown Provider: $value")
}
- fun removeAdditionalProperty(key: String) = apply { additionalProperties.remove(key) }
-
- fun removeAllAdditionalProperties(keys: Set) = apply {
- keys.forEach(::removeAdditionalProperty)
+ /**
+ * Returns this class instance's primitive wire representation.
+ *
+ * This differs from the [toString] method because that method is primarily for debugging
+ * and generally doesn't throw.
+ *
+ * @throws StagehandInvalidDataException if this class instance's value does not have the
+ * expected primitive type.
+ */
+ fun asString(): String =
+ _value().asString().orElseThrow {
+ StagehandInvalidDataException("Value is not a String")
}
- /**
- * Returns an immutable instance of [ModelConfigObject].
- *
- * Further updates to this [Builder] will not mutate the returned instance.
- *
- * The following fields are required:
- * ```java
- * .modelName()
- * ```
- *
- * @throws IllegalStateException if any required field is unset.
- */
- fun build(): ModelConfigObject =
- ModelConfigObject(
- checkRequired("modelName", modelName),
- apiKey,
- baseUrl,
- provider,
- additionalProperties.toMutableMap(),
- )
- }
-
private var validated: Boolean = false
- fun validate(): ModelConfigObject = apply {
+ fun validate(): Provider = apply {
if (validated) {
return@apply
}
- modelName()
- apiKey()
- baseUrl()
- provider().ifPresent { it.validate() }
+ known()
validated = true
}
@@ -462,176 +385,40 @@ private constructor(
*
* Used for best match union deserialization.
*/
- @JvmSynthetic
- internal fun validity(): Int =
- (if (modelName.asKnown().isPresent) 1 else 0) +
- (if (apiKey.asKnown().isPresent) 1 else 0) +
- (if (baseUrl.asKnown().isPresent) 1 else 0) +
- (provider.asKnown().getOrNull()?.validity() ?: 0)
-
- /** AI provider for the model (or provide a baseURL endpoint instead) */
- class Provider @JsonCreator private constructor(private val value: JsonField) :
- Enum {
-
- /**
- * Returns this class instance's raw value.
- *
- * This is usually only useful if this instance was deserialized from data that doesn't
- * match any known member, and you want to know that value. For example, if the SDK is
- * on an older version than the API, then the API may respond with new members that the
- * SDK is unaware of.
- */
- @com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
-
- companion object {
-
- @JvmField val OPENAI = of("openai")
-
- @JvmField val ANTHROPIC = of("anthropic")
-
- @JvmField val GOOGLE = of("google")
-
- @JvmField val MICROSOFT = of("microsoft")
-
- @JvmStatic fun of(value: String) = Provider(JsonField.of(value))
- }
-
- /** An enum containing [Provider]'s known values. */
- enum class Known {
- OPENAI,
- ANTHROPIC,
- GOOGLE,
- MICROSOFT,
- }
-
- /**
- * An enum containing [Provider]'s known values, as well as an [_UNKNOWN] member.
- *
- * An instance of [Provider] can contain an unknown value in a couple of cases:
- * - It was deserialized from data that doesn't match any known member. For example, if
- * the SDK is on an older version than the API, then the API may respond with new
- * members that the SDK is unaware of.
- * - It was constructed with an arbitrary value using the [of] method.
- */
- enum class Value {
- OPENAI,
- ANTHROPIC,
- GOOGLE,
- MICROSOFT,
- /**
- * An enum member indicating that [Provider] was instantiated with an unknown value.
- */
- _UNKNOWN,
- }
-
- /**
- * Returns an enum member corresponding to this class instance's value, or
- * [Value._UNKNOWN] if the class was instantiated with an unknown value.
- *
- * Use the [known] method instead if you're certain the value is always known or if you
- * want to throw for the unknown case.
- */
- fun value(): Value =
- when (this) {
- OPENAI -> Value.OPENAI
- ANTHROPIC -> Value.ANTHROPIC
- GOOGLE -> Value.GOOGLE
- MICROSOFT -> Value.MICROSOFT
- else -> Value._UNKNOWN
- }
-
- /**
- * Returns an enum member corresponding to this class instance's value.
- *
- * Use the [value] method instead if you're uncertain the value is always known and
- * don't want to throw for the unknown case.
- *
- * @throws StagehandInvalidDataException if this class instance's value is a not a known
- * member.
- */
- fun known(): Known =
- when (this) {
- OPENAI -> Known.OPENAI
- ANTHROPIC -> Known.ANTHROPIC
- GOOGLE -> Known.GOOGLE
- MICROSOFT -> Known.MICROSOFT
- else -> throw StagehandInvalidDataException("Unknown Provider: $value")
- }
-
- /**
- * Returns this class instance's primitive wire representation.
- *
- * This differs from the [toString] method because that method is primarily for
- * debugging and generally doesn't throw.
- *
- * @throws StagehandInvalidDataException if this class instance's value does not have
- * the expected primitive type.
- */
- fun asString(): String =
- _value().asString().orElseThrow {
- StagehandInvalidDataException("Value is not a String")
- }
-
- private var validated: Boolean = false
-
- fun validate(): Provider = apply {
- if (validated) {
- return@apply
- }
-
- known()
- validated = true
- }
-
- fun isValid(): Boolean =
- try {
- validate()
- true
- } catch (e: StagehandInvalidDataException) {
- false
- }
-
- /**
- * Returns a score indicating how many valid values are contained in this object
- * recursively.
- *
- * Used for best match union deserialization.
- */
- @JvmSynthetic internal fun validity(): Int = if (value() == Value._UNKNOWN) 0 else 1
-
- override fun equals(other: Any?): Boolean {
- if (this === other) {
- return true
- }
-
- return other is Provider && value == other.value
- }
-
- override fun hashCode() = value.hashCode()
-
- override fun toString() = value.toString()
- }
+ @JvmSynthetic internal fun validity(): Int = if (value() == Value._UNKNOWN) 0 else 1
override fun equals(other: Any?): Boolean {
if (this === other) {
return true
}
- return other is ModelConfigObject &&
- modelName == other.modelName &&
- apiKey == other.apiKey &&
- baseUrl == other.baseUrl &&
- provider == other.provider &&
- additionalProperties == other.additionalProperties
+ return other is Provider && value == other.value
}
- private val hashCode: Int by lazy {
- Objects.hash(modelName, apiKey, baseUrl, provider, additionalProperties)
+ override fun hashCode() = value.hashCode()
+
+ override fun toString() = value.toString()
+ }
+
+ override fun equals(other: Any?): Boolean {
+ if (this === other) {
+ return true
}
- override fun hashCode(): Int = hashCode
+ return other is ModelConfig &&
+ modelName == other.modelName &&
+ apiKey == other.apiKey &&
+ baseUrl == other.baseUrl &&
+ provider == other.provider &&
+ additionalProperties == other.additionalProperties
+ }
- override fun toString() =
- "ModelConfigObject{modelName=$modelName, apiKey=$apiKey, baseUrl=$baseUrl, provider=$provider, additionalProperties=$additionalProperties}"
+ private val hashCode: Int by lazy {
+ Objects.hash(modelName, apiKey, baseUrl, provider, additionalProperties)
}
+
+ override fun hashCode(): Int = hashCode
+
+ override fun toString() =
+ "ModelConfig{modelName=$modelName, apiKey=$apiKey, baseUrl=$baseUrl, provider=$provider, additionalProperties=$additionalProperties}"
}
diff --git a/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionActParams.kt b/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionActParams.kt
index 182931c..3445d78 100644
--- a/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionActParams.kt
+++ b/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionActParams.kt
@@ -28,8 +28,6 @@ import com.fasterxml.jackson.databind.SerializerProvider
import com.fasterxml.jackson.databind.annotation.JsonDeserialize
import com.fasterxml.jackson.databind.annotation.JsonSerialize
import com.fasterxml.jackson.module.kotlin.jacksonTypeRef
-import java.time.OffsetDateTime
-import java.time.format.DateTimeFormatter
import java.util.Collections
import java.util.Objects
import java.util.Optional
@@ -39,7 +37,6 @@ import kotlin.jvm.optionals.getOrNull
class SessionActParams
private constructor(
private val id: String?,
- private val xSentAt: OffsetDateTime?,
private val xStreamResponse: XStreamResponse?,
private val body: Body,
private val additionalHeaders: Headers,
@@ -49,9 +46,6 @@ private constructor(
/** Unique session identifier */
fun id(): Optional = Optional.ofNullable(id)
- /** ISO timestamp when request was sent */
- fun xSentAt(): Optional = Optional.ofNullable(xSentAt)
-
/** Whether to stream the response via SSE */
fun xStreamResponse(): Optional = Optional.ofNullable(xStreamResponse)
@@ -125,7 +119,6 @@ private constructor(
class Builder internal constructor() {
private var id: String? = null
- private var xSentAt: OffsetDateTime? = null
private var xStreamResponse: XStreamResponse? = null
private var body: Body.Builder = Body.builder()
private var additionalHeaders: Headers.Builder = Headers.builder()
@@ -134,7 +127,6 @@ private constructor(
@JvmSynthetic
internal fun from(sessionActParams: SessionActParams) = apply {
id = sessionActParams.id
- xSentAt = sessionActParams.xSentAt
xStreamResponse = sessionActParams.xStreamResponse
body = sessionActParams.body.toBuilder()
additionalHeaders = sessionActParams.additionalHeaders.toBuilder()
@@ -147,12 +139,6 @@ private constructor(
/** Alias for calling [Builder.id] with `id.orElse(null)`. */
fun id(id: Optional) = id(id.getOrNull())
- /** ISO timestamp when request was sent */
- fun xSentAt(xSentAt: OffsetDateTime?) = apply { this.xSentAt = xSentAt }
-
- /** Alias for calling [Builder.xSentAt] with `xSentAt.orElse(null)`. */
- fun xSentAt(xSentAt: Optional) = xSentAt(xSentAt.getOrNull())
-
/** Whether to stream the response via SSE */
fun xStreamResponse(xStreamResponse: XStreamResponse?) = apply {
this.xStreamResponse = xStreamResponse
@@ -191,7 +177,10 @@ private constructor(
fun input(action: Action) = apply { body.input(action) }
/** Target frame ID for the action */
- fun frameId(frameId: String) = apply { body.frameId(frameId) }
+ fun frameId(frameId: String?) = apply { body.frameId(frameId) }
+
+ /** Alias for calling [Builder.frameId] with `frameId.orElse(null)`. */
+ fun frameId(frameId: Optional) = frameId(frameId.getOrNull())
/**
* Sets [Builder.frameId] to an arbitrary JSON value.
@@ -343,7 +332,6 @@ private constructor(
fun build(): SessionActParams =
SessionActParams(
id,
- xSentAt,
xStreamResponse,
body.build(),
additionalHeaders.build(),
@@ -362,7 +350,6 @@ private constructor(
override fun _headers(): Headers =
Headers.builder()
.apply {
- xSentAt?.let { put("x-sent-at", DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(it)) }
xStreamResponse?.let { put("x-stream-response", it.toString()) }
putAll(additionalHeaders)
}
@@ -489,7 +476,10 @@ private constructor(
fun input(action: Action) = input(Input.ofAction(action))
/** Target frame ID for the action */
- fun frameId(frameId: String) = frameId(JsonField.of(frameId))
+ fun frameId(frameId: String?) = frameId(JsonField.ofNullable(frameId))
+
+ /** Alias for calling [Builder.frameId] with `frameId.orElse(null)`. */
+ fun frameId(frameId: Optional) = frameId(frameId.getOrNull())
/**
* Sets [Builder.frameId] to an arbitrary JSON value.
@@ -752,7 +742,7 @@ private constructor(
.toList()
return when (bestMatches.size) {
// This can happen if what we're deserializing is completely incompatible with
- // all the possible variants (e.g. deserializing from array).
+ // all the possible variants (e.g. deserializing from boolean).
0 -> Input(_json = json)
1 -> bestMatches.single()
// If there's more than one match with the highest validity, then use the first
@@ -783,7 +773,7 @@ private constructor(
class Options
@JsonCreator(mode = JsonCreator.Mode.DISABLED)
private constructor(
- private val model: JsonField,
+ private val model: JsonField,
private val timeout: JsonField,
private val variables: JsonField,
private val additionalProperties: MutableMap,
@@ -791,7 +781,7 @@ private constructor(
@JsonCreator
private constructor(
- @JsonProperty("model") @ExcludeMissing model: JsonField = JsonMissing.of(),
+ @JsonProperty("model") @ExcludeMissing model: JsonField = JsonMissing.of(),
@JsonProperty("timeout") @ExcludeMissing timeout: JsonField = JsonMissing.of(),
@JsonProperty("variables")
@ExcludeMissing
@@ -799,13 +789,12 @@ private constructor(
) : this(model, timeout, variables, mutableMapOf())
/**
- * Model name string with provider prefix (e.g., 'openai/gpt-5-nano',
- * 'anthropic/claude-4.5-opus')
+ * Model configuration object or model name string (e.g., 'openai/gpt-5-nano')
*
* @throws StagehandInvalidDataException if the JSON field has an unexpected type (e.g. if
* the server responded with an unexpected value).
*/
- fun model(): Optional = model.getOptional("model")
+ fun model(): Optional = model.getOptional("model")
/**
* Timeout in ms for the action
@@ -828,7 +817,7 @@ private constructor(
*
* Unlike [model], this method doesn't throw if the JSON field has an unexpected type.
*/
- @JsonProperty("model") @ExcludeMissing fun _model(): JsonField = model
+ @JsonProperty("model") @ExcludeMissing fun _model(): JsonField = model
/**
* Returns the raw JSON value of [timeout].
@@ -867,7 +856,7 @@ private constructor(
/** A builder for [Options]. */
class Builder internal constructor() {
- private var model: JsonField = JsonMissing.of()
+ private var model: JsonField = JsonMissing.of()
private var timeout: JsonField = JsonMissing.of()
private var variables: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@@ -880,29 +869,23 @@ private constructor(
additionalProperties = options.additionalProperties.toMutableMap()
}
- /**
- * Model name string with provider prefix (e.g., 'openai/gpt-5-nano',
- * 'anthropic/claude-4.5-opus')
- */
- fun model(model: ModelConfig) = model(JsonField.of(model))
+ /** Model configuration object or model name string (e.g., 'openai/gpt-5-nano') */
+ fun model(model: Model) = model(JsonField.of(model))
/**
* Sets [Builder.model] to an arbitrary JSON value.
*
- * You should usually call [Builder.model] with a well-typed [ModelConfig] value
- * instead. This method is primarily for setting the field to an undocumented or not yet
- * supported value.
+ * You should usually call [Builder.model] with a well-typed [Model] value instead. This
+ * method is primarily for setting the field to an undocumented or not yet supported
+ * value.
*/
- fun model(model: JsonField) = apply { this.model = model }
+ fun model(model: JsonField) = apply { this.model = model }
- /** Alias for calling [model] with `ModelConfig.ofName(name)`. */
- fun model(name: String) = model(ModelConfig.ofName(name))
+ /** Alias for calling [model] with `Model.ofConfig(config)`. */
+ fun model(config: ModelConfig) = model(Model.ofConfig(config))
- /**
- * Alias for calling [model] with `ModelConfig.ofModelConfigObject(modelConfigObject)`.
- */
- fun model(modelConfigObject: ModelConfig.ModelConfigObject) =
- model(ModelConfig.ofModelConfigObject(modelConfigObject))
+ /** Alias for calling [model] with `Model.ofString(string)`. */
+ fun model(string: String) = model(Model.ofString(string))
/** Timeout in ms for the action */
fun timeout(timeout: Double) = timeout(JsonField.of(timeout))
@@ -989,6 +972,178 @@ private constructor(
(if (timeout.asKnown().isPresent) 1 else 0) +
(variables.asKnown().getOrNull()?.validity() ?: 0)
+ /** Model configuration object or model name string (e.g., 'openai/gpt-5-nano') */
+ @JsonDeserialize(using = Model.Deserializer::class)
+ @JsonSerialize(using = Model.Serializer::class)
+ class Model
+ private constructor(
+ private val config: ModelConfig? = null,
+ private val string: String? = null,
+ private val _json: JsonValue? = null,
+ ) {
+
+ fun config(): Optional = Optional.ofNullable(config)
+
+ fun string(): Optional = Optional.ofNullable(string)
+
+ fun isConfig(): Boolean = config != null
+
+ fun isString(): Boolean = string != null
+
+ fun asConfig(): ModelConfig = config.getOrThrow("config")
+
+ fun asString(): String = string.getOrThrow("string")
+
+ fun _json(): Optional = Optional.ofNullable(_json)
+
+ fun accept(visitor: Visitor): T =
+ when {
+ config != null -> visitor.visitConfig(config)
+ string != null -> visitor.visitString(string)
+ else -> visitor.unknown(_json)
+ }
+
+ private var validated: Boolean = false
+
+ fun validate(): Model = apply {
+ if (validated) {
+ return@apply
+ }
+
+ accept(
+ object : Visitor {
+ override fun visitConfig(config: ModelConfig) {
+ config.validate()
+ }
+
+ override fun visitString(string: String) {}
+ }
+ )
+ validated = true
+ }
+
+ fun isValid(): Boolean =
+ try {
+ validate()
+ true
+ } catch (e: StagehandInvalidDataException) {
+ false
+ }
+
+ /**
+ * Returns a score indicating how many valid values are contained in this object
+ * recursively.
+ *
+ * Used for best match union deserialization.
+ */
+ @JvmSynthetic
+ internal fun validity(): Int =
+ accept(
+ object : Visitor {
+ override fun visitConfig(config: ModelConfig) = config.validity()
+
+ override fun visitString(string: String) = 1
+
+ override fun unknown(json: JsonValue?) = 0
+ }
+ )
+
+ override fun equals(other: Any?): Boolean {
+ if (this === other) {
+ return true
+ }
+
+ return other is Model && config == other.config && string == other.string
+ }
+
+ override fun hashCode(): Int = Objects.hash(config, string)
+
+ override fun toString(): String =
+ when {
+ config != null -> "Model{config=$config}"
+ string != null -> "Model{string=$string}"
+ _json != null -> "Model{_unknown=$_json}"
+ else -> throw IllegalStateException("Invalid Model")
+ }
+
+ companion object {
+
+ @JvmStatic fun ofConfig(config: ModelConfig) = Model(config = config)
+
+ @JvmStatic fun ofString(string: String) = Model(string = string)
+ }
+
+ /**
+ * An interface that defines how to map each variant of [Model] to a value of type [T].
+ */
+ interface Visitor {
+
+ fun visitConfig(config: ModelConfig): T
+
+ fun visitString(string: String): T
+
+ /**
+ * Maps an unknown variant of [Model] to a value of type [T].
+ *
+ * An instance of [Model] can contain an unknown variant if it was deserialized from
+ * data that doesn't match any known variant. For example, if the SDK is on an older
+ * version than the API, then the API may respond with new variants that the SDK is
+ * unaware of.
+ *
+ * @throws StagehandInvalidDataException in the default implementation.
+ */
+ fun unknown(json: JsonValue?): T {
+ throw StagehandInvalidDataException("Unknown Model: $json")
+ }
+ }
+
+ internal class Deserializer : BaseDeserializer(Model::class) {
+
+ override fun ObjectCodec.deserialize(node: JsonNode): Model {
+ val json = JsonValue.fromJsonNode(node)
+
+ val bestMatches =
+ sequenceOf(
+ tryDeserialize(node, jacksonTypeRef())?.let {
+ Model(config = it, _json = json)
+ },
+ tryDeserialize(node, jacksonTypeRef())?.let {
+ Model(string = it, _json = json)
+ },
+ )
+ .filterNotNull()
+ .allMaxBy { it.validity() }
+ .toList()
+ return when (bestMatches.size) {
+ // This can happen if what we're deserializing is completely incompatible
+ // with all the possible variants (e.g. deserializing from boolean).
+ 0 -> Model(_json = json)
+ 1 -> bestMatches.single()
+ // If there's more than one match with the highest validity, then use the
+ // first completely valid match, or simply the first match if none are
+ // completely valid.
+ else -> bestMatches.firstOrNull { it.isValid() } ?: bestMatches.first()
+ }
+ }
+ }
+
+ internal class Serializer : BaseSerializer(Model::class) {
+
+ override fun serialize(
+ value: Model,
+ generator: JsonGenerator,
+ provider: SerializerProvider,
+ ) {
+ when {
+ value.config != null -> generator.writeObject(value.config)
+ value.string != null -> generator.writeObject(value.string)
+ value._json != null -> generator.writeObject(value._json)
+ else -> throw IllegalStateException("Invalid Model")
+ }
+ }
+ }
+ }
+
/** Variables to substitute in the action instruction */
class Variables
@JsonCreator
@@ -1253,7 +1408,6 @@ private constructor(
return other is SessionActParams &&
id == other.id &&
- xSentAt == other.xSentAt &&
xStreamResponse == other.xStreamResponse &&
body == other.body &&
additionalHeaders == other.additionalHeaders &&
@@ -1261,8 +1415,8 @@ private constructor(
}
override fun hashCode(): Int =
- Objects.hash(id, xSentAt, xStreamResponse, body, additionalHeaders, additionalQueryParams)
+ Objects.hash(id, xStreamResponse, body, additionalHeaders, additionalQueryParams)
override fun toString() =
- "SessionActParams{id=$id, xSentAt=$xSentAt, xStreamResponse=$xStreamResponse, body=$body, additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams}"
+ "SessionActParams{id=$id, xStreamResponse=$xStreamResponse, body=$body, additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams}"
}
diff --git a/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionEndParams.kt b/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionEndParams.kt
index c861cc2..cf9a245 100644
--- a/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionEndParams.kt
+++ b/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionEndParams.kt
@@ -3,21 +3,14 @@
package com.browserbase.api.models.sessions
import com.browserbase.api.core.Enum
-import com.browserbase.api.core.ExcludeMissing
import com.browserbase.api.core.JsonField
-import com.browserbase.api.core.JsonMissing
import com.browserbase.api.core.JsonValue
import com.browserbase.api.core.Params
import com.browserbase.api.core.http.Headers
import com.browserbase.api.core.http.QueryParams
+import com.browserbase.api.core.toImmutable
import com.browserbase.api.errors.StagehandInvalidDataException
-import com.fasterxml.jackson.annotation.JsonAnyGetter
-import com.fasterxml.jackson.annotation.JsonAnySetter
import com.fasterxml.jackson.annotation.JsonCreator
-import com.fasterxml.jackson.annotation.JsonProperty
-import java.time.OffsetDateTime
-import java.time.format.DateTimeFormatter
-import java.util.Collections
import java.util.Objects
import java.util.Optional
import kotlin.jvm.optionals.getOrNull
@@ -26,25 +19,20 @@ import kotlin.jvm.optionals.getOrNull
class SessionEndParams
private constructor(
private val id: String?,
- private val xSentAt: OffsetDateTime?,
private val xStreamResponse: XStreamResponse?,
- private val body: Body,
private val additionalHeaders: Headers,
private val additionalQueryParams: QueryParams,
+ private val additionalBodyProperties: Map,
) : Params {
/** Unique session identifier */
fun id(): Optional = Optional.ofNullable(id)
- /** ISO timestamp when request was sent */
- fun xSentAt(): Optional = Optional.ofNullable(xSentAt)
-
/** Whether to stream the response via SSE */
fun xStreamResponse(): Optional = Optional.ofNullable(xStreamResponse)
- fun __forceBody(): JsonValue = body.__forceBody()
-
- fun _additionalBodyProperties(): Map = body._additionalProperties()
+ /** Additional body properties to send with the request. */
+ fun _additionalBodyProperties(): Map = additionalBodyProperties
/** Additional headers to send with the request. */
fun _additionalHeaders(): Headers = additionalHeaders
@@ -66,20 +54,18 @@ private constructor(
class Builder internal constructor() {
private var id: String? = null
- private var xSentAt: OffsetDateTime? = null
private var xStreamResponse: XStreamResponse? = null
- private var body: Body.Builder = Body.builder()
private var additionalHeaders: Headers.Builder = Headers.builder()
private var additionalQueryParams: QueryParams.Builder = QueryParams.builder()
+ private var additionalBodyProperties: MutableMap = mutableMapOf()
@JvmSynthetic
internal fun from(sessionEndParams: SessionEndParams) = apply {
id = sessionEndParams.id
- xSentAt = sessionEndParams.xSentAt
xStreamResponse = sessionEndParams.xStreamResponse
- body = sessionEndParams.body.toBuilder()
additionalHeaders = sessionEndParams.additionalHeaders.toBuilder()
additionalQueryParams = sessionEndParams.additionalQueryParams.toBuilder()
+ additionalBodyProperties = sessionEndParams.additionalBodyProperties.toMutableMap()
}
/** Unique session identifier */
@@ -88,12 +74,6 @@ private constructor(
/** Alias for calling [Builder.id] with `id.orElse(null)`. */
fun id(id: Optional) = id(id.getOrNull())
- /** ISO timestamp when request was sent */
- fun xSentAt(xSentAt: OffsetDateTime?) = apply { this.xSentAt = xSentAt }
-
- /** Alias for calling [Builder.xSentAt] with `xSentAt.orElse(null)`. */
- fun xSentAt(xSentAt: Optional) = xSentAt(xSentAt.getOrNull())
-
/** Whether to stream the response via SSE */
fun xStreamResponse(xStreamResponse: XStreamResponse?) = apply {
this.xStreamResponse = xStreamResponse
@@ -103,36 +83,6 @@ private constructor(
fun xStreamResponse(xStreamResponse: Optional) =
xStreamResponse(xStreamResponse.getOrNull())
- /**
- * Sets the entire request body.
- *
- * This is generally only useful if you are already constructing the body separately.
- * Otherwise, it's more convenient to use the top-level setters instead:
- * - [_forceBody]
- */
- fun body(body: Body) = apply { this.body = body.toBuilder() }
-
- fun _forceBody(_forceBody: JsonValue) = apply { body._forceBody(_forceBody) }
-
- fun additionalBodyProperties(additionalBodyProperties: Map) = apply {
- body.additionalProperties(additionalBodyProperties)
- }
-
- fun putAdditionalBodyProperty(key: String, value: JsonValue) = apply {
- body.putAdditionalProperty(key, value)
- }
-
- fun putAllAdditionalBodyProperties(additionalBodyProperties: Map) =
- apply {
- body.putAllAdditionalProperties(additionalBodyProperties)
- }
-
- fun removeAdditionalBodyProperty(key: String) = apply { body.removeAdditionalProperty(key) }
-
- fun removeAllAdditionalBodyProperties(keys: Set) = apply {
- body.removeAllAdditionalProperties(keys)
- }
-
fun additionalHeaders(additionalHeaders: Headers) = apply {
this.additionalHeaders.clear()
putAllAdditionalHeaders(additionalHeaders)
@@ -231,6 +181,28 @@ private constructor(
additionalQueryParams.removeAll(keys)
}
+ fun additionalBodyProperties(additionalBodyProperties: Map) = apply {
+ this.additionalBodyProperties.clear()
+ putAllAdditionalBodyProperties(additionalBodyProperties)
+ }
+
+ fun putAdditionalBodyProperty(key: String, value: JsonValue) = apply {
+ additionalBodyProperties.put(key, value)
+ }
+
+ fun putAllAdditionalBodyProperties(additionalBodyProperties: Map) =
+ apply {
+ this.additionalBodyProperties.putAll(additionalBodyProperties)
+ }
+
+ fun removeAdditionalBodyProperty(key: String) = apply {
+ additionalBodyProperties.remove(key)
+ }
+
+ fun removeAllAdditionalBodyProperties(keys: Set) = apply {
+ keys.forEach(::removeAdditionalBodyProperty)
+ }
+
/**
* Returns an immutable instance of [SessionEndParams].
*
@@ -239,15 +211,15 @@ private constructor(
fun build(): SessionEndParams =
SessionEndParams(
id,
- xSentAt,
xStreamResponse,
- body.build(),
additionalHeaders.build(),
additionalQueryParams.build(),
+ additionalBodyProperties.toImmutable(),
)
}
- fun _body(): Body = body
+ fun _body(): Optional> =
+ Optional.ofNullable(additionalBodyProperties.ifEmpty { null })
fun _pathParam(index: Int): String =
when (index) {
@@ -258,7 +230,6 @@ private constructor(
override fun _headers(): Headers =
Headers.builder()
.apply {
- xSentAt?.let { put("x-sent-at", DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(it)) }
xStreamResponse?.let { put("x-stream-response", it.toString()) }
putAll(additionalHeaders)
}
@@ -266,123 +237,6 @@ private constructor(
override fun _queryParams(): QueryParams = additionalQueryParams
- class Body
- @JsonCreator(mode = JsonCreator.Mode.DISABLED)
- private constructor(
- private val _forceBody: JsonValue,
- private val additionalProperties: MutableMap,
- ) {
-
- @JsonCreator
- private constructor(
- @JsonProperty("_forceBody") @ExcludeMissing _forceBody: JsonValue = JsonMissing.of()
- ) : this(_forceBody, mutableMapOf())
-
- @JsonProperty("_forceBody") @ExcludeMissing fun __forceBody(): JsonValue = _forceBody
-
- @JsonAnySetter
- private fun putAdditionalProperty(key: String, value: JsonValue) {
- additionalProperties.put(key, value)
- }
-
- @JsonAnyGetter
- @ExcludeMissing
- fun _additionalProperties(): Map =
- Collections.unmodifiableMap(additionalProperties)
-
- fun toBuilder() = Builder().from(this)
-
- companion object {
-
- /** Returns a mutable builder for constructing an instance of [Body]. */
- @JvmStatic fun builder() = Builder()
- }
-
- /** A builder for [Body]. */
- class Builder internal constructor() {
-
- private var _forceBody: JsonValue = JsonMissing.of()
- private var additionalProperties: MutableMap = mutableMapOf()
-
- @JvmSynthetic
- internal fun from(body: Body) = apply {
- _forceBody = body._forceBody
- additionalProperties = body.additionalProperties.toMutableMap()
- }
-
- fun _forceBody(_forceBody: JsonValue) = apply { this._forceBody = _forceBody }
-
- fun additionalProperties(additionalProperties: Map) = apply {
- this.additionalProperties.clear()
- putAllAdditionalProperties(additionalProperties)
- }
-
- fun putAdditionalProperty(key: String, value: JsonValue) = apply {
- additionalProperties.put(key, value)
- }
-
- fun putAllAdditionalProperties(additionalProperties: Map) = apply {
- this.additionalProperties.putAll(additionalProperties)
- }
-
- fun removeAdditionalProperty(key: String) = apply { additionalProperties.remove(key) }
-
- fun removeAllAdditionalProperties(keys: Set) = apply {
- keys.forEach(::removeAdditionalProperty)
- }
-
- /**
- * Returns an immutable instance of [Body].
- *
- * Further updates to this [Builder] will not mutate the returned instance.
- */
- fun build(): Body = Body(_forceBody, additionalProperties.toMutableMap())
- }
-
- private var validated: Boolean = false
-
- fun validate(): Body = apply {
- if (validated) {
- return@apply
- }
-
- validated = true
- }
-
- fun isValid(): Boolean =
- try {
- validate()
- true
- } catch (e: StagehandInvalidDataException) {
- false
- }
-
- /**
- * Returns a score indicating how many valid values are contained in this object
- * recursively.
- *
- * Used for best match union deserialization.
- */
- @JvmSynthetic internal fun validity(): Int = 0
-
- override fun equals(other: Any?): Boolean {
- if (this === other) {
- return true
- }
-
- return other is Body &&
- _forceBody == other._forceBody &&
- additionalProperties == other.additionalProperties
- }
-
- private val hashCode: Int by lazy { Objects.hash(_forceBody, additionalProperties) }
-
- override fun hashCode(): Int = hashCode
-
- override fun toString() =
- "Body{_forceBody=$_forceBody, additionalProperties=$additionalProperties}"
- }
-
/** Whether to stream the response via SSE */
class XStreamResponse @JsonCreator private constructor(private val value: JsonField) :
Enum {
@@ -522,16 +376,21 @@ private constructor(
return other is SessionEndParams &&
id == other.id &&
- xSentAt == other.xSentAt &&
xStreamResponse == other.xStreamResponse &&
- body == other.body &&
additionalHeaders == other.additionalHeaders &&
- additionalQueryParams == other.additionalQueryParams
+ additionalQueryParams == other.additionalQueryParams &&
+ additionalBodyProperties == other.additionalBodyProperties
}
override fun hashCode(): Int =
- Objects.hash(id, xSentAt, xStreamResponse, body, additionalHeaders, additionalQueryParams)
+ Objects.hash(
+ id,
+ xStreamResponse,
+ additionalHeaders,
+ additionalQueryParams,
+ additionalBodyProperties,
+ )
override fun toString() =
- "SessionEndParams{id=$id, xSentAt=$xSentAt, xStreamResponse=$xStreamResponse, body=$body, additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams}"
+ "SessionEndParams{id=$id, xStreamResponse=$xStreamResponse, additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams, additionalBodyProperties=$additionalBodyProperties}"
}
diff --git a/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionExecuteParams.kt b/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionExecuteParams.kt
index 813b432..b8a795f 100644
--- a/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionExecuteParams.kt
+++ b/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionExecuteParams.kt
@@ -2,13 +2,17 @@
package com.browserbase.api.models.sessions
+import com.browserbase.api.core.BaseDeserializer
+import com.browserbase.api.core.BaseSerializer
import com.browserbase.api.core.Enum
import com.browserbase.api.core.ExcludeMissing
import com.browserbase.api.core.JsonField
import com.browserbase.api.core.JsonMissing
import com.browserbase.api.core.JsonValue
import com.browserbase.api.core.Params
+import com.browserbase.api.core.allMaxBy
import com.browserbase.api.core.checkRequired
+import com.browserbase.api.core.getOrThrow
import com.browserbase.api.core.http.Headers
import com.browserbase.api.core.http.QueryParams
import com.browserbase.api.errors.StagehandInvalidDataException
@@ -16,8 +20,13 @@ import com.fasterxml.jackson.annotation.JsonAnyGetter
import com.fasterxml.jackson.annotation.JsonAnySetter
import com.fasterxml.jackson.annotation.JsonCreator
import com.fasterxml.jackson.annotation.JsonProperty
-import java.time.OffsetDateTime
-import java.time.format.DateTimeFormatter
+import com.fasterxml.jackson.core.JsonGenerator
+import com.fasterxml.jackson.core.ObjectCodec
+import com.fasterxml.jackson.databind.JsonNode
+import com.fasterxml.jackson.databind.SerializerProvider
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize
+import com.fasterxml.jackson.databind.annotation.JsonSerialize
+import com.fasterxml.jackson.module.kotlin.jacksonTypeRef
import java.util.Collections
import java.util.Objects
import java.util.Optional
@@ -27,7 +36,6 @@ import kotlin.jvm.optionals.getOrNull
class SessionExecuteParams
private constructor(
private val id: String?,
- private val xSentAt: OffsetDateTime?,
private val xStreamResponse: XStreamResponse?,
private val body: Body,
private val additionalHeaders: Headers,
@@ -37,9 +45,6 @@ private constructor(
/** Unique session identifier */
fun id(): Optional = Optional.ofNullable(id)
- /** ISO timestamp when request was sent */
- fun xSentAt(): Optional = Optional.ofNullable(xSentAt)
-
/** Whether to stream the response via SSE */
fun xStreamResponse(): Optional = Optional.ofNullable(xStreamResponse)
@@ -63,6 +68,14 @@ private constructor(
*/
fun frameId(): Optional = body.frameId()
+ /**
+ * If true, the server captures a cache entry and returns it to the client
+ *
+ * @throws StagehandInvalidDataException if the JSON field has an unexpected type (e.g. if the
+ * server responded with an unexpected value).
+ */
+ fun shouldCache(): Optional = body.shouldCache()
+
/**
* Returns the raw JSON value of [agentConfig].
*
@@ -84,6 +97,13 @@ private constructor(
*/
fun _frameId(): JsonField = body._frameId()
+ /**
+ * Returns the raw JSON value of [shouldCache].
+ *
+ * Unlike [shouldCache], this method doesn't throw if the JSON field has an unexpected type.
+ */
+ fun _shouldCache(): JsonField = body._shouldCache()
+
fun _additionalBodyProperties(): Map = body._additionalProperties()
/** Additional headers to send with the request. */
@@ -112,7 +132,6 @@ private constructor(
class Builder internal constructor() {
private var id: String? = null
- private var xSentAt: OffsetDateTime? = null
private var xStreamResponse: XStreamResponse? = null
private var body: Body.Builder = Body.builder()
private var additionalHeaders: Headers.Builder = Headers.builder()
@@ -121,7 +140,6 @@ private constructor(
@JvmSynthetic
internal fun from(sessionExecuteParams: SessionExecuteParams) = apply {
id = sessionExecuteParams.id
- xSentAt = sessionExecuteParams.xSentAt
xStreamResponse = sessionExecuteParams.xStreamResponse
body = sessionExecuteParams.body.toBuilder()
additionalHeaders = sessionExecuteParams.additionalHeaders.toBuilder()
@@ -134,12 +152,6 @@ private constructor(
/** Alias for calling [Builder.id] with `id.orElse(null)`. */
fun id(id: Optional) = id(id.getOrNull())
- /** ISO timestamp when request was sent */
- fun xSentAt(xSentAt: OffsetDateTime?) = apply { this.xSentAt = xSentAt }
-
- /** Alias for calling [Builder.xSentAt] with `xSentAt.orElse(null)`. */
- fun xSentAt(xSentAt: Optional) = xSentAt(xSentAt.getOrNull())
-
/** Whether to stream the response via SSE */
fun xStreamResponse(xStreamResponse: XStreamResponse?) = apply {
this.xStreamResponse = xStreamResponse
@@ -157,6 +169,7 @@ private constructor(
* - [agentConfig]
* - [executeOptions]
* - [frameId]
+ * - [shouldCache]
*/
fun body(body: Body) = apply { this.body = body.toBuilder() }
@@ -189,7 +202,10 @@ private constructor(
}
/** Target frame ID for the agent */
- fun frameId(frameId: String) = apply { body.frameId(frameId) }
+ fun frameId(frameId: String?) = apply { body.frameId(frameId) }
+
+ /** Alias for calling [Builder.frameId] with `frameId.orElse(null)`. */
+ fun frameId(frameId: Optional) = frameId(frameId.getOrNull())
/**
* Sets [Builder.frameId] to an arbitrary JSON value.
@@ -199,6 +215,18 @@ private constructor(
*/
fun frameId(frameId: JsonField) = apply { body.frameId(frameId) }
+ /** If true, the server captures a cache entry and returns it to the client */
+ fun shouldCache(shouldCache: Boolean) = apply { body.shouldCache(shouldCache) }
+
+ /**
+ * Sets [Builder.shouldCache] to an arbitrary JSON value.
+ *
+ * You should usually call [Builder.shouldCache] with a well-typed [Boolean] value instead.
+ * This method is primarily for setting the field to an undocumented or not yet supported
+ * value.
+ */
+ fun shouldCache(shouldCache: JsonField) = apply { body.shouldCache(shouldCache) }
+
fun additionalBodyProperties(additionalBodyProperties: Map) = apply {
body.additionalProperties(additionalBodyProperties)
}
@@ -332,7 +360,6 @@ private constructor(
fun build(): SessionExecuteParams =
SessionExecuteParams(
id,
- xSentAt,
xStreamResponse,
body.build(),
additionalHeaders.build(),
@@ -351,7 +378,6 @@ private constructor(
override fun _headers(): Headers =
Headers.builder()
.apply {
- xSentAt?.let { put("x-sent-at", DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(it)) }
xStreamResponse?.let { put("x-stream-response", it.toString()) }
putAll(additionalHeaders)
}
@@ -365,6 +391,7 @@ private constructor(
private val agentConfig: JsonField,
private val executeOptions: JsonField,
private val frameId: JsonField,
+ private val shouldCache: JsonField,
private val additionalProperties: MutableMap,
) {
@@ -377,7 +404,10 @@ private constructor(
@ExcludeMissing
executeOptions: JsonField = JsonMissing.of(),
@JsonProperty("frameId") @ExcludeMissing frameId: JsonField = JsonMissing.of(),
- ) : this(agentConfig, executeOptions, frameId, mutableMapOf())
+ @JsonProperty("shouldCache")
+ @ExcludeMissing
+ shouldCache: JsonField = JsonMissing.of(),
+ ) : this(agentConfig, executeOptions, frameId, shouldCache, mutableMapOf())
/**
* @throws StagehandInvalidDataException if the JSON field has an unexpected type or is
@@ -399,6 +429,14 @@ private constructor(
*/
fun frameId(): Optional = frameId.getOptional("frameId")
+ /**
+ * If true, the server captures a cache entry and returns it to the client
+ *
+ * @throws StagehandInvalidDataException if the JSON field has an unexpected type (e.g. if
+ * the server responded with an unexpected value).
+ */
+ fun shouldCache(): Optional = shouldCache.getOptional("shouldCache")
+
/**
* Returns the raw JSON value of [agentConfig].
*
@@ -425,6 +463,15 @@ private constructor(
*/
@JsonProperty("frameId") @ExcludeMissing fun _frameId(): JsonField = frameId
+ /**
+ * Returns the raw JSON value of [shouldCache].
+ *
+ * Unlike [shouldCache], this method doesn't throw if the JSON field has an unexpected type.
+ */
+ @JsonProperty("shouldCache")
+ @ExcludeMissing
+ fun _shouldCache(): JsonField = shouldCache
+
@JsonAnySetter
private fun putAdditionalProperty(key: String, value: JsonValue) {
additionalProperties.put(key, value)
@@ -457,6 +504,7 @@ private constructor(
private var agentConfig: JsonField? = null
private var executeOptions: JsonField? = null
private var frameId: JsonField = JsonMissing.of()
+ private var shouldCache: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@JvmSynthetic
@@ -464,6 +512,7 @@ private constructor(
agentConfig = body.agentConfig
executeOptions = body.executeOptions
frameId = body.frameId
+ shouldCache = body.shouldCache
additionalProperties = body.additionalProperties.toMutableMap()
}
@@ -495,7 +544,10 @@ private constructor(
}
/** Target frame ID for the agent */
- fun frameId(frameId: String) = frameId(JsonField.of(frameId))
+ fun frameId(frameId: String?) = frameId(JsonField.ofNullable(frameId))
+
+ /** Alias for calling [Builder.frameId] with `frameId.orElse(null)`. */
+ fun frameId(frameId: Optional) = frameId(frameId.getOrNull())
/**
* Sets [Builder.frameId] to an arbitrary JSON value.
@@ -506,6 +558,20 @@ private constructor(
*/
fun frameId(frameId: JsonField) = apply { this.frameId = frameId }
+ /** If true, the server captures a cache entry and returns it to the client */
+ fun shouldCache(shouldCache: Boolean) = shouldCache(JsonField.of(shouldCache))
+
+ /**
+ * Sets [Builder.shouldCache] to an arbitrary JSON value.
+ *
+ * You should usually call [Builder.shouldCache] with a well-typed [Boolean] value
+ * instead. This method is primarily for setting the field to an undocumented or not yet
+ * supported value.
+ */
+ fun shouldCache(shouldCache: JsonField) = apply {
+ this.shouldCache = shouldCache
+ }
+
fun additionalProperties(additionalProperties: Map) = apply {
this.additionalProperties.clear()
putAllAdditionalProperties(additionalProperties)
@@ -543,6 +609,7 @@ private constructor(
checkRequired("agentConfig", agentConfig),
checkRequired("executeOptions", executeOptions),
frameId,
+ shouldCache,
additionalProperties.toMutableMap(),
)
}
@@ -557,6 +624,7 @@ private constructor(
agentConfig().validate()
executeOptions().validate()
frameId()
+ shouldCache()
validated = true
}
@@ -578,7 +646,8 @@ private constructor(
internal fun validity(): Int =
(agentConfig.asKnown().getOrNull()?.validity() ?: 0) +
(executeOptions.asKnown().getOrNull()?.validity() ?: 0) +
- (if (frameId.asKnown().isPresent) 1 else 0)
+ (if (frameId.asKnown().isPresent) 1 else 0) +
+ (if (shouldCache.asKnown().isPresent) 1 else 0)
override fun equals(other: Any?): Boolean {
if (this === other) {
@@ -589,24 +658,27 @@ private constructor(
agentConfig == other.agentConfig &&
executeOptions == other.executeOptions &&
frameId == other.frameId &&
+ shouldCache == other.shouldCache &&
additionalProperties == other.additionalProperties
}
private val hashCode: Int by lazy {
- Objects.hash(agentConfig, executeOptions, frameId, additionalProperties)
+ Objects.hash(agentConfig, executeOptions, frameId, shouldCache, additionalProperties)
}
override fun hashCode(): Int = hashCode
override fun toString() =
- "Body{agentConfig=$agentConfig, executeOptions=$executeOptions, frameId=$frameId, additionalProperties=$additionalProperties}"
+ "Body{agentConfig=$agentConfig, executeOptions=$executeOptions, frameId=$frameId, shouldCache=$shouldCache, additionalProperties=$additionalProperties}"
}
class AgentConfig
@JsonCreator(mode = JsonCreator.Mode.DISABLED)
private constructor(
private val cua: JsonField,
- private val model: JsonField,
+ private val executionModel: JsonField,
+ private val mode: JsonField,
+ private val model: JsonField,
private val provider: JsonField,
private val systemPrompt: JsonField,
private val additionalProperties: MutableMap,
@@ -615,17 +687,21 @@ private constructor(
@JsonCreator
private constructor(
@JsonProperty("cua") @ExcludeMissing cua: JsonField = JsonMissing.of(),
- @JsonProperty("model") @ExcludeMissing model: JsonField = JsonMissing.of(),
+ @JsonProperty("executionModel")
+ @ExcludeMissing
+ executionModel: JsonField = JsonMissing.of(),
+ @JsonProperty("mode") @ExcludeMissing mode: JsonField = JsonMissing.of(),
+ @JsonProperty("model") @ExcludeMissing model: JsonField = JsonMissing.of(),
@JsonProperty("provider")
@ExcludeMissing
provider: JsonField = JsonMissing.of(),
@JsonProperty("systemPrompt")
@ExcludeMissing
systemPrompt: JsonField = JsonMissing.of(),
- ) : this(cua, model, provider, systemPrompt, mutableMapOf())
+ ) : this(cua, executionModel, mode, model, provider, systemPrompt, mutableMapOf())
/**
- * Enable Computer Use Agent mode
+ * Deprecated. Use mode: 'cua' instead. If both are provided, mode takes precedence.
*
* @throws StagehandInvalidDataException if the JSON field has an unexpected type (e.g. if
* the server responded with an unexpected value).
@@ -633,13 +709,31 @@ private constructor(
fun cua(): Optional = cua.getOptional("cua")
/**
- * Model name string with provider prefix (e.g., 'openai/gpt-5-nano',
- * 'anthropic/claude-4.5-opus')
+ * Model configuration object or model name string (e.g., 'openai/gpt-5-nano') for tool
+ * execution (observe/act calls within agent tools). If not specified, inherits from the
+ * main model configuration.
*
* @throws StagehandInvalidDataException if the JSON field has an unexpected type (e.g. if
* the server responded with an unexpected value).
*/
- fun model(): Optional = model.getOptional("model")
+ fun executionModel(): Optional =
+ executionModel.getOptional("executionModel")
+
+ /**
+ * Tool mode for the agent (dom, hybrid, cua). If set, overrides cua.
+ *
+ * @throws StagehandInvalidDataException if the JSON field has an unexpected type (e.g. if
+ * the server responded with an unexpected value).
+ */
+ fun mode(): Optional = mode.getOptional("mode")
+
+ /**
+ * Model configuration object or model name string (e.g., 'openai/gpt-5-nano')
+ *
+ * @throws StagehandInvalidDataException if the JSON field has an unexpected type (e.g. if
+ * the server responded with an unexpected value).
+ */
+ fun model(): Optional = model.getOptional("model")
/**
* AI provider for the agent (legacy, use model: openai/gpt-5-nano instead)
@@ -664,12 +758,29 @@ private constructor(
*/
@JsonProperty("cua") @ExcludeMissing fun _cua(): JsonField = cua
+ /**
+ * Returns the raw JSON value of [executionModel].
+ *
+ * Unlike [executionModel], this method doesn't throw if the JSON field has an unexpected
+ * type.
+ */
+ @JsonProperty("executionModel")
+ @ExcludeMissing
+ fun _executionModel(): JsonField = executionModel
+
+ /**
+ * Returns the raw JSON value of [mode].
+ *
+ * Unlike [mode], this method doesn't throw if the JSON field has an unexpected type.
+ */
+ @JsonProperty("mode") @ExcludeMissing fun _mode(): JsonField = mode
+
/**
* Returns the raw JSON value of [model].
*
* Unlike [model], this method doesn't throw if the JSON field has an unexpected type.
*/
- @JsonProperty("model") @ExcludeMissing fun _model(): JsonField = model
+ @JsonProperty("model") @ExcludeMissing fun _model(): JsonField = model
/**
* Returns the raw JSON value of [provider].
@@ -710,7 +821,9 @@ private constructor(
class Builder internal constructor() {
private var cua: JsonField = JsonMissing.of()
- private var model: JsonField = JsonMissing.of()
+ private var executionModel: JsonField = JsonMissing.of()
+ private var mode: JsonField = JsonMissing.of()
+ private var model: JsonField = JsonMissing.of()
private var provider: JsonField = JsonMissing.of()
private var systemPrompt: JsonField = JsonMissing.of()
private var additionalProperties: MutableMap = mutableMapOf()
@@ -718,13 +831,15 @@ private constructor(
@JvmSynthetic
internal fun from(agentConfig: AgentConfig) = apply {
cua = agentConfig.cua
+ executionModel = agentConfig.executionModel
+ mode = agentConfig.mode
model = agentConfig.model
provider = agentConfig.provider
systemPrompt = agentConfig.systemPrompt
additionalProperties = agentConfig.additionalProperties.toMutableMap()
}
- /** Enable Computer Use Agent mode */
+ /** Deprecated. Use mode: 'cua' instead. If both are provided, mode takes precedence. */
fun cua(cua: Boolean) = cua(JsonField.of(cua))
/**
@@ -737,28 +852,62 @@ private constructor(
fun cua(cua: JsonField) = apply { this.cua = cua }
/**
- * Model name string with provider prefix (e.g., 'openai/gpt-5-nano',
- * 'anthropic/claude-4.5-opus')
+ * Model configuration object or model name string (e.g., 'openai/gpt-5-nano') for tool
+ * execution (observe/act calls within agent tools). If not specified, inherits from the
+ * main model configuration.
*/
- fun model(model: ModelConfig) = model(JsonField.of(model))
+ fun executionModel(executionModel: ExecutionModel) =
+ executionModel(JsonField.of(executionModel))
/**
- * Sets [Builder.model] to an arbitrary JSON value.
+ * Sets [Builder.executionModel] to an arbitrary JSON value.
*
- * You should usually call [Builder.model] with a well-typed [ModelConfig] value
- * instead. This method is primarily for setting the field to an undocumented or not yet
- * supported value.
+ * You should usually call [Builder.executionModel] with a well-typed [ExecutionModel]
+ * value instead. This method is primarily for setting the field to an undocumented or
+ * not yet supported value.
+ */
+ fun executionModel(executionModel: JsonField) = apply {
+ this.executionModel = executionModel
+ }
+
+ /**
+ * Alias for calling [executionModel] with `ExecutionModel.ofModelConfig(modelConfig)`.
*/
- fun model(model: JsonField) = apply { this.model = model }
+ fun executionModel(modelConfig: ModelConfig) =
+ executionModel(ExecutionModel.ofModelConfig(modelConfig))
- /** Alias for calling [model] with `ModelConfig.ofName(name)`. */
- fun model(name: String) = model(ModelConfig.ofName(name))
+ /** Alias for calling [executionModel] with `ExecutionModel.ofString(string)`. */
+ fun executionModel(string: String) = executionModel(ExecutionModel.ofString(string))
+
+ /** Tool mode for the agent (dom, hybrid, cua). If set, overrides cua. */
+ fun mode(mode: Mode) = mode(JsonField.of(mode))
/**
- * Alias for calling [model] with `ModelConfig.ofModelConfigObject(modelConfigObject)`.
+ * Sets [Builder.mode] to an arbitrary JSON value.
+ *
+ * You should usually call [Builder.mode] with a well-typed [Mode] value instead. This
+ * method is primarily for setting the field to an undocumented or not yet supported
+ * value.
*/
- fun model(modelConfigObject: ModelConfig.ModelConfigObject) =
- model(ModelConfig.ofModelConfigObject(modelConfigObject))
+ fun mode(mode: JsonField) = apply { this.mode = mode }
+
+ /** Model configuration object or model name string (e.g., 'openai/gpt-5-nano') */
+ fun model(model: Model) = model(JsonField.of(model))
+
+ /**
+ * Sets [Builder.model] to an arbitrary JSON value.
+ *
+ * You should usually call [Builder.model] with a well-typed [Model] value instead. This
+ * method is primarily for setting the field to an undocumented or not yet supported
+ * value.
+ */
+ fun model(model: JsonField) = apply { this.model = model }
+
+ /** Alias for calling [model] with `Model.ofConfig(config)`. */
+ fun model(config: ModelConfig) = model(Model.ofConfig(config))
+
+ /** Alias for calling [model] with `Model.ofString(string)`. */
+ fun model(string: String) = model(Model.ofString(string))
/** AI provider for the agent (legacy, use model: openai/gpt-5-nano instead) */
fun provider(provider: Provider) = provider(JsonField.of(provider))
@@ -811,7 +960,15 @@ private constructor(
* Further updates to this [Builder] will not mutate the returned instance.
*/
fun build(): AgentConfig =
- AgentConfig(cua, model, provider, systemPrompt, additionalProperties.toMutableMap())
+ AgentConfig(
+ cua,
+ executionModel,
+ mode,
+ model,
+ provider,
+ systemPrompt,
+ additionalProperties.toMutableMap(),
+ )
}
private var validated: Boolean = false
@@ -822,6 +979,8 @@ private constructor(
}
cua()
+ executionModel().ifPresent { it.validate() }
+ mode().ifPresent { it.validate() }
model().ifPresent { it.validate() }
provider().ifPresent { it.validate() }
systemPrompt()
@@ -845,10 +1004,500 @@ private constructor(
@JvmSynthetic
internal fun validity(): Int =
(if (cua.asKnown().isPresent) 1 else 0) +
+ (executionModel.asKnown().getOrNull()?.validity() ?: 0) +
+ (mode.asKnown().getOrNull()?.validity() ?: 0) +
(model.asKnown().getOrNull()?.validity() ?: 0) +
(provider.asKnown().getOrNull()?.validity() ?: 0) +
(if (systemPrompt.asKnown().isPresent) 1 else 0)
+ /**
+ * Model configuration object or model name string (e.g., 'openai/gpt-5-nano') for tool
+ * execution (observe/act calls within agent tools). If not specified, inherits from the
+ * main model configuration.
+ */
+ @JsonDeserialize(using = ExecutionModel.Deserializer::class)
+ @JsonSerialize(using = ExecutionModel.Serializer::class)
+ class ExecutionModel
+ private constructor(
+ private val modelConfig: ModelConfig? = null,
+ private val string: String? = null,
+ private val _json: JsonValue? = null,
+ ) {
+
+ fun modelConfig(): Optional = Optional.ofNullable(modelConfig)
+
+ fun string(): Optional = Optional.ofNullable(string)
+
+ fun isModelConfig(): Boolean = modelConfig != null
+
+ fun isString(): Boolean = string != null
+
+ fun asModelConfig(): ModelConfig = modelConfig.getOrThrow("modelConfig")
+
+ fun asString(): String = string.getOrThrow("string")
+
+ fun _json(): Optional = Optional.ofNullable(_json)
+
+ fun accept(visitor: Visitor): T =
+ when {
+ modelConfig != null -> visitor.visitModelConfig(modelConfig)
+ string != null -> visitor.visitString(string)
+ else -> visitor.unknown(_json)
+ }
+
+ private var validated: Boolean = false
+
+ fun validate(): ExecutionModel = apply {
+ if (validated) {
+ return@apply
+ }
+
+ accept(
+ object : Visitor {
+ override fun visitModelConfig(modelConfig: ModelConfig) {
+ modelConfig.validate()
+ }
+
+ override fun visitString(string: String) {}
+ }
+ )
+ validated = true
+ }
+
+ fun isValid(): Boolean =
+ try {
+ validate()
+ true
+ } catch (e: StagehandInvalidDataException) {
+ false
+ }
+
+ /**
+ * Returns a score indicating how many valid values are contained in this object
+ * recursively.
+ *
+ * Used for best match union deserialization.
+ */
+ @JvmSynthetic
+ internal fun validity(): Int =
+ accept(
+ object : Visitor {
+ override fun visitModelConfig(modelConfig: ModelConfig) =
+ modelConfig.validity()
+
+ override fun visitString(string: String) = 1
+
+ override fun unknown(json: JsonValue?) = 0
+ }
+ )
+
+ override fun equals(other: Any?): Boolean {
+ if (this === other) {
+ return true
+ }
+
+ return other is ExecutionModel &&
+ modelConfig == other.modelConfig &&
+ string == other.string
+ }
+
+ override fun hashCode(): Int = Objects.hash(modelConfig, string)
+
+ override fun toString(): String =
+ when {
+ modelConfig != null -> "ExecutionModel{modelConfig=$modelConfig}"
+ string != null -> "ExecutionModel{string=$string}"
+ _json != null -> "ExecutionModel{_unknown=$_json}"
+ else -> throw IllegalStateException("Invalid ExecutionModel")
+ }
+
+ companion object {
+
+ @JvmStatic
+ fun ofModelConfig(modelConfig: ModelConfig) =
+ ExecutionModel(modelConfig = modelConfig)
+
+ @JvmStatic fun ofString(string: String) = ExecutionModel(string = string)
+ }
+
+ /**
+ * An interface that defines how to map each variant of [ExecutionModel] to a value of
+ * type [T].
+ */
+ interface Visitor {
+
+ fun visitModelConfig(modelConfig: ModelConfig): T
+
+ fun visitString(string: String): T
+
+ /**
+ * Maps an unknown variant of [ExecutionModel] to a value of type [T].
+ *
+ * An instance of [ExecutionModel] can contain an unknown variant if it was
+ * deserialized from data that doesn't match any known variant. For example, if the
+ * SDK is on an older version than the API, then the API may respond with new
+ * variants that the SDK is unaware of.
+ *
+ * @throws StagehandInvalidDataException in the default implementation.
+ */
+ fun unknown(json: JsonValue?): T {
+ throw StagehandInvalidDataException("Unknown ExecutionModel: $json")
+ }
+ }
+
+ internal class Deserializer : BaseDeserializer(ExecutionModel::class) {
+
+ override fun ObjectCodec.deserialize(node: JsonNode): ExecutionModel {
+ val json = JsonValue.fromJsonNode(node)
+
+ val bestMatches =
+ sequenceOf(
+ tryDeserialize(node, jacksonTypeRef())?.let {
+ ExecutionModel(modelConfig = it, _json = json)
+ },
+ tryDeserialize(node, jacksonTypeRef())?.let {
+ ExecutionModel(string = it, _json = json)
+ },
+ )
+ .filterNotNull()
+ .allMaxBy { it.validity() }
+ .toList()
+ return when (bestMatches.size) {
+ // This can happen if what we're deserializing is completely incompatible
+ // with all the possible variants (e.g. deserializing from boolean).
+ 0 -> ExecutionModel(_json = json)
+ 1 -> bestMatches.single()
+ // If there's more than one match with the highest validity, then use the
+ // first completely valid match, or simply the first match if none are
+ // completely valid.
+ else -> bestMatches.firstOrNull { it.isValid() } ?: bestMatches.first()
+ }
+ }
+ }
+
+ internal class Serializer : BaseSerializer(ExecutionModel::class) {
+
+ override fun serialize(
+ value: ExecutionModel,
+ generator: JsonGenerator,
+ provider: SerializerProvider,
+ ) {
+ when {
+ value.modelConfig != null -> generator.writeObject(value.modelConfig)
+ value.string != null -> generator.writeObject(value.string)
+ value._json != null -> generator.writeObject(value._json)
+ else -> throw IllegalStateException("Invalid ExecutionModel")
+ }
+ }
+ }
+ }
+
+ /** Tool mode for the agent (dom, hybrid, cua). If set, overrides cua. */
+ class Mode @JsonCreator private constructor(private val value: JsonField) : Enum {
+
+ /**
+ * Returns this class instance's raw value.
+ *
+ * This is usually only useful if this instance was deserialized from data that doesn't
+ * match any known member, and you want to know that value. For example, if the SDK is
+ * on an older version than the API, then the API may respond with new members that the
+ * SDK is unaware of.
+ */
+ @com.fasterxml.jackson.annotation.JsonValue fun _value(): JsonField = value
+
+ companion object {
+
+ @JvmField val DOM = of("dom")
+
+ @JvmField val HYBRID = of("hybrid")
+
+ @JvmField val CUA = of("cua")
+
+ @JvmStatic fun of(value: String) = Mode(JsonField.of(value))
+ }
+
+ /** An enum containing [Mode]'s known values. */
+ enum class Known {
+ DOM,
+ HYBRID,
+ CUA,
+ }
+
+ /**
+ * An enum containing [Mode]'s known values, as well as an [_UNKNOWN] member.
+ *
+ * An instance of [Mode] can contain an unknown value in a couple of cases:
+ * - It was deserialized from data that doesn't match any known member. For example, if
+ * the SDK is on an older version than the API, then the API may respond with new
+ * members that the SDK is unaware of.
+ * - It was constructed with an arbitrary value using the [of] method.
+ */
+ enum class Value {
+ DOM,
+ HYBRID,
+ CUA,
+ /** An enum member indicating that [Mode] was instantiated with an unknown value. */
+ _UNKNOWN,
+ }
+
+ /**
+ * Returns an enum member corresponding to this class instance's value, or
+ * [Value._UNKNOWN] if the class was instantiated with an unknown value.
+ *
+ * Use the [known] method instead if you're certain the value is always known or if you
+ * want to throw for the unknown case.
+ */
+ fun value(): Value =
+ when (this) {
+ DOM -> Value.DOM
+ HYBRID -> Value.HYBRID
+ CUA -> Value.CUA
+ else -> Value._UNKNOWN
+ }
+
+ /**
+ * Returns an enum member corresponding to this class instance's value.
+ *
+ * Use the [value] method instead if you're uncertain the value is always known and
+ * don't want to throw for the unknown case.
+ *
+ * @throws StagehandInvalidDataException if this class instance's value is a not a known
+ * member.
+ */
+ fun known(): Known =
+ when (this) {
+ DOM -> Known.DOM
+ HYBRID -> Known.HYBRID
+ CUA -> Known.CUA
+ else -> throw StagehandInvalidDataException("Unknown Mode: $value")
+ }
+
+ /**
+ * Returns this class instance's primitive wire representation.
+ *
+ * This differs from the [toString] method because that method is primarily for
+ * debugging and generally doesn't throw.
+ *
+ * @throws StagehandInvalidDataException if this class instance's value does not have
+ * the expected primitive type.
+ */
+ fun asString(): String =
+ _value().asString().orElseThrow {
+ StagehandInvalidDataException("Value is not a String")
+ }
+
+ private var validated: Boolean = false
+
+ fun validate(): Mode = apply {
+ if (validated) {
+ return@apply
+ }
+
+ known()
+ validated = true
+ }
+
+ fun isValid(): Boolean =
+ try {
+ validate()
+ true
+ } catch (e: StagehandInvalidDataException) {
+ false
+ }
+
+ /**
+ * Returns a score indicating how many valid values are contained in this object
+ * recursively.
+ *
+ * Used for best match union deserialization.
+ */
+ @JvmSynthetic internal fun validity(): Int = if (value() == Value._UNKNOWN) 0 else 1
+
+ override fun equals(other: Any?): Boolean {
+ if (this === other) {
+ return true
+ }
+
+ return other is Mode && value == other.value
+ }
+
+ override fun hashCode() = value.hashCode()
+
+ override fun toString() = value.toString()
+ }
+
+ /** Model configuration object or model name string (e.g., 'openai/gpt-5-nano') */
+ @JsonDeserialize(using = Model.Deserializer::class)
+ @JsonSerialize(using = Model.Serializer::class)
+ class Model
+ private constructor(
+ private val config: ModelConfig? = null,
+ private val string: String? = null,
+ private val _json: JsonValue? = null,
+ ) {
+
+ fun config(): Optional = Optional.ofNullable(config)
+
+ fun string(): Optional = Optional.ofNullable(string)
+
+ fun isConfig(): Boolean = config != null
+
+ fun isString(): Boolean = string != null
+
+ fun asConfig(): ModelConfig = config.getOrThrow("config")
+
+ fun asString(): String = string.getOrThrow("string")
+
+ fun _json(): Optional = Optional.ofNullable(_json)
+
+ fun accept(visitor: Visitor): T =
+ when {
+ config != null -> visitor.visitConfig(config)
+ string != null -> visitor.visitString(string)
+ else -> visitor.unknown(_json)
+ }
+
+ private var validated: Boolean = false
+
+ fun validate(): Model = apply {
+ if (validated) {
+ return@apply
+ }
+
+ accept(
+ object : Visitor {
+ override fun visitConfig(config: ModelConfig) {
+ config.validate()
+ }
+
+ override fun visitString(string: String) {}
+ }
+ )
+ validated = true
+ }
+
+ fun isValid(): Boolean =
+ try {
+ validate()
+ true
+ } catch (e: StagehandInvalidDataException) {
+ false
+ }
+
+ /**
+ * Returns a score indicating how many valid values are contained in this object
+ * recursively.
+ *
+ * Used for best match union deserialization.
+ */
+ @JvmSynthetic
+ internal fun validity(): Int =
+ accept(
+ object : Visitor {
+ override fun visitConfig(config: ModelConfig) = config.validity()
+
+ override fun visitString(string: String) = 1
+
+ override fun unknown(json: JsonValue?) = 0
+ }
+ )
+
+ override fun equals(other: Any?): Boolean {
+ if (this === other) {
+ return true
+ }
+
+ return other is Model && config == other.config && string == other.string
+ }
+
+ override fun hashCode(): Int = Objects.hash(config, string)
+
+ override fun toString(): String =
+ when {
+ config != null -> "Model{config=$config}"
+ string != null -> "Model{string=$string}"
+ _json != null -> "Model{_unknown=$_json}"
+ else -> throw IllegalStateException("Invalid Model")
+ }
+
+ companion object {
+
+ @JvmStatic fun ofConfig(config: ModelConfig) = Model(config = config)
+
+ @JvmStatic fun ofString(string: String) = Model(string = string)
+ }
+
+ /**
+ * An interface that defines how to map each variant of [Model] to a value of type [T].
+ */
+ interface Visitor {
+
+ fun visitConfig(config: ModelConfig): T
+
+ fun visitString(string: String): T
+
+ /**
+ * Maps an unknown variant of [Model] to a value of type [T].
+ *
+ * An instance of [Model] can contain an unknown variant if it was deserialized from
+ * data that doesn't match any known variant. For example, if the SDK is on an older
+ * version than the API, then the API may respond with new variants that the SDK is
+ * unaware of.
+ *
+ * @throws StagehandInvalidDataException in the default implementation.
+ */
+ fun unknown(json: JsonValue?): T {
+ throw StagehandInvalidDataException("Unknown Model: $json")
+ }
+ }
+
+ internal class Deserializer : BaseDeserializer(Model::class) {
+
+ override fun ObjectCodec.deserialize(node: JsonNode): Model {
+ val json = JsonValue.fromJsonNode(node)
+
+ val bestMatches =
+ sequenceOf(
+ tryDeserialize(node, jacksonTypeRef())?.let {
+ Model(config = it, _json = json)
+ },
+ tryDeserialize(node, jacksonTypeRef())?.let {
+ Model(string = it, _json = json)
+ },
+ )
+ .filterNotNull()
+ .allMaxBy { it.validity() }
+ .toList()
+ return when (bestMatches.size) {
+ // This can happen if what we're deserializing is completely incompatible
+ // with all the possible variants (e.g. deserializing from boolean).
+ 0 -> Model(_json = json)
+ 1 -> bestMatches.single()
+ // If there's more than one match with the highest validity, then use the
+ // first completely valid match, or simply the first match if none are
+ // completely valid.
+ else -> bestMatches.firstOrNull { it.isValid() } ?: bestMatches.first()
+ }
+ }
+ }
+
+ internal class Serializer : BaseSerializer(Model::class) {
+
+ override fun serialize(
+ value: Model,
+ generator: JsonGenerator,
+ provider: SerializerProvider,
+ ) {
+ when {
+ value.config != null -> generator.writeObject(value.config)
+ value.string != null -> generator.writeObject(value.string)
+ value._json != null -> generator.writeObject(value._json)
+ else -> throw IllegalStateException("Invalid Model")
+ }
+ }
+ }
+ }
+
/** AI provider for the agent (legacy, use model: openai/gpt-5-nano instead) */
class Provider @JsonCreator private constructor(private val value: JsonField) :
Enum {
@@ -999,6 +1648,8 @@ private constructor(
return other is AgentConfig &&
cua == other.cua &&
+ executionModel == other.executionModel &&
+ mode == other.mode &&
model == other.model &&
provider == other.provider &&
systemPrompt == other.systemPrompt &&
@@ -1006,13 +1657,21 @@ private constructor(
}
private val hashCode: Int by lazy {
- Objects.hash(cua, model, provider, systemPrompt, additionalProperties)
+ Objects.hash(
+ cua,
+ executionModel,
+ mode,
+ model,
+ provider,
+ systemPrompt,
+ additionalProperties,
+ )
}
override fun hashCode(): Int = hashCode
override fun toString() =
- "AgentConfig{cua=$cua, model=$model, provider=$provider, systemPrompt=$systemPrompt, additionalProperties=$additionalProperties}"
+ "AgentConfig{cua=$cua, executionModel=$executionModel, mode=$mode, model=$model, provider=$provider, systemPrompt=$systemPrompt, additionalProperties=$additionalProperties}"
}
class ExecuteOptions
@@ -1401,7 +2060,6 @@ private constructor(
return other is SessionExecuteParams &&
id == other.id &&
- xSentAt == other.xSentAt &&
xStreamResponse == other.xStreamResponse &&
body == other.body &&
additionalHeaders == other.additionalHeaders &&
@@ -1409,8 +2067,8 @@ private constructor(
}
override fun hashCode(): Int =
- Objects.hash(id, xSentAt, xStreamResponse, body, additionalHeaders, additionalQueryParams)
+ Objects.hash(id, xStreamResponse, body, additionalHeaders, additionalQueryParams)
override fun toString() =
- "SessionExecuteParams{id=$id, xSentAt=$xSentAt, xStreamResponse=$xStreamResponse, body=$body, additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams}"
+ "SessionExecuteParams{id=$id, xStreamResponse=$xStreamResponse, body=$body, additionalHeaders=$additionalHeaders, additionalQueryParams=$additionalQueryParams}"
}
diff --git a/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionExecuteResponse.kt b/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionExecuteResponse.kt
index 8718994..9b16655 100644
--- a/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionExecuteResponse.kt
+++ b/stagehand-java-core/src/main/kotlin/com/browserbase/api/models/sessions/SessionExecuteResponse.kt
@@ -195,13 +195,17 @@ private constructor(
@JsonCreator(mode = JsonCreator.Mode.DISABLED)
private constructor(
private val result: JsonField,
+ private val cacheEntry: JsonField,
private val additionalProperties: MutableMap,
) {
@JsonCreator
private constructor(
- @JsonProperty("result") @ExcludeMissing result: JsonField