Constructor Detail

Method Detail

• model

   final BetaAssistantCreateParams.Body.Builder model(ChatModel model)

  ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

• model

   final BetaAssistantCreateParams.Body.Builder model(JsonField<ChatModel> model)

  ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

• model

   final BetaAssistantCreateParams.Body.Builder model(String value)

  ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

• description

   final BetaAssistantCreateParams.Body.Builder description(String description)

  The description of the assistant. The maximum length is 512 characters.

• description

   final BetaAssistantCreateParams.Body.Builder description(Optional<String> description)

  The description of the assistant. The maximum length is 512 characters.

• description

   final BetaAssistantCreateParams.Body.Builder description(JsonField<String> description)

  The description of the assistant. The maximum length is 512 characters.

• instructions

   final BetaAssistantCreateParams.Body.Builder instructions(String instructions)

  The system instructions that the assistant uses. The maximum length is 256,000 characters.

• instructions

   final BetaAssistantCreateParams.Body.Builder instructions(Optional<String> instructions)

  The system instructions that the assistant uses. The maximum length is 256,000 characters.

• instructions

   final BetaAssistantCreateParams.Body.Builder instructions(JsonField<String> instructions)

  The system instructions that the assistant uses. The maximum length is 256,000 characters.

• metadata

   final BetaAssistantCreateParams.Body.Builder metadata(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 BetaAssistantCreateParams.Body.Builder metadata(Optional<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 BetaAssistantCreateParams.Body.Builder metadata(JsonField<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.

• name

   final BetaAssistantCreateParams.Body.Builder name(String name)

  The name of the assistant. The maximum length is 256 characters.

• name

   final BetaAssistantCreateParams.Body.Builder name(Optional<String> name)

  The name of the assistant. The maximum length is 256 characters.

• name

   final BetaAssistantCreateParams.Body.Builder name(JsonField<String> name)

  The name of the assistant. The maximum length is 256 characters.

• reasoningEffort

   final BetaAssistantCreateParams.Body.Builder reasoningEffort(BetaAssistantCreateParams.ReasoningEffort reasoningEffort)

  o1 and o3-mini models only

  Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

• reasoningEffort

   final BetaAssistantCreateParams.Body.Builder reasoningEffort(Optional<BetaAssistantCreateParams.ReasoningEffort> reasoningEffort)

  o1 and o3-mini models only

  Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

• reasoningEffort

   final BetaAssistantCreateParams.Body.Builder reasoningEffort(JsonField<BetaAssistantCreateParams.ReasoningEffort> reasoningEffort)

  o1 and o3-mini models only

  Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.

• responseFormat

   final BetaAssistantCreateParams.Body.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 BetaAssistantCreateParams.Body.Builder responseFormat(Optional<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 BetaAssistantCreateParams.Body.Builder responseFormat(JsonField<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 BetaAssistantCreateParams.Body.Builder responseFormat(ResponseFormatText responseFormatText)

  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 BetaAssistantCreateParams.Body.Builder responseFormat(ResponseFormatJsonObject responseFormatJsonObject)

  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 BetaAssistantCreateParams.Body.Builder responseFormat(ResponseFormatJsonSchema responseFormatJsonSchema)

  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.

• responseFormatAuto

   final BetaAssistantCreateParams.Body.Builder responseFormatAuto()

  auto is the default value

• temperature

   final BetaAssistantCreateParams.Body.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 BetaAssistantCreateParams.Body.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 BetaAssistantCreateParams.Body.Builder temperature(Optional<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 BetaAssistantCreateParams.Body.Builder temperature(JsonField<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.

• toolResources

   final BetaAssistantCreateParams.Body.Builder toolResources(BetaAssistantCreateParams.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 BetaAssistantCreateParams.Body.Builder toolResources(Optional<BetaAssistantCreateParams.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 BetaAssistantCreateParams.Body.Builder toolResources(JsonField<BetaAssistantCreateParams.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.

• tools

   final BetaAssistantCreateParams.Body.Builder tools(List<AssistantTool> tools)

  A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

• tools

   final BetaAssistantCreateParams.Body.Builder tools(JsonField<List<AssistantTool>> tools)

  A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

• addTool

   final BetaAssistantCreateParams.Body.Builder addTool(AssistantTool tool)

  A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

• addTool

   final BetaAssistantCreateParams.Body.Builder addTool(CodeInterpreterTool codeInterpreter)

  A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

• addTool

   final BetaAssistantCreateParams.Body.Builder addTool(FileSearchTool fileSearch)

  A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

• addTool

   final BetaAssistantCreateParams.Body.Builder addTool(FunctionTool function)

  A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

• addFunctionTool

   final BetaAssistantCreateParams.Body.Builder addFunctionTool(FunctionDefinition function)

  A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.

• topP

   final BetaAssistantCreateParams.Body.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 BetaAssistantCreateParams.Body.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 BetaAssistantCreateParams.Body.Builder topP(Optional<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 BetaAssistantCreateParams.Body.Builder topP(JsonField<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.

• additionalProperties

   final BetaAssistantCreateParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final BetaAssistantCreateParams.Body.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final BetaAssistantCreateParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final BetaAssistantCreateParams.Body.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final BetaAssistantCreateParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final BetaAssistantCreateParams.Body build()