Module: OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::File

Extended by:
Internal::Type::Union
Defined in:
lib/openai/models/beta/agents/environments/environment_template.rb,
sig/openai/models/beta/agents/environments/environment_template.rbs

Overview

Safe metadata for a file configured by an environment template.

Defined Under Namespace

Classes: FileID, Inline

Instance Method Summary collapse

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, coerce_with_error, dump, #dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Instance Method Details

#initialize(file_id:, path:, type: :file_id) ⇒ Object

A project-scoped Files API reference resolved separately for each session.

Parameters:

  • file_id (String) —

    The ID of the uploaded file.

  • path (String) —

    The file's absolute path inside the environment.

  • type (Symbol, :file_id) (defaults to: :file_id) —

    The type of the object. Always file_id.




# File 'lib/openai/models/beta/agents/environments/environment_template.rb', line 154

#self?.variants ⇒ ::Array[OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::file]

Returns:

  • (::Array[OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::file]) 


126
 
# File 'sig/openai/models/beta/agents/environments/environment_template.rbs', line 126

def self?.variants: -> ::Array[OpenAI::Models::Beta::Agents::Environments::EnvironmentTemplate::file]