Class: OpenAI::Models::Chat::ChatCompletionStoreMessage

Inherits:

ChatCompletionMessage

• Object
• Internal::Type::BaseModel
• ChatCompletionMessage
• OpenAI::Models::Chat::ChatCompletionStoreMessage

Defined in:

lib/openai/models/chat/chat_completion_store_message.rb,
sig/openai/models/chat/chat_completion_store_message.rbs

Defined Under Namespace

Modules: ContentPart

Instance Attribute Summary

• #content_parts ⇒ Array<OpenAI::Models::Chat::ChatCompletionContentPartText, OpenAI::Models::Chat::ChatCompletionContentPartImage>^?

  If a content parts array was provided, this is an array of text and image_url parts.

• #id ⇒ String

  The identifier of the chat message.

Attributes inherited from ChatCompletionMessage

#annotations, #audio, #content, #function_call, #refusal, #role, #tool_calls

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize(content:, refusal:, id:, annotations: nil, audio: nil, function_call: nil, tool_calls: nil, content_parts: nil, role: :assistant) ⇒ Object constructor

  Some parameter documentations has been truncated, see ChatCompletionStoreMessage for more details.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, #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:, refusal:, id:, annotations: nil, audio: nil, function_call: nil, tool_calls: nil, content_parts: nil, role: :assistant) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Chat::ChatCompletionStoreMessage for more details.

A chat completion message generated by the model.

Parameters:

• content (String, nil) —

  The contents of the message.

• refusal (String, nil) —

  The refusal message generated by the model.

• id (String) —

  The identifier of the chat message.

• annotations (Array<OpenAI::Models::Chat::ChatCompletionMessage::Annotation>) (defaults to: nil) —

  Annotations for the message, when applicable, as when using the

• audio (OpenAI::Models::Chat::ChatCompletionAudio, nil) (defaults to: nil) —

  If the audio output modality is requested, this object contains data

• function_call (OpenAI::Models::Chat::ChatCompletionMessage::FunctionCall) (defaults to: nil) —

  Deprecated and replaced by tool_calls. The name and arguments of a function th

• tool_calls (Array<OpenAI::Models::Chat::ChatCompletionMessageFunctionToolCall, OpenAI::Models::Chat::ChatCompletionMessageCustomToolCall>) (defaults to: nil) —

  The tool calls generated by the model, such as function calls.

• content_parts (Array<OpenAI::Models::Chat::ChatCompletionContentPartText, OpenAI::Models::Chat::ChatCompletionContentPartImage>, nil) (defaults to: nil) —

  If a content parts array was provided, this is an array of text and `image_url

• role (Symbol, :assistant) (defaults to: :assistant) —

  The role of the author of this message.

# File 'lib/openai/models/chat/chat_completion_store_message.rb', line 26

Instance Attribute Details

#content_parts ⇒ Array<OpenAI::Models::Chat::ChatCompletionContentPartText, OpenAI::Models::Chat::ChatCompletionContentPartImage>^?

If a content parts array was provided, this is an array of text and image_url parts. Otherwise, null.

Returns:

• (Array<OpenAI::Models::Chat::ChatCompletionContentPartText, OpenAI::Models::Chat::ChatCompletionContentPartImage>, nil)

# File 'lib/openai/models/chat/chat_completion_store_message.rb', line 18

optional(
  :content_parts,
  -> {
    OpenAI::Internal::Type::ArrayOf[union: OpenAI::Chat::ChatCompletionStoreMessage::ContentPart]
  },
  nil?: true
)

#id ⇒ String

The identifier of the chat message.

Parameters:

• _ (String)

Returns:

• (String)

# File 'lib/openai/models/chat/chat_completion_store_message.rb', line 11

required :id, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/chat/chat_completion_store_message.rbs', line 42

def to_hash: -> {