Class: OpenAI::Models::Chat::ChatCompletionFunctionMessageParam Deprecated

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Chat::ChatCompletionFunctionMessageParam

Defined in:

lib/openai/models/chat/chat_completion_function_message_param.rb

Overview

Deprecated.

Instance Attribute Summary

• #content ⇒ String^?

  The contents of the function message.

• #name ⇒ String

  The name of the function to call.

• #role ⇒ Symbol, :function

  The role of the messages author, in this case ‘function`.

Method Summary

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, 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

#content ⇒ String^?

The contents of the function message.

Returns:

• (String, nil)

# File 'lib/openai/models/chat/chat_completion_function_message_param.rb', line 12

required :content, String, nil?: true

#name ⇒ String

The name of the function to call.

Returns:

• (String)

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

required :name, String

#role ⇒ Symbol, :function

The role of the messages author, in this case ‘function`.

Returns:

• (Symbol, :function)

# File 'lib/openai/models/chat/chat_completion_function_message_param.rb', line 24

required :role, const: :function