Class: Tavily::Image

Inherits:

Object

• Object
• Object
• Tavily::Image

Defined in:

lib/tavily/responses.rb

Overview

An image associated with a search result. Tavily returns images either as bare URL strings or as objects with a description; this normalizes both.

Instance Attribute Summary

Attributes inherited from Object

#attributes

Instance Method Summary

• #description ⇒ String^?

  Generated description (when image descriptions requested).

• #url ⇒ String^?

  Image 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

#description ⇒ String^?

Returns generated description (when image descriptions requested).

Returns:

• (String, nil) —

  generated description (when image descriptions requested).

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

attribute :description

#url ⇒ String^?

Returns image URL.

Returns:

• (String, nil) —

  image URL.

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

attribute :url