Class: OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams

Defined in:

lib/openai/models/evals/run_create_params.rb

Overview

See Also:

• #sampling_params

Defined Under Namespace

Classes: Text

Instance Attribute Summary

• #max_completion_tokens ⇒ Integer^?

  The maximum number of tokens in the generated output.

• #seed ⇒ Integer^?

  A seed value to initialize the randomness, during sampling.

• #temperature ⇒ Float^?

  A higher temperature increases randomness in the outputs.

• #text ⇒ OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text^?

  Configuration options for a text response from the model.

• #tools ⇒ Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>^?

  An array of tools the model may call while generating a response.

• #top_p ⇒ Float^?

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

Instance Method Summary

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

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

Parameters:

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

  The maximum number of tokens in the generated 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.

• text (OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text) (defaults to: nil) —

  Configuration options for a text response from the model. Can be plain

• tools (Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>) (defaults to: nil) —

  An array of tools the model may call while generating a response. You

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

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

# File 'lib/openai/models/evals/run_create_params.rb', line 617

Instance Attribute Details

#max_completion_tokens ⇒ Integer^?

The maximum number of tokens in the generated output.

Returns:

• (Integer, nil)

# File 'lib/openai/models/evals/run_create_params.rb', line 565

optional :max_completion_tokens, Integer

#seed ⇒ Integer^?

A seed value to initialize the randomness, during sampling.

Returns:

• (Integer, nil)

# File 'lib/openai/models/evals/run_create_params.rb', line 571

optional :seed, Integer

#temperature ⇒ Float^?

A higher temperature increases randomness in the outputs.

Returns:

• (Float, nil)

# File 'lib/openai/models/evals/run_create_params.rb', line 577

optional :temperature, Float

#text ⇒ OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text^?

Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more:

• [Text inputs and outputs](platform.openai.com/docs/guides/text)

• [Structured Outputs](platform.openai.com/docs/guides/structured-outputs)

Returns:

• (OpenAI::Models::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text, nil)

# File 'lib/openai/models/evals/run_create_params.rb', line 587

optional :text,
-> {
  OpenAI::Evals::RunCreateParams::DataSource::CreateEvalResponsesRunDataSource::SamplingParams::Text
}

#tools ⇒ Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>^?

An array of tools the model may call while generating a response. You can specify which tool to use by setting the ‘tool_choice` parameter.

The two categories of tools you can provide the model are:

• **Built-in tools**: Tools that are provided by OpenAI that extend the model’s capabilities, like [web search](platform.openai.com/docs/guides/tools-web-search) or [file search](platform.openai.com/docs/guides/tools-file-search). Learn more about [built-in tools](platform.openai.com/docs/guides/tools).

• **Function calls (custom tools)**: Functions that are defined by you, enabling the model to call your own code. Learn more about [function calling](platform.openai.com/docs/guides/function-calling).

Returns:

• (Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::WebSearchTool>, nil)

# File 'lib/openai/models/evals/run_create_params.rb', line 609

optional :tools, -> { OpenAI::Internal::Type::ArrayOf[union: OpenAI::Responses::Tool] }

#top_p ⇒ Float^?

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

Returns:

• (Float, nil)

# File 'lib/openai/models/evals/run_create_params.rb', line 615

optional :top_p, Float