Class: OpenAI::Models::Beta::Threads::MessageCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/openai/models/beta/threads/message_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Content, Role Classes: Attachment

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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, 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: , attachments: nil, metadata: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Beta::Threads::MessageCreateParams for more details.

Parameters:




# File 'lib/openai/models/beta/threads/message_create_params.rb', line 50

Instance Attribute Details

#attachments ⇒ Array<OpenAI::Models::Beta::Threads::MessageCreateParams::Attachment>?

A list of files attached to the message, and the tools they should be added to.

Returns:



33
34
35
36
37
 
# File 'lib/openai/models/beta/threads/message_create_params.rb', line 33

optional :attachments,
-> {
  OpenAI::Internal::Type::ArrayOf[OpenAI::Beta::Threads::MessageCreateParams::Attachment]
},
nil?: true

#content ⇒ String, Array<OpenAI::Models::Beta::Threads::ImageFileContentBlock, OpenAI::Models::Beta::Threads::ImageURLContentBlock, OpenAI::Models::Beta::Threads::TextContentBlockParam>

The text contents of the message.

Returns:



16
 
# File 'lib/openai/models/beta/threads/message_create_params.rb', line 16

required :content, union: -> { OpenAI::Beta::Threads::MessageCreateParams::Content }

#metadata ⇒ Hash{Symbol=>String}?

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

Returns:

  • (Hash{Symbol=>String}, nil) 


48
 
# File 'lib/openai/models/beta/threads/message_create_params.rb', line 48

optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true

#role ⇒ Symbol, OpenAI::Models::Beta::Threads::MessageCreateParams::Role

The role of the entity that is creating the message. Allowed values include:

  • ‘user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.

  • ‘assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.

Returns:



27
 
# File 'lib/openai/models/beta/threads/message_create_params.rb', line 27

required :role, enum: -> { OpenAI::Beta::Threads::MessageCreateParams::Role }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/beta/threads/message_create_params.rb', line 94