Class: OpenAI::Models::Chat::CompletionUpdateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/chat/completion_update_params.rb

Overview

See Also:

• Resources::Chat::Completions#update

Instance Attribute Summary

• #metadata ⇒ Hash{Symbol=>String}^?

  Set of 16 key-value pairs that can be attached to an object.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(metadata: , request_options: {}) ⇒ Object constructor

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

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

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

Parameters:

• metadata (Hash{Symbol=>String}, nil) (defaults to: ) —

  Set of 16 key-value pairs that can be attached to an object. This can be

• request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/openai/models/chat/completion_update_params.rb', line 22

Instance Attribute Details

#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)

# File 'lib/openai/models/chat/completion_update_params.rb', line 20

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