Class: OpenAI::Models::Responses::ComputerTool

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

Defined Under Namespace

Modules: Environment

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, 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(display_height: , display_width: , environment: , type: :computer_use_preview) ⇒ Object

A tool that controls a virtual computer. Learn more about the [computer tool](platform.openai.com/docs/guides/tools-computer-use).

Parameters:

  • display_height (Integer) (defaults to: ) —

    The height of the computer display.

  • display_width (Integer) (defaults to: ) —

    The width of the computer display.

  • environment (Symbol, OpenAI::Models::Responses::ComputerTool::Environment) (defaults to: ) —

    The type of computer environment to control.

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

    The type of the computer use tool. Always ‘computer_use_preview`.




# File 'lib/openai/models/responses/computer_tool.rb', line 31

Instance Attribute Details

#display_height ⇒ Integer

The height of the computer display.

Returns:

  • (Integer) 


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

required :display_height, Integer

#display_width ⇒ Integer

The width of the computer display.

Returns:

  • (Integer) 


17
 
# File 'lib/openai/models/responses/computer_tool.rb', line 17

required :display_width, Integer

#environment ⇒ Symbol, OpenAI::Models::Responses::ComputerTool::Environment

The type of computer environment to control.

Returns:



23
 
# File 'lib/openai/models/responses/computer_tool.rb', line 23

required :environment, enum: -> { OpenAI::Responses::ComputerTool::Environment }

#type ⇒ Symbol, :computer_use_preview

The type of the computer use tool. Always ‘computer_use_preview`.

Returns:

  • (Symbol, :computer_use_preview) 


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

required :type, const: :computer_use_preview