Class: Tavily::SearchResponse

Inherits:
Object
  • Object
show all
Includes:
Envelope
Defined in:
lib/tavily/responses.rb

Overview

Response from Client#search.

Instance Attribute Summary

Attributes inherited from Object

#attributes

Instance Method Summary collapse

Methods included from Envelope

#credits, included, #usage

Methods inherited from Object

#==, #[], attribute, #dig, #hash, #initialize, #inspect, #key?, #to_h

Constructor Details

This class inherits a constructor from Tavily::Object

Instance Method Details

#answer ⇒ String?

Returns LLM-generated answer (when include_answer requested).

Returns:

  • (String, nil) —

    LLM-generated answer (when include_answer requested).



66
 
# File 'lib/tavily/responses.rb', line 66

attribute :answer

#auto_parameters ⇒ Hash?

Returns parameters auto-selected by Tavily (when auto_parameters: true).

Returns:

  • (Hash, nil) —

    parameters auto-selected by Tavily (when auto_parameters: true).



70
 
# File 'lib/tavily/responses.rb', line 70

attribute :auto_parameters

#follow_up_questions ⇒ Array?

Returns suggested follow-up questions, if any.

Returns:

  • (Array, nil) —

    suggested follow-up questions, if any.



68
 
# File 'lib/tavily/responses.rb', line 68

attribute :follow_up_questions

#images ⇒ Array<Image>

Returns related images (normalizes string and object forms).

Returns:

  • (Array<Image>) —

    related images (normalizes string and object forms).



75
76
77
78
79
 
# File 'lib/tavily/responses.rb', line 75

def images
  Array(self["images"]).map do |img|
    img.is_a?(Hash) ? Image.new(img) : Image.new("url" => img)
  end
end

#query ⇒ String

Returns the executed query.

Returns:

  • (String) —

    the executed query.



64
 
# File 'lib/tavily/responses.rb', line 64

attribute :query

#results ⇒ Array<SearchResult>

Returns ranked results.

Returns:



72
 
# File 'lib/tavily/responses.rb', line 72

attribute :results, wrap: SearchResult, collection: true

#urls ⇒ Array<String>

Returns convenience list of result URLs.

Returns:

  • (Array<String>) —

    convenience list of result URLs.



82
83
84
 
# File 'lib/tavily/responses.rb', line 82

def urls
  results.map(&:url)
end