Class: OpenAI::Models::Beta::AgentCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• OpenAI::Resources::Beta::Agents#create

Defined Under Namespace

Modules: ServiceTier

Instance Attribute Summary

• #instructions ⇒ String^?

  Additional instructions appended to the agent's default base instructions.

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

  Up to 16 string key-value pairs, with keys up to 64 and values up to 512 characters.

• #model ⇒ String

  The model to use for the agent.

• #multi_agent ⇒ OpenAI::Models::Beta::MultiAgentConfigParam^?

  Explicit configuration for creating and coordinating subagents.

• #name ⇒ String^?

  A human-readable name for the agent.

• #reasoning ⇒ OpenAI::Models::Beta::AgentReasoningParam^?

  Reasoning configuration for the agent.

• #service_tier ⇒ Symbol, ...

  The service tier used for model requests.

• #text ⇒ OpenAI::Models::Beta::AgentTextParam^?

  Configuration for text generated by the agent.

• #tools ⇒ Array<OpenAI::Models::Beta::PersistedAgentToolParam::Function, OpenAI::Models::Beta::PersistedAgentToolParam::ToolSearch, OpenAI::Models::Beta::PersistedAgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch>^?

  Tools available to the agent.

Attributes included from Internal::Type::RequestParameters

#request_options

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize(model:, instructions: nil, metadata: nil, multi_agent: nil, name: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil, request_options: {}) ⇒ Object constructor
• #to_hash ⇒ {

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

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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:, instructions: nil, metadata: nil, multi_agent: nil, name: nil, reasoning: nil, service_tier: nil, text: nil, tools: nil, request_options: {}) ⇒ Object

Parameters:

• model (String) —

  The model to use for the agent. The requested model name is preserved.

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

  Additional instructions appended to the agent's default base instructions. Omit or set to null to add no custom instructions.

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

  Up to 16 string key-value pairs, with keys up to 64 and values up to 512 characters. Omission or null defaults to an empty map.

• multi_agent (OpenAI::Models::Beta::MultiAgentConfigParam, nil) (defaults to: nil) —

  Explicit configuration for creating and coordinating subagents.

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

  A human-readable name for the agent. Omission or null leaves the agent unnamed.

• reasoning (OpenAI::Models::Beta::AgentReasoningParam, nil) (defaults to: nil) —

  Reasoning configuration for the agent.

• service_tier (Symbol, OpenAI::Models::Beta::AgentCreateParams::ServiceTier, nil) (defaults to: nil) —

  The service tier used for model requests.

• text (OpenAI::Models::Beta::AgentTextParam, nil) (defaults to: nil) —

  Configuration for text generated by the agent.

• tools (Array<OpenAI::Models::Beta::PersistedAgentToolParam::Function, OpenAI::Models::Beta::PersistedAgentToolParam::ToolSearch, OpenAI::Models::Beta::PersistedAgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch>, nil) (defaults to: nil) —

  Tools available to the agent. Defaults to an empty list.

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

# File 'lib/openai/models/beta/agent_create_params.rb', line 71

Instance Attribute Details

#instructions ⇒ String^?

Additional instructions appended to the agent's default base instructions. Omit or set to null to add no custom instructions.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/openai/models/beta/agent_create_params.rb', line 22

optional :instructions, String, nil?: true

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

Up to 16 string key-value pairs, with keys up to 64 and values up to 512 characters. Omission or null defaults to an empty map.

Parameters:

• value (::Hash[Symbol, String], nil)

Returns:

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

# File 'lib/openai/models/beta/agent_create_params.rb', line 29

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

#model ⇒ String

The model to use for the agent. The requested model name is preserved.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/openai/models/beta/agent_create_params.rb', line 15

required :model, String

#multi_agent ⇒ OpenAI::Models::Beta::MultiAgentConfigParam^?

Explicit configuration for creating and coordinating subagents.

Parameters:

• value (OpenAI::Beta::MultiAgentConfigParam, nil)

Returns:

• (OpenAI::Models::Beta::MultiAgentConfigParam, nil)

# File 'lib/openai/models/beta/agent_create_params.rb', line 35

optional :multi_agent, -> { OpenAI::Beta::MultiAgentConfigParam }, nil?: true

#name ⇒ String^?

A human-readable name for the agent. Omission or null leaves the agent unnamed.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/openai/models/beta/agent_create_params.rb', line 41

optional :name, String, nil?: true

#reasoning ⇒ OpenAI::Models::Beta::AgentReasoningParam^?

Reasoning configuration for the agent.

Parameters:

• value (OpenAI::Beta::AgentReasoningParam, nil)

Returns:

• (OpenAI::Models::Beta::AgentReasoningParam, nil)

# File 'lib/openai/models/beta/agent_create_params.rb', line 47

optional :reasoning, -> { OpenAI::Beta::AgentReasoningParam }, nil?: true

#service_tier ⇒ Symbol, ...

The service tier used for model requests.

Parameters:

• value (OpenAI::Models::Beta::AgentCreateParams::service_tier, nil)

Returns:

• (Symbol, OpenAI::Models::Beta::AgentCreateParams::ServiceTier, nil)

# File 'lib/openai/models/beta/agent_create_params.rb', line 53

optional :service_tier, enum: -> { OpenAI::Beta::AgentCreateParams::ServiceTier }, nil?: true

#text ⇒ OpenAI::Models::Beta::AgentTextParam^?

Configuration for text generated by the agent.

Parameters:

• value (OpenAI::Beta::AgentTextParam, nil)

Returns:

• (OpenAI::Models::Beta::AgentTextParam, nil)

# File 'lib/openai/models/beta/agent_create_params.rb', line 59

optional :text, -> { OpenAI::Beta::AgentTextParam }, nil?: true

#tools ⇒ Array<OpenAI::Models::Beta::PersistedAgentToolParam::Function, OpenAI::Models::Beta::PersistedAgentToolParam::ToolSearch, OpenAI::Models::Beta::PersistedAgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch>^?

Tools available to the agent. Defaults to an empty list.

Parameters:

• value (::Array[OpenAI::Models::Beta::persisted_agent_tool_param], nil)

Returns:

• (Array<OpenAI::Models::Beta::PersistedAgentToolParam::Function, OpenAI::Models::Beta::PersistedAgentToolParam::ToolSearch, OpenAI::Models::Beta::PersistedAgentToolParam::ProgrammaticToolCalling, OpenAI::Models::Beta::PersistedAgentToolParam::Mcp, OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch>, nil)

# File 'lib/openai/models/beta/agent_create_params.rb', line 65

optional(
  :tools,
  -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Beta::PersistedAgentToolParam] },
  nil?: true
)

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/beta/agent_create_params.rbs', line 53

def to_hash: -> {