Module: OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::Mode

Extended by:

Internal::Type::Enum

Defined in:

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

Overview

The source used for web search results.

See Also:

• OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch#mode

Constant Summary

DISABLED =

Disables web search.

Returns:

• (:disabled)

:disabled

CACHED =

Uses cached search results.

Returns:

• (:cached)

:cached

LIVE =

Searches the live web.

Returns:

• (:live)

:live

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #self?.values ⇒ ::Array[OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::mode]

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, coerce_with_error, dump, #dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/openai/models/beta/persisted_agent_tool_param.rb', line 345

Instance Method Details

#self?.values ⇒ ::Array[OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::mode]

Returns:

• (::Array[OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::mode])

# File 'sig/openai/models/beta/persisted_agent_tool_param.rbs', line 243

def self?.values: -> ::Array[OpenAI::Models::Beta::PersistedAgentToolParam::WebSearch::mode]