Class: Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/web_search/research_retrieve_response.rb,
sig/telnyx/models/web_search/research_retrieve_response.rbs

Overview

See Also:

  • Telnyx::Models::WebSearch::ResearchRetrieveResponse#data

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Instance Method Summary collapse

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(status:, task_id:, answer: nil, citations: nil, error: nil) ⇒ Object

Parameters:




# File 'lib/telnyx/models/web_search/research_retrieve_response.rb', line 48

Instance Attribute Details

#answer ⇒ String?

The synthesized research answer (present when status is completed).

Parameters:

  • (String)

Returns:

  • (String, nil) 


34
 
# File 'lib/telnyx/models/web_search/research_retrieve_response.rb', line 34

optional :answer, String

#citations ⇒ Array<Telnyx::Models::WebSearch::ResearchCitation>?

Sources cited in the answer (present when status is completed).

Returns:



40
 
# File 'lib/telnyx/models/web_search/research_retrieve_response.rb', line 40

optional :citations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::WebSearch::ResearchCitation] }

#error ⇒ String?

Always present in poll responses; null unless the task failed.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


46
 
# File 'lib/telnyx/models/web_search/research_retrieve_response.rb', line 46

optional :error, String, nil?: true

#status ⇒ Symbol, Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status

Current status of the research task.

Parameters:

  • value (Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::status)

Returns:



22
 
# File 'lib/telnyx/models/web_search/research_retrieve_response.rb', line 22

required :status, enum: -> { Telnyx::Models::WebSearch::ResearchRetrieveResponse::Data::Status }

#task_id ⇒ String

The research task identifier.

Parameters:

  • value (String)

Returns:

  • (String) 


28
 
# File 'lib/telnyx/models/web_search/research_retrieve_response.rb', line 28

required :task_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


56
 
# File 'sig/telnyx/models/web_search/research_retrieve_response.rbs', line 56

def to_hash: -> {