Class: Tavily::MapResponse

Inherits:

Object

• Object
• Object
• Tavily::MapResponse

Includes:

Envelope

Defined in:

lib/tavily/responses.rb

Overview

Response from Client#map.

Instance Attribute Summary

Attributes inherited from Object

#attributes

Instance Method Summary

• #base_url ⇒ String^?

  The root URL that was mapped.

• #results ⇒ Array<String>

  Discovered URLs.

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

Returns:

• (String, nil) —

  the root URL that was mapped.

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

attribute :base_url

#results ⇒ Array<String>

Returns discovered URLs.

Returns:

• (Array<String>) —

  discovered URLs.

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

attribute :results