Method: OpenAI::Resources::Beta::Assistants#update

Defined in:

lib/openai/resources/beta/assistants.rb

#update(assistant_id, description: nil, instructions: nil, metadata: nil, model: nil, name: nil, reasoning_effort: nil, response_format: nil, temperature: nil, tool_resources: nil, tools: nil, top_p: nil, request_options: {}) ⇒ OpenAI::Models::Beta::Assistant

Some parameter documentations has been truncated, see Models::Beta::AssistantUpdateParams for more details.

Modifies an assistant.

Parameters:

• assistant_id (String) —

  The ID of the assistant to modify.

• description (String, nil) —

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

• instructions (String, nil) —

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

• metadata (Hash{Symbol=>String}, nil) —

  Set of 16 key-value pairs that can be attached to an object. This can be

• model (String, Symbol, OpenAI::Models::Beta::AssistantUpdateParams::Model) —

  ID of the model to use. You can use the [List models](https://platform.openai.co

• name (String, nil) —

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

• reasoning_effort (Symbol, OpenAI::Models::ReasoningEffort, nil) —

  o-series models only

• response_format (Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema, nil) —

  Specifies the format that the model must output. Compatible with [GPT-4o](https:

• temperature (Float, nil) —

  What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m

• tool_resources (OpenAI::Models::Beta::AssistantUpdateParams::ToolResources, nil) —

  A set of resources that are used by the assistant's tools. The resources are spe

• tools (Array<OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::FileSearchTool, OpenAI::Models::Beta::FunctionTool>) —

  A list of tool enabled on the assistant. There can be a maximum of 128 tools per

• top_p (Float, nil) —

  An alternative to sampling with temperature, called nucleus sampling, where the

• request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (OpenAI::Models::Beta::Assistant)

See Also:

• Models::Beta::AssistantUpdateParams

# File 'lib/openai/resources/beta/assistants.rb', line 108

def update(assistant_id, params = {})
  parsed, options = OpenAI::Beta::AssistantUpdateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["assistants/%1$s", assistant_id],
    body: parsed,
    model: OpenAI::Beta::Assistant,
    options: {extra_headers: {"OpenAI-Beta" => "assistants=v2"}, **options}
  )
end