Constructor Detail

Method Detail

• body

   final ThreadCreateParams.Builder body(ThreadCreateParams.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:

  • messages

  • metadata

  • toolResources

• messages

   final ThreadCreateParams.Builder messages(List<ThreadCreateParams.Message> messages)

  A list of messages to start the thread with.

• messages

   final ThreadCreateParams.Builder messages(JsonField<List<ThreadCreateParams.Message>> messages)

  Sets Builder.messages to an arbitrary JSON value.

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

• addMessage

   final ThreadCreateParams.Builder addMessage(ThreadCreateParams.Message message)

  Adds a single Message to messages.

• metadata

   final ThreadCreateParams.Builder metadata(ThreadCreateParams.Metadata metadata)

  Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

  Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

• metadata

   final ThreadCreateParams.Builder metadata(Optional<ThreadCreateParams.Metadata> metadata)

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

• metadata

   final ThreadCreateParams.Builder metadata(JsonField<ThreadCreateParams.Metadata> metadata)

  Sets Builder.metadata to an arbitrary JSON value.

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

• toolResources

   final ThreadCreateParams.Builder toolResources(ThreadCreateParams.ToolResources toolResources)

  A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the code_interpreter tool requires a list of file IDs, while the file_search tool requires a list of vector store IDs.

• toolResources

   final ThreadCreateParams.Builder toolResources(Optional<ThreadCreateParams.ToolResources> toolResources)

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

• toolResources

   final ThreadCreateParams.Builder toolResources(JsonField<ThreadCreateParams.ToolResources> toolResources)

  Sets Builder.toolResources to an arbitrary JSON value.

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

• additionalBodyProperties

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

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final ThreadCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

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

• additionalHeaders

   final ThreadCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final ThreadCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final ThreadCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final ThreadCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final ThreadCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final ThreadCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final ThreadCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final ThreadCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final ThreadCreateParams build()

  Returns an immutable instance of ThreadCreateParams.

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