Constructor Detail

Method Detail

• id

   final SessionExtractParams.Builder id(String id)

  Unique session identifier

• id

   final SessionExtractParams.Builder id(Optional<String> id)

  Alias for calling Builder.id with id.orElse(null).

• xStreamResponse

   final SessionExtractParams.Builder xStreamResponse(SessionExtractParams.XStreamResponse xStreamResponse)

  Whether to stream the response via SSE

• xStreamResponse

   final SessionExtractParams.Builder xStreamResponse(Optional<SessionExtractParams.XStreamResponse> xStreamResponse)

  Alias for calling Builder.xStreamResponse with xStreamResponse.orElse(null).

• body

   final SessionExtractParams.Builder body(SessionExtractParams.Body body)

  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:

  • frameId

  • instruction

  • options

  • schema

• frameId

   final SessionExtractParams.Builder frameId(String frameId)

  Target frame ID for the extraction

• frameId

   final SessionExtractParams.Builder frameId(Optional<String> frameId)

  Alias for calling Builder.frameId with frameId.orElse(null).

• frameId

   final SessionExtractParams.Builder frameId(JsonField<String> frameId)

  Sets Builder.frameId to an arbitrary JSON value.

  You should usually call Builder.frameId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• instruction

   final SessionExtractParams.Builder instruction(String instruction)

  Natural language instruction for what to extract

• instruction

   final SessionExtractParams.Builder instruction(JsonField<String> instruction)

  Sets Builder.instruction to an arbitrary JSON value.

  You should usually call Builder.instruction with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• options

   final SessionExtractParams.Builder options(SessionExtractParams.Options options)

• options

   final SessionExtractParams.Builder options(JsonField<SessionExtractParams.Options> options)

  Sets Builder.options to an arbitrary JSON value.

  You should usually call Builder.options with a well-typed Options value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• schema

   final SessionExtractParams.Builder schema(SessionExtractParams.Schema schema)

  JSON Schema defining the structure of data to extract

• schema

   final SessionExtractParams.Builder schema(JsonField<SessionExtractParams.Schema> schema)

  Sets Builder.schema to an arbitrary JSON value.

  You should usually call Builder.schema with a well-typed Schema value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final SessionExtractParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final SessionExtractParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final SessionExtractParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final SessionExtractParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final SessionExtractParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final SessionExtractParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final SessionExtractParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final SessionExtractParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final SessionExtractParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final SessionExtractParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final SessionExtractParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final SessionExtractParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final SessionExtractParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final SessionExtractParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final SessionExtractParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final SessionExtractParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final SessionExtractParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final SessionExtractParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final SessionExtractParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final SessionExtractParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final SessionExtractParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final SessionExtractParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final SessionExtractParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final SessionExtractParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final SessionExtractParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final SessionExtractParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final SessionExtractParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final SessionExtractParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final SessionExtractParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final SessionExtractParams build()

  Returns an immutable instance of SessionExtractParams.

  Further updates to this Builder will not mutate the returned instance.