Class: Tavily::SearchResult

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

Overview

A single web result from Client#search.

Instance Attribute Summary

Attributes inherited from Object

#attributes

Instance Method Summary collapse

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

#content ⇒ String?

Returns short relevant snippet.

Returns:

  • (String, nil) —

    short relevant snippet.



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

attribute :content

#favicon ⇒ String?

Returns favicon URL (when include_favicon: true).

Returns:

  • (String, nil) —

    favicon URL (when include_favicon: true).



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

attribute :favicon

#published_date ⇒ String?

Returns publication date (present for topic: “news”).

Returns:

  • (String, nil) —

    publication date (present for topic: “news”).



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

attribute :published_date

#raw_content ⇒ String?

Returns full cleaned page content (when raw content requested).

Returns:

  • (String, nil) —

    full cleaned page content (when raw content requested).



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

attribute :raw_content

#score ⇒ Float?

Returns relevance score (0.0–1.0).

Returns:

  • (Float, nil) —

    relevance score (0.0–1.0).



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

attribute :score

#title ⇒ String?

Returns page title.

Returns:

  • (String, nil) —

    page title.



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

attribute :title

#url ⇒ String?

Returns result URL.

Returns:

  • (String, nil) —

    result URL.



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

attribute :url