Class: OpenAI::Models::Beta::WebSearchAction::OpenPage

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::WebSearchAction::OpenPage

Defined in:

lib/openai/models/beta/web_search_action.rb,
sig/openai/models/beta/web_search_action.rbs

Instance Attribute Summary

• #type ⇒ Symbol, :open_page

  The type of the object.

• #url ⇒ String^?

  The URL of the page that was opened.

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize ⇒ OpenPage constructor

  A new instance of OpenPage.

• #to_hash ⇒ { ?type: :open_page, url: String? }

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 ⇒ OpenPage

Returns a new instance of OpenPage.

Parameters:

• url: (String, nil)
• type: (:open_page)

# File 'sig/openai/models/beta/web_search_action.rbs', line 43

def initialize: (url: String?, ?type: :open_page) -> void

Instance Attribute Details

#type ⇒ Symbol, :open_page

The type of the object. Always open_page.

Parameters:

• value (:open_page)

Returns:

• (Symbol, :open_page)

# File 'lib/openai/models/beta/web_search_action.rb', line 61

required :type, const: :open_page

#url ⇒ String^?

The URL of the page that was opened.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/openai/models/beta/web_search_action.rb', line 67

required :url, String, nil?: true

Instance Method Details

#to_hash ⇒ { ?type: :open_page, url: String? }

Returns:

• ({ ?type: :open_page, url: String? })

# File 'sig/openai/models/beta/web_search_action.rbs', line 45

def to_hash: -> { ?type: :open_page, url: String? }