Class: OpenAI::Models::Beta::BetaWebSearchTool::Filters

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::BetaWebSearchTool::Filters

Defined in:

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

Overview

See Also:

• OpenAI::Models::Beta::BetaWebSearchTool#filters

Instance Attribute Summary

• #allowed_domains ⇒ Array<String>^?

  Allowed domains for the search.

Instance Method Summary

• #initialize ⇒ Filters constructor

  A new instance of Filters.

• #to_hash ⇒ { allowed_domains: ::Array[String]? }

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

Returns a new instance of Filters.

Parameters:

• allowed_domains: (::Array[String], nil)

# File 'sig/openai/models/beta/beta_web_search_tool.rbs', line 57

def initialize: (?allowed_domains: ::Array[String]?) -> void

Instance Attribute Details

#allowed_domains ⇒ Array<String>^?

Allowed domains for the search. If not provided, all domains are allowed. Subdomains of the provided domains are allowed as well.

Example: ["pubmed.ncbi.nlm.nih.gov"]

Parameters:

• value (::Array[String], nil)

Returns:

• (Array<String>, nil)

# File 'lib/openai/models/beta/beta_web_search_tool.rb', line 69

optional :allowed_domains, OpenAI::Internal::Type::ArrayOf[String], nil?: true

Instance Method Details

#to_hash ⇒ { allowed_domains: ::Array[String]? }

Returns:

• ({ allowed_domains: ::Array[String]? })

# File 'sig/openai/models/beta/beta_web_search_tool.rbs', line 59

def to_hash: -> { allowed_domains: ::Array[String]? }