Class: Tavily::ExtractResult

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

Overview

A single successfully extracted page from Client#extract.

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

#favicon ⇒ String?

Returns favicon URL (when include_favicon: true).

Returns:

  • (String, nil) —

    favicon URL (when include_favicon: true).



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

attribute :favicon

#images ⇒ Array<String>

Returns image URLs (when include_images: true).

Returns:

  • (Array<String>) —

    image URLs (when include_images: true).



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

attribute :images

#raw_content ⇒ String?

Returns extracted content (markdown or text).

Returns:

  • (String, nil) —

    extracted content (markdown or text).



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

attribute :raw_content

#url ⇒ String?

Returns the extracted URL.

Returns:

  • (String, nil) —

    the extracted URL.



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

attribute :url