Class: Tavily::CrawlResponse

Inherits:

Object

• Object
• Object
• Tavily::CrawlResponse

Includes:

Envelope

Defined in:

lib/tavily/responses.rb

Overview

Response from Tavily::Client#crawl.

Instance Attribute Summary

Attributes inherited from Object

#attributes

Instance Method Summary

• #base_url ⇒ String^?

  The root URL that was crawled.

• #results ⇒ Array<CrawlResult>

  Crawled pages.

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

#base_url ⇒ String^?

Returns the root URL that was crawled.

Returns:

• (String, nil) —

  the root URL that was crawled.

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

attribute :base_url

#results ⇒ Array<CrawlResult>

Returns crawled pages.

Returns:

• (Array<CrawlResult>) —

  crawled pages.

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

attribute :results, wrap: CrawlResult, collection: true