Class: Tavily::CrawlResult

Inherits:

Object

• Object
• Object
• Tavily::CrawlResult

Defined in:

lib/tavily/responses.rb

Overview

A single page discovered by Tavily::Client#crawl.

Instance Attribute Summary

Attributes inherited from Object

#attributes

Instance Method Summary

• #favicon ⇒ String^?

  Favicon URL (when include_favicon: true).

• #raw_content ⇒ String^?

  Extracted content (markdown or text).

• #url ⇒ String^?

  Page URL.

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).

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

attribute :favicon

#raw_content ⇒ String^?

Returns extracted content (markdown or text).

Returns:

• (String, nil) —

  extracted content (markdown or text).

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

attribute :raw_content

#url ⇒ String^?

Returns page URL.

Returns:

• (String, nil) —

  page URL.

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

attribute :url