Class: OpenAI::Models::Beta::AssistantCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::AssistantCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/beta/assistant_create_params.rb,
sig/openai/models/beta/assistant_create_params.rbs

Overview

See Also:

• OpenAI::Resources::Beta::Assistants#create

Defined Under Namespace

Modules: Model Classes: ToolResources

Instance Attribute Summary

• #description ⇒ String^?

  The description of the assistant.

• #instructions ⇒ String^?

  The system instructions that the assistant uses.

• #metadata ⇒ Hash{Symbol=>String}^?

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

• #model ⇒ String, ...

  ID of the model to use.

• #name ⇒ String^?

  The name of the assistant.

• #reasoning_effort ⇒ Symbol, ...

  Constrains effort on reasoning for reasoning models.

• #response_format ⇒ Symbol, ...

  Specifies the format that the model must output.

• #temperature ⇒ Float^?

  What sampling temperature to use, between 0 and 2.

• #tool_resources ⇒ OpenAI::Models::Beta::AssistantCreateParams::ToolResources^?

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

• #tools ⇒ Array<OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::FileSearchTool, OpenAI::Models::Beta::FunctionTool>^?

  A list of tool enabled on the assistant.

• #top_p ⇒ Float^?

  An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .variants ⇒ Array(String, Symbol, OpenAI::Models::ChatModel)

Instance Method Summary

• #initialize(model:, description: nil, instructions: nil, metadata: nil, name: nil, reasoning_effort: nil, response_format: nil, temperature: nil, tool_resources: nil, tools: nil, top_p: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see AssistantCreateParams for more details.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(model:, description: nil, instructions: nil, metadata: nil, name: nil, reasoning_effort: nil, response_format: nil, temperature: nil, tool_resources: nil, tools: nil, top_p: nil, request_options: {}) ⇒ Object

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

Parameters:

• model (String, Symbol, OpenAI::Models::ChatModel) —

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

• description (String, nil) (defaults to: nil) —

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

• instructions (String, nil) (defaults to: nil) —

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

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

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

• name (String, nil) (defaults to: nil) —

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

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

  Constrains effort on reasoning for reasoning models. Currently supported

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

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

• temperature (Float, nil) (defaults to: nil) —

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

• tool_resources (OpenAI::Models::Beta::AssistantCreateParams::ToolResources, nil) (defaults to: 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>) (defaults to: nil) —

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

• top_p (Float, nil) (defaults to: nil) —

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

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

# File 'lib/openai/models/beta/assistant_create_params.rb', line 122

Instance Attribute Details

#description ⇒ String^?

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

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/openai/models/beta/assistant_create_params.rb', line 25

optional :description, String, nil?: true

#instructions ⇒ String^?

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

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/openai/models/beta/assistant_create_params.rb', line 32

optional :instructions, String, nil?: true

#metadata ⇒ Hash{Symbol=>String}^?

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.

Parameters:

• value (OpenAI::Models::metadata, nil)

Returns:

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

# File 'lib/openai/models/beta/assistant_create_params.rb', line 43

optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true

#model ⇒ String, ...

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.

Parameters:

• value (OpenAI::Models::Beta::AssistantCreateParams::model)

Returns:

• (String, Symbol, OpenAI::Models::ChatModel)

# File 'lib/openai/models/beta/assistant_create_params.rb', line 19

required :model, union: -> { OpenAI::Beta::AssistantCreateParams::Model }

#name ⇒ String^?

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

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/openai/models/beta/assistant_create_params.rb', line 49

optional :name, String, nil?: true

#reasoning_effort ⇒ Symbol, ...

Constrains effort on reasoning for reasoning models. Currently supported values are none, minimal, low, medium, high, xhigh, and max. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Not all reasoning models support every value. See the reasoning guide for model-specific support.

Parameters:

• value (OpenAI::Models::reasoning_effort, nil)

Returns:

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

# File 'lib/openai/models/beta/assistant_create_params.rb', line 60

optional :reasoning_effort, enum: -> { OpenAI::ReasoningEffort }, nil?: true

#response_format ⇒ Symbol, ...

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.

Parameters:

• value (OpenAI::Models::Beta::assistant_response_format_option, nil)

Returns:

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

# File 'lib/openai/models/beta/assistant_create_params.rb', line 85

optional :response_format, union: -> { OpenAI::Beta::AssistantResponseFormatOption }, nil?: true

#temperature ⇒ Float^?

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.

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/openai/models/beta/assistant_create_params.rb', line 93

optional :temperature, Float, nil?: true

#tool_resources ⇒ OpenAI::Models::Beta::AssistantCreateParams::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.

Parameters:

• value (OpenAI::Beta::AssistantCreateParams::ToolResources, nil)

Returns:

• (OpenAI::Models::Beta::AssistantCreateParams::ToolResources, nil)

# File 'lib/openai/models/beta/assistant_create_params.rb', line 102

optional :tool_resources, -> { OpenAI::Beta::AssistantCreateParams::ToolResources }, nil?: true

#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 assistant. Tools can be of types code_interpreter, file_search, or function.

Returns:

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

# File 'lib/openai/models/beta/assistant_create_params.rb', line 110

optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::AssistantTool] }

#top_p ⇒ Float^?

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.

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/openai/models/beta/assistant_create_params.rb', line 120

optional :top_p, Float, nil?: true

Class Method Details

.variants ⇒ Array(String, Symbol, OpenAI::Models::ChatModel)

Returns:

• (Array(String, Symbol, OpenAI::Models::ChatModel))

# File 'lib/openai/models/beta/assistant_create_params.rb', line 163

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/beta/assistant_create_params.rbs', line 65

def to_hash: -> {