Class: OpenAI::Models::Beta::Agents::SessionCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/beta/agents/session_create_params.rb,
sig/openai/models/beta/agents/session_create_params.rbs

Overview

See Also:

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

Defined Under Namespace

Modules: Input Classes: Agent

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Attributes inherited from Internal::Type::BaseModel

#last_response

Class Method Summary collapse

Instance Method Summary collapse

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 ⇒ Object 



38
 
# File 'sig/openai/models/beta/agents/session_create_params.rbs', line 38

def initialize: (

Instance Attribute Details

#agent ⇒ OpenAI::Models::Beta::Agents::SessionCreateParams::Agent?

Agent configuration. With agent_id, supplied fields override the saved agent for this session. Without agent_id, model is required.

Returns:



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

optional :agent, -> { OpenAI::Beta::Agents::SessionCreateParams::Agent }

#agent_id ⇒ String?

The ID of a saved reusable agent. Omit agent to use its configuration unchanged.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :agent_id, String

#environment ⇒ OpenAI::Models::Beta::EnvironmentParam::None, ...

An inline execution environment or a reference to an environment template.

Parameters:

  • value (OpenAI::Models::Beta::environment_param)

Returns:



18
 
# File 'lib/openai/models/beta/agents/session_create_params.rb', line 18

required :environment, union: -> { OpenAI::Beta::EnvironmentParam }

#input ⇒ String, ...

Initial input submitted when creating a session.

Parameters:

  • value (OpenAI::Models::Beta::Agents::SessionCreateParams::input, nil)

Returns:



38
 
# File 'lib/openai/models/beta/agents/session_create_params.rb', line 38

optional :input, union: -> { OpenAI::Beta::Agents::SessionCreateParams::Input }, 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) 


45
 
# File 'lib/openai/models/beta/agents/session_create_params.rb', line 45

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

#vault_ids ⇒ Array<String>?

The IDs of vaults made available to the session.

Parameters:

  • value (::Array[String], nil)

Returns:

  • (Array<String>, nil) 


51
 
# File 'lib/openai/models/beta/agents/session_create_params.rb', line 51

optional :vault_ids, OpenAI::Internal::Type::ArrayOf[String], nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/beta/agents/session_create_params.rb', line 178

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


48
 
# File 'sig/openai/models/beta/agents/session_create_params.rbs', line 48

def to_hash: -> {