Class: OpenAI::Models::Conversations::ComputerScreenshotContent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Conversations::ComputerScreenshotContent

Defined in:

lib/openai/models/conversations/computer_screenshot_content.rb

Instance Attribute Summary

• #file_id ⇒ String^?

  The identifier of an uploaded file that contains the screenshot.

• #image_url ⇒ String^?

  The URL of the screenshot image.

• #type ⇒ Symbol, :computer_screenshot

  Specifies the event type.

Instance Method Summary

• #initialize(file_id:, image_url:, type: :computer_screenshot) ⇒ Object constructor

  Some parameter documentations has been truncated, see ComputerScreenshotContent 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, 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(file_id:, image_url:, type: :computer_screenshot) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Conversations::ComputerScreenshotContent for more details.

A screenshot of a computer.

Parameters:

• file_id (String, nil) —

  The identifier of an uploaded file that contains the screenshot.

• image_url (String, nil) —

  The URL of the screenshot image.

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

  Specifies the event type. For a computer screenshot, this property is always set

# File 'lib/openai/models/conversations/computer_screenshot_content.rb', line 26

Instance Attribute Details

#file_id ⇒ String^?

The identifier of an uploaded file that contains the screenshot.

Returns:

• (String, nil)

# File 'lib/openai/models/conversations/computer_screenshot_content.rb', line 11

required :file_id, String, nil?: true

#image_url ⇒ String^?

The URL of the screenshot image.

Returns:

• (String, nil)

# File 'lib/openai/models/conversations/computer_screenshot_content.rb', line 17

required :image_url, String, nil?: true

#type ⇒ Symbol, :computer_screenshot

Specifies the event type. For a computer screenshot, this property is always set to ‘computer_screenshot`.

Returns:

• (Symbol, :computer_screenshot)

# File 'lib/openai/models/conversations/computer_screenshot_content.rb', line 24

required :type, const: :computer_screenshot