All Implemented Interfaces:

com.browserbase.api.core.Params
```
public final class SessionExtractParams
 implements Params
                    
```
Extracts structured data from the current page using AI-powered analysis.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`SessionExtractParams.Builder`	A builder for SessionExtractParams.
`public final class`	`SessionExtractParams.Body`
`public final class`	`SessionExtractParams.Options`
`public final class`	`SessionExtractParams.Schema`	JSON Schema defining the structure of data to extract
`public final class`	`SessionExtractParams.XStreamResponse`	Whether to stream the response via SSE

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<String>`	`id()`	Unique session identifier
`final Optional<SessionExtractParams.XStreamResponse>`	`xStreamResponse()`	Whether to stream the response via SSE
`final Optional<String>`	`frameId()`	Target frame ID for the extraction
`final Optional<String>`	`instruction()`	Natural language instruction for what to extract
`final Optional<SessionExtractParams.Options>`	`options()`
`final Optional<SessionExtractParams.Schema>`	`schema()`	JSON Schema defining the structure of data to extract
`final JsonField<String>`	`_frameId()`	Returns the raw JSON value of frameId.
`final JsonField<String>`	`_instruction()`	Returns the raw JSON value of instruction.
`final JsonField<SessionExtractParams.Options>`	`_options()`	Returns the raw JSON value of options.
`final JsonField<SessionExtractParams.Schema>`	`_schema()`	Returns the raw JSON value of schema.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final SessionExtractParams.Builder`	`toBuilder()`
`final SessionExtractParams.Body`	`_body()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static SessionExtractParams`	`none()`
`final static SessionExtractParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of SessionExtractParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - id
```
 final Optional<String> id()
```
    Unique session identifier
  - xStreamResponse
```
 final Optional<SessionExtractParams.XStreamResponse> xStreamResponse()
```
    Whether to stream the response via SSE
  - frameId
```
 final Optional<String> frameId()
```
    Target frame ID for the extraction
  - instruction
```
 final Optional<String> instruction()
```
    Natural language instruction for what to extract
  - options
```
 final Optional<SessionExtractParams.Options> options()
```
  - schema
```
 final Optional<SessionExtractParams.Schema> schema()
```
    JSON Schema defining the structure of data to extract
  - _frameId
```
 final JsonField<String> _frameId()
```
    Returns the raw JSON value of frameId.
    Unlike frameId, this method doesn't throw if the JSON field has an unexpected type.
  - _instruction
```
 final JsonField<String> _instruction()
```
    Returns the raw JSON value of instruction.
    Unlike instruction, this method doesn't throw if the JSON field has an unexpected type.
  - _options
```
 final JsonField<SessionExtractParams.Options> _options()
```
    Returns the raw JSON value of options.
    Unlike options, this method doesn't throw if the JSON field has an unexpected type.
  - _schema
```
 final JsonField<SessionExtractParams.Schema> _schema()
```
    Returns the raw JSON value of schema.
    Unlike schema, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final SessionExtractParams.Builder toBuilder()
```
  - _body
```
 final SessionExtractParams.Body _body()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - none
```
 final static SessionExtractParams none()
```
  - builder
```
 final static SessionExtractParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of SessionExtractParams.

Class SessionExtractParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

xStreamResponse

frameId

instruction

options

schema

_frameId

_instruction

_options

_schema

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_pathParam

_headers

_queryParams

equals

hashCode

toString

none

builder