Constructor Detail

Method Detail

• body

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

  • assistantId

  • instructions

  • maxCompletionTokens

  • maxPromptTokens

  • metadata

  • etc.

• assistantId

   final ThreadCreateAndRunParams.Builder assistantId(String assistantId)

  The ID of the assistant to use to execute this run.

• assistantId

   final ThreadCreateAndRunParams.Builder assistantId(JsonField<String> assistantId)

  Sets Builder.assistantId to an arbitrary JSON value.

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

• instructions

   final ThreadCreateAndRunParams.Builder instructions(String instructions)

  Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.

• instructions

   final ThreadCreateAndRunParams.Builder instructions(Optional<String> instructions)

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

• instructions

   final ThreadCreateAndRunParams.Builder instructions(JsonField<String> instructions)

  Sets Builder.instructions to an arbitrary JSON value.

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

• maxCompletionTokens

   final ThreadCreateAndRunParams.Builder maxCompletionTokens(Long maxCompletionTokens)

  The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status incomplete. See incomplete_details for more info.

• maxCompletionTokens

   final ThreadCreateAndRunParams.Builder maxCompletionTokens(Long maxCompletionTokens)

  Alias for Builder.maxCompletionTokens.

  This unboxed primitive overload exists for backwards compatibility.

• maxCompletionTokens

   final ThreadCreateAndRunParams.Builder maxCompletionTokens(Optional<Long> maxCompletionTokens)

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

• maxCompletionTokens

   final ThreadCreateAndRunParams.Builder maxCompletionTokens(JsonField<Long> maxCompletionTokens)

  Sets Builder.maxCompletionTokens to an arbitrary JSON value.

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

• maxPromptTokens

   final ThreadCreateAndRunParams.Builder maxPromptTokens(Long maxPromptTokens)

  The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status incomplete. See incomplete_details for more info.

• maxPromptTokens

   final ThreadCreateAndRunParams.Builder maxPromptTokens(Long maxPromptTokens)

  Alias for Builder.maxPromptTokens.

  This unboxed primitive overload exists for backwards compatibility.

• maxPromptTokens

   final ThreadCreateAndRunParams.Builder maxPromptTokens(Optional<Long> maxPromptTokens)

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

• maxPromptTokens

   final ThreadCreateAndRunParams.Builder maxPromptTokens(JsonField<Long> maxPromptTokens)

  Sets Builder.maxPromptTokens to an arbitrary JSON value.

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

• metadata

   final ThreadCreateAndRunParams.Builder metadata(ThreadCreateAndRunParams.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 ThreadCreateAndRunParams.Builder metadata(Optional<ThreadCreateAndRunParams.Metadata> metadata)

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

• metadata

   final ThreadCreateAndRunParams.Builder metadata(JsonField<ThreadCreateAndRunParams.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.

• model

   final ThreadCreateAndRunParams.Builder model(ChatModel model)

  The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.

• model

   final ThreadCreateAndRunParams.Builder model(Optional<ChatModel> model)

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

• model

   final ThreadCreateAndRunParams.Builder model(JsonField<ChatModel> model)

  Sets Builder.model to an arbitrary JSON value.

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

• model

   final ThreadCreateAndRunParams.Builder model(String value)

  Sets model to an arbitrary String.

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

• parallelToolCalls

   final ThreadCreateAndRunParams.Builder parallelToolCalls(Boolean parallelToolCalls)

  Whether to enable parallel function calling during tool use.

• parallelToolCalls

   final ThreadCreateAndRunParams.Builder parallelToolCalls(JsonField<Boolean> parallelToolCalls)

  Sets Builder.parallelToolCalls to an arbitrary JSON value.

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

• responseFormat

   final ThreadCreateAndRunParams.Builder responseFormat(AssistantResponseFormatOption responseFormat)

  Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 * Turbo, and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.

  Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

  Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

  Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

• responseFormat

   final ThreadCreateAndRunParams.Builder responseFormat(Optional<AssistantResponseFormatOption> responseFormat)

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

• responseFormat

   final ThreadCreateAndRunParams.Builder responseFormat(JsonField<AssistantResponseFormatOption> responseFormat)

  Sets Builder.responseFormat to an arbitrary JSON value.

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

• responseFormat

   final ThreadCreateAndRunParams.Builder responseFormat(ResponseFormatText responseFormatText)

  Alias for calling responseFormat with AssistantResponseFormatOption.ofResponseFormatText(responseFormatText).

• responseFormat

   final ThreadCreateAndRunParams.Builder responseFormat(ResponseFormatJsonObject responseFormatJsonObject)

  Alias for calling responseFormat with AssistantResponseFormatOption.ofResponseFormatJsonObject(responseFormatJsonObject).

• responseFormat

   final ThreadCreateAndRunParams.Builder responseFormat(ResponseFormatJsonSchema responseFormatJsonSchema)

  Alias for calling responseFormat with AssistantResponseFormatOption.ofResponseFormatJsonSchema(responseFormatJsonSchema).

• responseFormatAuto

   final ThreadCreateAndRunParams.Builder responseFormatAuto()

  Alias for calling responseFormat with AssistantResponseFormatOption.ofAuto().

• temperature

   final ThreadCreateAndRunParams.Builder temperature(Double temperature)

  What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

• temperature

   final ThreadCreateAndRunParams.Builder temperature(Double temperature)

  Alias for Builder.temperature.

  This unboxed primitive overload exists for backwards compatibility.

• temperature

   final ThreadCreateAndRunParams.Builder temperature(Optional<Double> temperature)

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

• temperature

   final ThreadCreateAndRunParams.Builder temperature(JsonField<Double> temperature)

  Sets Builder.temperature to an arbitrary JSON value.

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

• thread

   final ThreadCreateAndRunParams.Builder thread(ThreadCreateAndRunParams.Thread thread)

  Options to create a new thread. If no thread is provided when running a request, an empty thread will be created.

• thread

   final ThreadCreateAndRunParams.Builder thread(JsonField<ThreadCreateAndRunParams.Thread> thread)

  Sets Builder.thread to an arbitrary JSON value.

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

• toolChoice

   final ThreadCreateAndRunParams.Builder toolChoice(AssistantToolChoiceOption toolChoice)

  Controls which (if any) tool is called by the model. none means the model will not call any tools and instead generates a message. auto is the default value and means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools before responding to the user. Specifying a particular tool like {"type": "file_search"} or {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

• toolChoice

   final ThreadCreateAndRunParams.Builder toolChoice(Optional<AssistantToolChoiceOption> toolChoice)

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

• toolChoice

   final ThreadCreateAndRunParams.Builder toolChoice(JsonField<AssistantToolChoiceOption> toolChoice)

  Sets Builder.toolChoice to an arbitrary JSON value.

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

• toolChoice

   final ThreadCreateAndRunParams.Builder toolChoice(AssistantToolChoiceOption.Auto auto)

  Alias for calling toolChoice with AssistantToolChoiceOption.ofAuto(auto).

• toolChoice

   final ThreadCreateAndRunParams.Builder toolChoice(AssistantToolChoice assistantToolChoice)

  Alias for calling toolChoice with AssistantToolChoiceOption.ofAssistantToolChoice(assistantToolChoice).

• toolResources

   final ThreadCreateAndRunParams.Builder toolResources(ThreadCreateAndRunParams.ToolResources toolResources)

  A set of resources that are used by the assistant's tools. 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 ThreadCreateAndRunParams.Builder toolResources(Optional<ThreadCreateAndRunParams.ToolResources> toolResources)

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

• toolResources

   final ThreadCreateAndRunParams.Builder toolResources(JsonField<ThreadCreateAndRunParams.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.

• tools

   final ThreadCreateAndRunParams.Builder tools(List<AssistantTool> tools)

  Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.

• tools

   final ThreadCreateAndRunParams.Builder tools(Optional<List<AssistantTool>> tools)

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

• tools

   final ThreadCreateAndRunParams.Builder tools(JsonField<List<AssistantTool>> tools)

  Sets Builder.tools to an arbitrary JSON value.

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

• addTool

   final ThreadCreateAndRunParams.Builder addTool(AssistantTool tool)

  Adds a single AssistantTool to tools.

• addTool

   final ThreadCreateAndRunParams.Builder addTool(CodeInterpreterTool codeInterpreter)

  Alias for calling addTool with AssistantTool.ofCodeInterpreter(codeInterpreter).

• addTool

   final ThreadCreateAndRunParams.Builder addTool(FileSearchTool fileSearch)

  Alias for calling addTool with AssistantTool.ofFileSearch(fileSearch).

• addTool

   final ThreadCreateAndRunParams.Builder addTool(FunctionTool function)

  Alias for calling addTool with AssistantTool.ofFunction(function).

• addFunctionTool

   final ThreadCreateAndRunParams.Builder addFunctionTool(FunctionDefinition function)

  Alias for calling addTool with the following:

  FunctionTool.builder()
      .function(function)
      .build()

• topP

   final ThreadCreateAndRunParams.Builder topP(Double topP)

  An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

  We generally recommend altering this or temperature but not both.

• topP

   final ThreadCreateAndRunParams.Builder topP(Double topP)

  Alias for Builder.topP.

  This unboxed primitive overload exists for backwards compatibility.

• topP

   final ThreadCreateAndRunParams.Builder topP(Optional<Double> topP)

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

• topP

   final ThreadCreateAndRunParams.Builder topP(JsonField<Double> topP)

  Sets Builder.topP to an arbitrary JSON value.

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

• truncationStrategy

   final ThreadCreateAndRunParams.Builder truncationStrategy(ThreadCreateAndRunParams.TruncationStrategy truncationStrategy)

  Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.

• truncationStrategy

   final ThreadCreateAndRunParams.Builder truncationStrategy(Optional<ThreadCreateAndRunParams.TruncationStrategy> truncationStrategy)

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

• truncationStrategy

   final ThreadCreateAndRunParams.Builder truncationStrategy(JsonField<ThreadCreateAndRunParams.TruncationStrategy> truncationStrategy)

  Sets Builder.truncationStrategy to an arbitrary JSON value.

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

• additionalBodyProperties

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

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final ThreadCreateAndRunParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

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

• additionalHeaders

   final ThreadCreateAndRunParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final ThreadCreateAndRunParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final ThreadCreateAndRunParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final ThreadCreateAndRunParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final ThreadCreateAndRunParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final ThreadCreateAndRunParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final ThreadCreateAndRunParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final ThreadCreateAndRunParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final ThreadCreateAndRunParams build()

  Returns an immutable instance of ThreadCreateAndRunParams.

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

  The following fields are required:

  .assistantId()