Module: Tavily::Envelope

Included in:

CrawlResponse, ExtractResponse, MapResponse, ResearchTask, SearchResponse

Defined in:

lib/tavily/responses.rb

Overview

Mixin adding usage/credits/request_id/response_time accessors shared by every top-level response.

Class Method Summary

• .included(base) ⇒ Object

Instance Method Summary

• #credits ⇒ Integer^?

  Convenience accessor for usage.credits.

• #usage ⇒ Usage^?

  Credit usage details (when include_usage: true).

Class Method Details

.included(base) ⇒ Object

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

def self.included(base)
  base.attribute :response_time
  base.attribute :request_id
end

Instance Method Details

#credits ⇒ Integer^?

Returns convenience accessor for usage.credits.

Returns:

• (Integer, nil) —

  convenience accessor for usage.credits.

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

def credits
  usage&.credits
end

#usage ⇒ Usage^?

Returns credit usage details (when include_usage: true).

Returns:

• (Usage, nil) —

  credit usage details (when include_usage: true).

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

def usage
  raw = self["usage"]
  raw.is_a?(Hash) ? Usage.new(raw) : nil
end