Class: OpenAI::Models::BetaResponsesClientEvent::Beta::BetaResponsesClientEvent::ResponseCreate

Inherits:
Internal::Type::BaseModel show all
Defined in:
sig/openai/models/beta/beta_responses_client_event.rbs

Defined Under Namespace

Modules: Conversation, Input, Model, PromptCacheRetention, ServiceTier, ToolChoice, Truncation Classes: ContextManagement, Moderation, MultiAgent, PromptCacheOptions, Reasoning, StreamOptions

Instance Attribute Summary collapse

Instance Method Summary collapse

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



143
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 143

def initialize: (

Instance Attribute Details

#background ⇒ Boolean?

Returns the value of attribute background.

Returns:



53
54
55
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 53

def background
  @background
end

#context_management ⇒ ::Array[OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::ContextManagement]?

Returns the value of attribute context_management.

Returns:

  • (::Array[OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::ContextManagement], nil) 


55
56
57
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 55

def context_management
  @context_management
end

#conversation ⇒ OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::conversation?

Returns the value of attribute conversation.

Returns:

  • (OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::conversation, nil) 


57
58
59
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 57

def conversation
  @conversation
end

#include ⇒ ::Array[OpenAI::Models::Beta::beta_response_includable]?

Returns the value of attribute include.

Returns:

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


59
60
61
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 59

def include
  @include
end

#input ⇒ OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::input? (readonly)

Returns the value of attribute input.

Returns:

  • (OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::input, nil) 


61
62
63
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 61

def input
  @input
end

#instructions ⇒ String?

Returns the value of attribute instructions.

Returns:

  • (String, nil) 


67
68
69
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 67

def instructions
  @instructions
end

#max_output_tokens ⇒ Integer?

Returns the value of attribute max_output_tokens.

Returns:

  • (Integer, nil) 


69
70
71
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 69

def max_output_tokens
  @max_output_tokens
end

#max_tool_calls ⇒ Integer?

Returns the value of attribute max_tool_calls.

Returns:

  • (Integer, nil) 


71
72
73
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 71

def max_tool_calls
  @max_tool_calls
end

#metadata ⇒ ::Hash[Symbol, String]?

Returns the value of attribute metadata.

Returns:

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


73
74
75
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 73

def metadata
  @metadata
end

#model ⇒ OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::model? (readonly)

Returns the value of attribute model.

Returns:

  • (OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::model, nil) 


75
76
77
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 75

def model
  @model
end

#moderation ⇒ OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Moderation?

Returns the value of attribute moderation.

Returns:

  • (OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Moderation, nil) 


81
82
83
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 81

def moderation
  @moderation
end

#multi_agent ⇒ OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::MultiAgent?

Returns the value of attribute multi_agent.

Returns:

  • (OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::MultiAgent, nil) 


83
84
85
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 83

def multi_agent
  @multi_agent
end

#parallel_tool_calls ⇒ Boolean?

Returns the value of attribute parallel_tool_calls.

Returns:



85
86
87
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 85

def parallel_tool_calls
  @parallel_tool_calls
end

#previous_response_id ⇒ String?

Returns the value of attribute previous_response_id.

Returns:

  • (String, nil) 


87
88
89
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 87

def previous_response_id
  @previous_response_id
end

#prompt ⇒ OpenAI::Beta::BetaResponsePrompt?

Returns the value of attribute prompt.

Returns:

  • (OpenAI::Beta::BetaResponsePrompt, nil) 


89
90
91
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 89

def prompt
  @prompt
end

#prompt_cache_key ⇒ String?

Returns the value of attribute prompt_cache_key.

Returns:

  • (String, nil) 


91
92
93
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 91

def prompt_cache_key
  @prompt_cache_key
end

#prompt_cache_options ⇒ OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::PromptCacheOptions? (readonly)

Returns the value of attribute prompt_cache_options.

Returns:

  • (OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::PromptCacheOptions, nil) 


93
94
95
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 93

def prompt_cache_options
  @prompt_cache_options
end

#prompt_cache_retention ⇒ OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::prompt_cache_retention?

Returns the value of attribute prompt_cache_retention.

Returns:

  • (OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::prompt_cache_retention, nil) 


99
100
101
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 99

def prompt_cache_retention
  @prompt_cache_retention
end

#reasoning ⇒ OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Reasoning?

Returns the value of attribute reasoning.

Returns:

  • (OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::Reasoning, nil) 


101
102
103
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 101

def reasoning
  @reasoning
end

#safety_identifier ⇒ String?

Returns the value of attribute safety_identifier.

Returns:

  • (String, nil) 


103
104
105
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 103

def safety_identifier
  @safety_identifier
end

#service_tier ⇒ OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::service_tier?

Returns the value of attribute service_tier.

Returns:

  • (OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::service_tier, nil) 


105
106
107
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 105

def service_tier
  @service_tier
end

#store ⇒ Boolean?

Returns the value of attribute store.

Returns:



107
108
109
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 107

def store
  @store
end

#stream ⇒ Boolean?

Returns the value of attribute stream.

Returns:



109
110
111
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 109

def stream
  @stream
end

#stream_options ⇒ OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::StreamOptions?

Returns the value of attribute stream_options.

Returns:

  • (OpenAI::Beta::BetaResponsesClientEvent::ResponseCreate::StreamOptions, nil) 


111
112
113
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 111

def stream_options
  @stream_options
end

#temperature ⇒ Float?

Returns the value of attribute temperature.

Returns:

  • (Float, nil) 


113
114
115
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 113

def temperature
  @temperature
end

#text ⇒ OpenAI::Beta::BetaResponseTextConfig? (readonly)

Returns the value of attribute text.

Returns:

  • (OpenAI::Beta::BetaResponseTextConfig, nil) 


115
116
117
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 115

def text
  @text
end

#tool_choice ⇒ OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::tool_choice? (readonly)

Returns the value of attribute tool_choice.

Returns:

  • (OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::tool_choice, nil) 


121
122
123
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 121

def tool_choice
  @tool_choice
end

#tools ⇒ ::Array[OpenAI::Models::Beta::beta_tool]? (readonly)

Returns the value of attribute tools.

Returns:

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


127
128
129
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 127

def tools
  @tools
end

#top_logprobs ⇒ Integer?

Returns the value of attribute top_logprobs.

Returns:

  • (Integer, nil) 


133
134
135
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 133

def top_logprobs
  @top_logprobs
end

#top_p ⇒ Float?

Returns the value of attribute top_p.

Returns:

  • (Float, nil) 


135
136
137
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 135

def top_p
  @top_p
end

#truncation ⇒ OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::truncation?

Returns the value of attribute truncation.

Returns:

  • (OpenAI::Models::Beta::BetaResponsesClientEvent::ResponseCreate::truncation, nil) 


137
138
139
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 137

def truncation
  @truncation
end

#type ⇒ :"response.create"

Returns the value of attribute type.

Returns:

  • (:"response.create") 


51
52
53
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 51

def type
  @type
end

#user ⇒ String? (readonly)

Returns the value of attribute user.

Returns:

  • (String, nil) 


139
140
141
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 139

def user
  @user
end

Instance Method Details

#input= ⇒ Object (readonly) 



63
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 63

def input=: (

#model= ⇒ Object (readonly) 



77
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 77

def model=: (

#prompt_cache_options= ⇒ Object (readonly) 



95
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 95

def prompt_cache_options=: (

#text= ⇒ Object (readonly) 



117
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 117

def text=: (

#to_hash ⇒ {

Returns:

  • ({) 


179
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 179

def to_hash: -> {

#tool_choice= ⇒ Object (readonly) 



123
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 123

def tool_choice=: (

#tools= ⇒ Object (readonly) 



129
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 129

def tools=: (

#user= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


141
 
# File 'sig/openai/models/beta/beta_responses_client_event.rbs', line 141

def user=: (String) -> String