Class: OpenAI::Models::Beta::AgentText

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/agent_text.rb,
sig/openai/models/beta/agent_text.rbs

Defined Under Namespace

Modules: Verbosity

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

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(format_:, verbosity:) ⇒ Object

The text configuration used by an agent.

Parameters:




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

Instance Attribute Details

#format_ ⇒ OpenAI::Models::Beta::TextFormat::Text, OpenAI::Models::Beta::TextFormat::JSONSchema

The effective output format. Defaults to ordinary text.

Parameters:

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

Returns:



11
 
# File 'lib/openai/models/beta/agent_text.rb', line 11

required :format_, union: -> { OpenAI::Beta::TextFormat }, api_name: :format

#verbosity ⇒ Symbol, OpenAI::Models::Beta::AgentText::Verbosity

The amount of text produced by the agent. Defaults to medium.

Parameters:

  • value (OpenAI::Models::Beta::AgentText::verbosity)

Returns:



17
 
# File 'lib/openai/models/beta/agent_text.rb', line 17

required :verbosity, enum: -> { OpenAI::Beta::AgentText::Verbosity }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


20
 
# File 'sig/openai/models/beta/agent_text.rbs', line 20

def to_hash: -> {