Class: OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::SamplingParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::SamplingParams

Defined in:

lib/openai/models/evals/create_eval_completions_run_data_source.rb

Overview

See Also:

• #sampling_params

Defined Under Namespace

Modules: ResponseFormat

Instance Attribute Summary

• #max_completion_tokens ⇒ Integer^?

  The maximum number of tokens in the generated output.

• #response_format ⇒ OpenAI::Models::ResponseFormatText, ...

  An object specifying the format that the model must output.

• #seed ⇒ Integer^?

  A seed value to initialize the randomness, during sampling.

• #temperature ⇒ Float^?

  A higher temperature increases randomness in the outputs.

• #tools ⇒ Array<OpenAI::Models::Chat::ChatCompletionTool>^?

  A list of tools the model may call.

• #top_p ⇒ Float^?

  An alternative to temperature for nucleus sampling; 1.0 includes all tokens.

Instance Method Summary

• #initialize(max_completion_tokens: nil, response_format: nil, seed: nil, temperature: nil, tools: nil, top_p: nil) ⇒ Object constructor

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

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(max_completion_tokens: nil, response_format: nil, seed: nil, temperature: nil, tools: nil, top_p: nil) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Evals::CreateEvalCompletionsRunDataSource::SamplingParams for more details.

Parameters:

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

  The maximum number of tokens in the generated output.

• response_format (OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::Models::ResponseFormatJSONObject) (defaults to: nil) —

  An object specifying the format that the model must output.

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

  A seed value to initialize the randomness, during sampling.

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

  A higher temperature increases randomness in the outputs.

• tools (Array<OpenAI::Models::Chat::ChatCompletionTool>) (defaults to: nil) —

  A list of tools the model may call. Currently, only functions are supported as a

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

  An alternative to temperature for nucleus sampling; 1.0 includes all tokens.

# File 'lib/openai/models/evals/create_eval_completions_run_data_source.rb', line 479

Instance Attribute Details

#max_completion_tokens ⇒ Integer^?

The maximum number of tokens in the generated output.

Returns:

• (Integer, nil)

# File 'lib/openai/models/evals/create_eval_completions_run_data_source.rb', line 433

optional :max_completion_tokens, Integer

#response_format ⇒ OpenAI::Models::ResponseFormatText, ...

An object specifying the format that the model must output.

Setting to ‘{ “type”: “json_schema”, “json_schema”: … }` enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the [Structured Outputs guide](platform.openai.com/docs/guides/structured-outputs).

Setting to ‘{ “type”: “json_object” }` enables the older JSON mode, which ensures the message the model generates is valid JSON. Using `json_schema` is preferred for models that support it.

Returns:

• (OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONSchema, OpenAI::Models::ResponseFormatJSONObject, nil)

# File 'lib/openai/models/evals/create_eval_completions_run_data_source.rb', line 448

optional :response_format,
union: -> {
  OpenAI::Evals::CreateEvalCompletionsRunDataSource::SamplingParams::ResponseFormat
}

#seed ⇒ Integer^?

A seed value to initialize the randomness, during sampling.

Returns:

• (Integer, nil)

# File 'lib/openai/models/evals/create_eval_completions_run_data_source.rb', line 457

optional :seed, Integer

#temperature ⇒ Float^?

A higher temperature increases randomness in the outputs.

Returns:

• (Float, nil)

# File 'lib/openai/models/evals/create_eval_completions_run_data_source.rb', line 463

optional :temperature, Float

#tools ⇒ Array<OpenAI::Models::Chat::ChatCompletionTool>^?

A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.

Returns:

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

# File 'lib/openai/models/evals/create_eval_completions_run_data_source.rb', line 471

optional :tools, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Chat::ChatCompletionTool] }

#top_p ⇒ Float^?

An alternative to temperature for nucleus sampling; 1.0 includes all tokens.

Returns:

• (Float, nil)

# File 'lib/openai/models/evals/create_eval_completions_run_data_source.rb', line 477

optional :top_p, Float