Class: OpenAI::Models::Realtime::RealtimeSessionCreateRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/realtime_session_create_request.rb

Direct Known Subclasses

CallAcceptParams

Defined Under Namespace

Modules: Include, MaxOutputTokens, Model, OutputModality

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from OpenAI::Internal::Type::BaseModel

Instance Attribute Details

#audio ⇒ OpenAI::Models::Realtime::RealtimeAudioConfig?

Configuration for input and output audio.

Returns:



17
 
# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 17

optional :audio, -> { OpenAI::Realtime::RealtimeAudioConfig }

#include ⇒ Array<Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::Include>?

Additional fields to include in server outputs.

‘item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.

Returns:



26
27
 
# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 26

optional :include,
-> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Realtime::RealtimeSessionCreateRequest::Include] }

#instructions ⇒ String?

The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. “be extremely succinct”, “act friendly”, “here are examples of good responses”) and on audio behavior (e.g. “talk quickly”, “inject emotion into your voice”, “laugh frequently”). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.

Note that the server sets default instructions which will be used if this field is not set and are visible in the ‘session.created` event at the start of the session.

Returns:

  • (String, nil) 


43
 
# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 43

optional :instructions, String

#max_output_tokens ⇒ Integer, ...

Maximum number of output tokens for a single assistant response, inclusive of tool calls. Provide an integer between 1 and 4096 to limit output tokens, or ‘inf` for the maximum available tokens for a given model. Defaults to `inf`.

Returns:

  • (Integer, Symbol, :inf, nil) 


51
 
# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 51

optional :max_output_tokens, union: -> { OpenAI::Realtime::RealtimeSessionCreateRequest::MaxOutputTokens }

#model ⇒ String, ...

The Realtime model used for this session.

Returns:



57
 
# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 57

optional :model, union: -> { OpenAI::Realtime::RealtimeSessionCreateRequest::Model }

#output_modalities ⇒ Array<Symbol, OpenAI::Models::Realtime::RealtimeSessionCreateRequest::OutputModality>?

The set of modalities the model can respond with. It defaults to ‘[“audio”]`, indicating that the model will respond with audio plus a transcript. `[“text”]` can be used to make the model respond with text only. It is not possible to request both `text` and `audio` at the same time.

Returns:



66
67
 
# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 66

optional :output_modalities,
-> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Realtime::RealtimeSessionCreateRequest::OutputModality] }

#prompt ⇒ OpenAI::Models::Responses::ResponsePrompt?

Reference to a prompt template and its variables. [Learn more](platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).

Returns:



74
 
# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 74

optional :prompt, -> { OpenAI::Responses::ResponsePrompt }, nil?: true

#tool_choice ⇒ Symbol, ...

How the model chooses tools. Provide one of the string modes or force a specific function/MCP tool.

Returns:



81
 
# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 81

optional :tool_choice, union: -> { OpenAI::Realtime::RealtimeToolChoiceConfig }

#tools ⇒ Array<OpenAI::Models::Realtime::RealtimeFunctionTool, OpenAI::Models::Realtime::RealtimeToolsConfigUnion::Mcp>?

Tools available to the model.

Returns:



87
 
# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 87

optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Realtime::RealtimeToolsConfigUnion] }

#tracing ⇒ Symbol, ...

Realtime API can write session traces to the [Traces Dashboard](/logs?api=traces). Set to null to disable tracing. Once tracing is enabled for a session, the configuration cannot be modified.

‘auto` will create a trace for the session with default values for the workflow name, group id, and metadata.

Returns:



98
 
# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 98

optional :tracing, union: -> { OpenAI::Realtime::RealtimeTracingConfig }, nil?: true

#truncation ⇒ Symbol, ...

When the number of tokens in a conversation exceeds the model’s input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model’s context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.

Clients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.

Truncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.

Truncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model’s input token limit.

Returns:



121
 
# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 121

optional :truncation, union: -> { OpenAI::Realtime::RealtimeTruncation }

#type ⇒ Symbol, :realtime

The type of session to create. Always ‘realtime` for the Realtime API.

Returns:

  • (Symbol, :realtime) 


11
 
# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 11

required :type, const: :realtime

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 158

.variants ⇒ Array(Integer, Symbol, :inf)

Returns:

  • (Array(Integer, Symbol, :inf)) 



# File 'lib/openai/models/realtime/realtime_session_create_request.rb', line 174