Class: Telnyx::Models::AI::ChatCompletionRequest::Message

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/ai/chat_completion_request.rb,
sig/telnyx/models/ai/chat_completion_request.rbs

Defined Under Namespace

Modules: Content, Role

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(content:, role:) ⇒ Object

Parameters:



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/telnyx/models/ai/chat_completion_request.rb', line 292

class Message < Telnyx::Internal::Type::BaseModel
  # @!attribute content
  #
  #   @return [String, Array<Telnyx::Models::AI::ChatCompletionRequest::Message::Content::TextAndImageArray>]
  required :content, union: -> { Telnyx::AI::ChatCompletionRequest::Message::Content }

  # @!attribute role
  #
  #   @return [Symbol, Telnyx::Models::AI::ChatCompletionRequest::Message::Role]
  required :role, enum: -> { Telnyx::AI::ChatCompletionRequest::Message::Role }

  # @!method initialize(content:, role:)
  #   @param content [String, Array<Telnyx::Models::AI::ChatCompletionRequest::Message::Content::TextAndImageArray>]
  #   @param role [Symbol, Telnyx::Models::AI::ChatCompletionRequest::Message::Role]

  # @see Telnyx::Models::AI::ChatCompletionRequest::Message#content
  module Content
    extend Telnyx::Internal::Type::Union

    variant String

    variant -> { Telnyx::Models::AI::ChatCompletionRequest::Message::Content::TextAndImage2DArray }

    class TextAndImageArray < Telnyx::Internal::Type::BaseModel
      # @!attribute type
      #
      #   @return [Symbol, Telnyx::Models::AI::ChatCompletionRequest::Message::Content::TextAndImageArray::Type]
      required :type, enum: -> { Telnyx::AI::ChatCompletionRequest::Message::Content::TextAndImageArray::Type }

      # @!attribute image_url
      #
      #   @return [String, nil]
      optional :image_url, String

      # @!attribute text
      #
      #   @return [String, nil]
      optional :text, String

      # @!method initialize(type:, image_url: nil, text: nil)
      #   @param type [Symbol, Telnyx::Models::AI::ChatCompletionRequest::Message::Content::TextAndImageArray::Type]
      #   @param image_url [String]
      #   @param text [String]

      # @see Telnyx::Models::AI::ChatCompletionRequest::Message::Content::TextAndImageArray#type
      module Type
        extend Telnyx::Internal::Type::Enum

        TEXT = :text
        IMAGE_URL = :image_url

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

    # @!method self.variants
    #   @return [Array(String, Array<Telnyx::Models::AI::ChatCompletionRequest::Message::Content::TextAndImageArray>)]

    # @type [Telnyx::Internal::Type::Converter]
    TextAndImage2DArray =
      Telnyx::Internal::Type::ArrayOf[-> {
        Telnyx::AI::ChatCompletionRequest::Message::Content::TextAndImageArray
      }]
  end

  # @see Telnyx::Models::AI::ChatCompletionRequest::Message#role
  module Role
    extend Telnyx::Internal::Type::Enum

    SYSTEM = :system
    USER = :user
    ASSISTANT = :assistant
    TOOL = :tool

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

Instance Attribute Details

#content ⇒ String, Array<Telnyx::Models::AI::ChatCompletionRequest::Message::Content::TextAndImageArray>

Parameters:

  • value (Telnyx::Models::AI::ChatCompletionRequest::Message::content)

Returns:



296
 
# File 'lib/telnyx/models/ai/chat_completion_request.rb', line 296

required :content, union: -> { Telnyx::AI::ChatCompletionRequest::Message::Content }

#role ⇒ Symbol, Telnyx::Models::AI::ChatCompletionRequest::Message::Role

Parameters:

  • value (Telnyx::Models::AI::ChatCompletionRequest::Message::role)

Returns:



301
 
# File 'lib/telnyx/models/ai/chat_completion_request.rb', line 301

required :role, enum: -> { Telnyx::AI::ChatCompletionRequest::Message::Role }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


253
 
# File 'sig/telnyx/models/ai/chat_completion_request.rbs', line 253

def to_hash: -> {