Class: OpenAI::Models::Chat::CompletionListParams

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

Overview

See Also:

Defined Under Namespace

Modules: Order

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(after: nil, limit: nil, metadata: nil, model: nil, order: nil, request_options: {}) ⇒ Object

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

Parameters:

  • after (String) (defaults to: nil) —

    Identifier for the last chat completion from the previous pagination request.

  • limit (Integer) (defaults to: nil) —

    Number of Chat Completions to retrieve.

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

    A list of metadata keys to filter the Chat Completions by. Example:

  • model (String) (defaults to: nil) —

    The model used to generate the Chat Completions.

  • order (Symbol, OpenAI::Models::Chat::CompletionListParams::Order) (defaults to: nil) —

    Sort order for Chat Completions by timestamp. Use ‘asc` for ascending order or `

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



# File 'lib/openai/models/chat/completion_list_params.rb', line 44

Instance Attribute Details

#after ⇒ String?

Identifier for the last chat completion from the previous pagination request.

Returns:

  • (String, nil) 


15
 
# File 'lib/openai/models/chat/completion_list_params.rb', line 15

optional :after, String

#limit ⇒ Integer?

Number of Chat Completions to retrieve.

Returns:

  • (Integer, nil) 


21
 
# File 'lib/openai/models/chat/completion_list_params.rb', line 21

optional :limit, Integer

#metadata ⇒ Hash{Symbol=>String}?

A list of metadata keys to filter the Chat Completions by. Example:

‘metadata=value1&metadata=value2`

Returns:

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


29
 
# File 'lib/openai/models/chat/completion_list_params.rb', line 29

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

#model ⇒ String?

The model used to generate the Chat Completions.

Returns:

  • (String, nil) 


35
 
# File 'lib/openai/models/chat/completion_list_params.rb', line 35

optional :model, String

#order ⇒ Symbol, ...

Sort order for Chat Completions by timestamp. Use ‘asc` for ascending order or `desc` for descending order. Defaults to `asc`.

Returns:



42
 
# File 'lib/openai/models/chat/completion_list_params.rb', line 42

optional :order, enum: -> { OpenAI::Chat::CompletionListParams::Order }