Class: OpenAI::Models::Beta::HostedPluginParam

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/hosted_plugin_param.rb,
sig/openai/models/beta/hosted_plugin_param.rbs

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, dump, #dump, #inspect, inspect, meta_info, 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(description:, name:, source:, type: :inline) ⇒ Object

Supplies a plugin ZIP directly in the session request.

Parameters:

  • description (String) —

    The plugin description declared in .codex-plugin/plugin.json.

  • name (String) —

    The plugin name declared in .codex-plugin/plugin.json.

  • source (OpenAI::Models::Beta::InlineCapabilitySourceParam) —

    Provides ZIP bytes encoded with standard base64.

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

    The type of the object. Always inline.




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

Instance Attribute Details

#description ⇒ String

The plugin description declared in .codex-plugin/plugin.json.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/openai/models/beta/hosted_plugin_param.rb', line 11

required :description, String

#name ⇒ String

The plugin name declared in .codex-plugin/plugin.json.

Parameters:

  • value (String)

Returns:

  • (String) 


17
 
# File 'lib/openai/models/beta/hosted_plugin_param.rb', line 17

required :name, String

#source ⇒ OpenAI::Models::Beta::InlineCapabilitySourceParam

Provides ZIP bytes encoded with standard base64.

Parameters:

  • value (OpenAI::Beta::InlineCapabilitySourceParam)

Returns:



23
 
# File 'lib/openai/models/beta/hosted_plugin_param.rb', line 23

required :source, -> { OpenAI::Beta::InlineCapabilitySourceParam }

#type ⇒ Symbol, :inline

The type of the object. Always inline.

Parameters:

  • value (:inline)

Returns:

  • (Symbol, :inline) 


29
 
# File 'lib/openai/models/beta/hosted_plugin_param.rb', line 29

required :type, const: :inline

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


28
 
# File 'sig/openai/models/beta/hosted_plugin_param.rbs', line 28

def to_hash: -> {