Constructor Detail

• BetaAssistantUpdateParams

  BetaAssistantUpdateParams(String assistantId, BetaAssistantUpdateParams.BetaAssistantUpdateBody body, Headers additionalHeaders, QueryParams additionalQueryParams)

Method Detail

• assistantId

   final String assistantId()

• description

   final Optional<String> description()

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

• instructions

   final Optional<String> instructions()

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

• _metadata

   final JsonValue _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. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.

• model

   final Optional<String> 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.

• name

   final Optional<String> name()

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

• responseFormat

   final 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.

• temperature

   final 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.

• toolResources

   final Optional<BetaAssistantUpdateParams.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 Optional<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.

• topP

   final 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.

• _description

   final JsonField<String> _description()

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

• _instructions

   final JsonField<String> _instructions()

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

• _model

   final JsonField<String> _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.

• _name

   final JsonField<String> _name()

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

• _responseFormat

   final 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.

• _temperature

   final 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 JsonField<BetaAssistantUpdateParams.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 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.

• _topP

   final 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.

• _additionalBodyProperties

   final Map<String, JsonValue> _additionalBodyProperties()

• _additionalHeaders

   final Headers _additionalHeaders()

• _additionalQueryParams

   final QueryParams _additionalQueryParams()

• getPathParam

   final String getPathParam(Integer index)

• toBuilder

   final BetaAssistantUpdateParams.Builder toBuilder()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static BetaAssistantUpdateParams.Builder builder()