Class: Telnyx::Models::WebSearch::ResearchCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::WebSearch::ResearchCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/web_search/research_create_params.rb,
sig/telnyx/models/web_search/research_create_params.rbs

Overview

See Also:

• Telnyx::Resources::WebSearch::Research#create

Defined Under Namespace

Modules: ResearchEffort

Instance Attribute Summary

• #background ⇒ Boolean^?

  When true, the research runs asynchronously.

• #max_sources ⇒ Integer^?

  Maximum number of sources to use.

• #query ⇒ String

  The research question or topic.

• #research_effort ⇒ Symbol, ...

  Research depth level.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(query:, background: nil, max_sources: nil, research_effort: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ResearchCreateParams for more details.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(query:, background: nil, max_sources: nil, research_effort: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::WebSearch::ResearchCreateParams for more details.

Parameters:

• query (String) —

  The research question or topic.

• background (Boolean) (defaults to: nil) —

  When true, the research runs asynchronously. The response returns a task_id

• max_sources (Integer) (defaults to: nil) —

  Maximum number of sources to use.

• research_effort (Symbol, Telnyx::Models::WebSearch::ResearchCreateParams::ResearchEffort) (defaults to: nil) —

  Research depth level. lite is fastest, deep is most thorough.

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/telnyx/models/web_search/research_create_params.rb', line 37

Instance Attribute Details

#background ⇒ Boolean^?

When true, the research runs asynchronously. The response returns a task_id immediately instead of waiting for the result. Poll GET /web_search/research/{task_id} to check status.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/web_search/research_create_params.rb', line 23

optional :background, Telnyx::Internal::Type::Boolean

#max_sources ⇒ Integer^?

Maximum number of sources to use.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/web_search/research_create_params.rb', line 29

optional :max_sources, Integer

#query ⇒ String

The research question or topic.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/web_search/research_create_params.rb', line 15

required :query, String

#research_effort ⇒ Symbol, ...

Research depth level. lite is fastest, deep is most thorough.

Returns:

• (Symbol, Telnyx::Models::WebSearch::ResearchCreateParams::ResearchEffort, nil)

# File 'lib/telnyx/models/web_search/research_create_params.rb', line 35

optional :research_effort, enum: -> { Telnyx::WebSearch::ResearchCreateParams::ResearchEffort }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/web_search/research_create_params.rbs', line 41

def to_hash: -> {