Module: Telnyx::Models::WebSearch::ResearchCreateResponse::Data

Extended by:

Internal::Type::Union

Defined in:

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

Overview

Synchronous research response (when background is false or unset).

See Also:

• Telnyx::Models::WebSearch::ResearchCreateResponse#data

Defined Under Namespace

Classes: ResearchResponseAsync, ResearchResponseSync

Class Method Summary

• .variants ⇒ Array(Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync, Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync)

Instance Method Summary

• #initialize(answer:, citations: nil) ⇒ Object

  Synchronous research response (when background is false or unset).

• #self?.variants ⇒ ::Array[Telnyx::Models::WebSearch::ResearchCreateResponse::data]

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants

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, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.variants ⇒ Array(Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync, Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync)

Returns:

• (Array(Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseSync, Telnyx::Models::WebSearch::ResearchCreateResponse::Data::ResearchResponseAsync))

# File 'lib/telnyx/models/web_search/research_create_response.rb', line 87

Instance Method Details

#initialize(answer:, citations: nil) ⇒ Object

Synchronous research response (when background is false or unset).

Parameters:

• answer (String) —

  The synthesized research answer.

• citations (Array<Telnyx::Models::WebSearch::ResearchCitation>) (defaults to: nil) —

  Sources cited in the answer.

# File 'lib/telnyx/models/web_search/research_create_response.rb', line 42

#self?.variants ⇒ ::Array[Telnyx::Models::WebSearch::ResearchCreateResponse::data]

Returns:

• (::Array[Telnyx::Models::WebSearch::ResearchCreateResponse::data])

# File 'sig/telnyx/models/web_search/research_create_response.rbs', line 90

def self?.variants: -> ::Array[Telnyx::Models::WebSearch::ResearchCreateResponse::data]