Class: OpenAI::Models::Responses::ResponsePrompt

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_prompt.rb

Defined Under Namespace

Modules: Variable

Instance Attribute Summary collapse

Instance Method Summary collapse

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, new_coerce_state, 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(id: , variables: nil, version: nil) ⇒ void

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

Reference to a prompt template and its variables. Learn more.

Parameters:




# File 'lib/openai/models/responses/response_prompt.rb', line 29

Instance Attribute Details

#id ⇒ String

The unique identifier of the prompt template to use.

Returns:

  • (String) 


11
 
# File 'lib/openai/models/responses/response_prompt.rb', line 11

required :id, String

#variables ⇒ Hash{Symbol=>String, OpenAI::Models::Responses::ResponseInputText, OpenAI::Models::Responses::ResponseInputImage, OpenAI::Models::Responses::ResponseInputFile}?

Optional map of values to substitute in for variables in your prompt. The substitution values can either be strings, or other Response input types like images or files.

Returns:



19
20
21
 
# File 'lib/openai/models/responses/response_prompt.rb', line 19

optional :variables,
-> { OpenAI::Internal::Type::HashOf[union: OpenAI::Responses::ResponsePrompt::Variable] },
nil?: true

#version ⇒ String?

Optional version of the prompt template.

Returns:

  • (String, nil) 


27
 
# File 'lib/openai/models/responses/response_prompt.rb', line 27

optional :version, String, nil?: true