Class: OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content

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

Defined Under Namespace

Modules: Type

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(audio: nil, text: nil, transcript: nil, type: nil) ⇒ Object

Parameters:

  • audio (String) (defaults to: nil) —

    Base64-encoded audio bytes (for ‘input_audio`).

  • text (String) (defaults to: nil) —

    The text content (for ‘input_text`).

  • transcript (String) (defaults to: nil) —

    Transcript of the audio (for ‘input_audio`).

  • type (Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::Type) (defaults to: nil) —

    The content type (‘input_text` or `input_audio`).



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/openai/models/realtime/realtime_conversation_item_user_message.rb', line 59

class Content < OpenAI::Internal::Type::BaseModel
  # @!attribute audio
  #   Base64-encoded audio bytes (for `input_audio`).
  #
  #   @return [String, nil]
  optional :audio, String

  # @!attribute text
  #   The text content (for `input_text`).
  #
  #   @return [String, nil]
  optional :text, String

  # @!attribute transcript
  #   Transcript of the audio (for `input_audio`).
  #
  #   @return [String, nil]
  optional :transcript, String

  # @!attribute type
  #   The content type (`input_text` or `input_audio`).
  #
  #   @return [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::Type, nil]
  optional :type, enum: -> { OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Type }

  # @!method initialize(audio: nil, text: nil, transcript: nil, type: nil)
  #   @param audio [String] Base64-encoded audio bytes (for `input_audio`).
  #
  #   @param text [String] The text content (for `input_text`).
  #
  #   @param transcript [String] Transcript of the audio (for `input_audio`).
  #
  #   @param type [Symbol, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content::Type] The content type (`input_text` or `input_audio`).

  # The content type (`input_text` or `input_audio`).
  #
  # @see OpenAI::Models::Realtime::RealtimeConversationItemUserMessage::Content#type
  module Type
    extend OpenAI::Internal::Type::Enum

    INPUT_TEXT = :input_text
    INPUT_AUDIO = :input_audio

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#audio ⇒ String?

Base64-encoded audio bytes (for ‘input_audio`).

Returns:

  • (String, nil) 


64
 
# File 'lib/openai/models/realtime/realtime_conversation_item_user_message.rb', line 64

optional :audio, String

#text ⇒ String?

The text content (for ‘input_text`).

Returns:

  • (String, nil) 


70
 
# File 'lib/openai/models/realtime/realtime_conversation_item_user_message.rb', line 70

optional :text, String

#transcript ⇒ String?

Transcript of the audio (for ‘input_audio`).

Returns:

  • (String, nil) 


76
 
# File 'lib/openai/models/realtime/realtime_conversation_item_user_message.rb', line 76

optional :transcript, String

#type ⇒ Symbol, ...

The content type (‘input_text` or `input_audio`).

Returns:



82
 
# File 'lib/openai/models/realtime/realtime_conversation_item_user_message.rb', line 82

optional :type, enum: -> { OpenAI::Realtime::RealtimeConversationItemUserMessage::Content::Type }