Class: OpenAI::Models::CompletionCreateParams

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

Overview

See Also:

Defined Under Namespace

Modules: Model, Prompt, Stop

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(model: , prompt: , best_of: nil, echo: nil, frequency_penalty: nil, logit_bias: nil, logprobs: nil, max_tokens: nil, n: nil, presence_penalty: nil, seed: nil, stop: nil, stream_options: nil, suffix: nil, temperature: nil, top_p: nil, user: nil, request_options: {}) ⇒ Object

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

Parameters:

  • model (String, Symbol, OpenAI::Models::CompletionCreateParams::Model) (defaults to: ) —

    ID of the model to use. You can use the [List models](platform.openai.co

  • prompt (String, Array<String>, Array<Integer>, Array<Array<Integer>>, nil) (defaults to: ) —

    The prompt(s) to generate completions for, encoded as a string, array of strings

  • best_of (Integer, nil) (defaults to: nil) —

    Generates ‘best_of` completions server-side and returns the “best” (the one with

  • echo (Boolean, nil) (defaults to: nil) —

    Echo back the prompt in addition to the completion

  • frequency_penalty (Float, nil) (defaults to: nil) —

    Number between -2.0 and 2.0. Positive values penalize new tokens based on their

  • logit_bias (Hash{Symbol=>Integer}, nil) (defaults to: nil) —

    Modify the likelihood of specified tokens appearing in the completion.

  • logprobs (Integer, nil) (defaults to: nil) —

    Include the log probabilities on the ‘logprobs` most likely output tokens, as we

  • max_tokens (Integer, nil) (defaults to: nil) —

    The maximum number of [tokens](/tokenizer) that can be generated in the completi

  • n (Integer, nil) (defaults to: nil) —

    How many completions to generate for each prompt.

  • presence_penalty (Float, nil) (defaults to: nil) —

    Number between -2.0 and 2.0. Positive values penalize new tokens based on whethe

  • seed (Integer, nil) (defaults to: nil) —

    If specified, our system will make a best effort to sample deterministically, su

  • stop (String, Array<String>, nil) (defaults to: nil) —

    Not supported with latest reasoning models ‘o3` and `o4-mini`.

  • stream_options (OpenAI::Models::Chat::ChatCompletionStreamOptions, nil) (defaults to: nil) —

    Options for streaming response. Only set this when you set ‘stream: true`.

  • suffix (String, nil) (defaults to: nil) —

    The suffix that comes after a completion of inserted text.

  • temperature (Float, nil) (defaults to: nil) —

    What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m

  • top_p (Float, nil) (defaults to: nil) —

    An alternative to sampling with temperature, called nucleus sampling, where the

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

    A unique identifier representing your end-user, which can help OpenAI to monitor

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



# File 'lib/openai/models/completion_create_params.rb', line 185

Instance Attribute Details

#best_of ⇒ Integer?

Generates ‘best_of` completions server-side and returns the “best” (the one with the highest log probability per token). Results cannot be streamed.

When used with ‘n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`.

Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for ‘max_tokens` and `stop`.

Returns:

  • (Integer, nil) 


45
 
# File 'lib/openai/models/completion_create_params.rb', line 45

optional :best_of, Integer, nil?: true

#echo ⇒ Boolean?

Echo back the prompt in addition to the completion

Returns:



51
 
# File 'lib/openai/models/completion_create_params.rb', line 51

optional :echo, OpenAI::Internal::Type::Boolean, nil?: true

#frequency_penalty ⇒ Float?

Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model’s likelihood to repeat the same line verbatim.

[See more information about frequency and presence penalties.](platform.openai.com/docs/guides/text-generation)

Returns:

  • (Float, nil) 


61
 
# File 'lib/openai/models/completion_create_params.rb', line 61

optional :frequency_penalty, Float, nil?: true

#logit_bias ⇒ Hash{Symbol=>Integer}?

Modify the likelihood of specified tokens appearing in the completion.

Accepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](/tokenizer?view=bpe) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.

As an example, you can pass ‘-100` to prevent the <|endoftext|> token from being generated.

Returns:

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


78
 
# File 'lib/openai/models/completion_create_params.rb', line 78

optional :logit_bias, OpenAI::Internal::Type::HashOf[Integer], nil?: true

#logprobs ⇒ Integer?

Include the log probabilities on the ‘logprobs` most likely output tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response.

The maximum value for ‘logprobs` is 5.

Returns:

  • (Integer, nil) 


89
 
# File 'lib/openai/models/completion_create_params.rb', line 89

optional :logprobs, Integer, nil?: true

#max_tokens ⇒ Integer?

The maximum number of [tokens](/tokenizer) that can be generated in the completion.

The token count of your prompt plus ‘max_tokens` cannot exceed the model’s context length. [Example Python code](cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.

Returns:

  • (Integer, nil) 


101
 
# File 'lib/openai/models/completion_create_params.rb', line 101

optional :max_tokens, Integer, nil?: true

#model ⇒ String, ...

ID of the model to use. You can use the [List models](platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](platform.openai.com/docs/models) for descriptions of them.

Returns:



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

required :model, union: -> { OpenAI::CompletionCreateParams::Model }

#n ⇒ Integer?

How many completions to generate for each prompt.

Note: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for ‘max_tokens` and `stop`.

Returns:

  • (Integer, nil) 


111
 
# File 'lib/openai/models/completion_create_params.rb', line 111

optional :n, Integer, nil?: true

#presence_penalty ⇒ Float?

Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model’s likelihood to talk about new topics.

[See more information about frequency and presence penalties.](platform.openai.com/docs/guides/text-generation)

Returns:

  • (Float, nil) 


121
 
# File 'lib/openai/models/completion_create_params.rb', line 121

optional :presence_penalty, Float, nil?: true

#prompt ⇒ String, ...

The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.

Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.

Returns:

  • (String, Array<String>, Array<Integer>, Array<Array<Integer>>, nil) 


31
 
# File 'lib/openai/models/completion_create_params.rb', line 31

required :prompt, union: -> { OpenAI::CompletionCreateParams::Prompt }, nil?: true

#seed ⇒ Integer?

If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same ‘seed` and parameters should return the same result.

Determinism is not guaranteed, and you should refer to the ‘system_fingerprint` response parameter to monitor changes in the backend.

Returns:

  • (Integer, nil) 


132
 
# File 'lib/openai/models/completion_create_params.rb', line 132

optional :seed, Integer, nil?: true

#stop ⇒ String, ...

Not supported with latest reasoning models ‘o3` and `o4-mini`.

Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.

Returns:

  • (String, Array<String>, nil) 


141
 
# File 'lib/openai/models/completion_create_params.rb', line 141

optional :stop, union: -> { OpenAI::CompletionCreateParams::Stop }, nil?: true

#stream_options ⇒ OpenAI::Models::Chat::ChatCompletionStreamOptions?

Options for streaming response. Only set this when you set ‘stream: true`.

Returns:



147
 
# File 'lib/openai/models/completion_create_params.rb', line 147

optional :stream_options, -> { OpenAI::Chat::ChatCompletionStreamOptions }, nil?: true

#suffix ⇒ String?

The suffix that comes after a completion of inserted text.

This parameter is only supported for ‘gpt-3.5-turbo-instruct`.

Returns:

  • (String, nil) 


155
 
# File 'lib/openai/models/completion_create_params.rb', line 155

optional :suffix, String, nil?: true

#temperature ⇒ Float?

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

We generally recommend altering this or ‘top_p` but not both.

Returns:

  • (Float, nil) 


165
 
# File 'lib/openai/models/completion_create_params.rb', line 165

optional :temperature, Float, nil?: true

#top_p ⇒ Float?

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

We generally recommend altering this or ‘temperature` but not both.

Returns:

  • (Float, nil) 


175
 
# File 'lib/openai/models/completion_create_params.rb', line 175

optional :top_p, Float, nil?: true

#user ⇒ String?

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](platform.openai.com/docs/guides/safety-best-practices#end-user-ids).

Returns:

  • (String, nil) 


183
 
# File 'lib/openai/models/completion_create_params.rb', line 183

optional :user, String