Kagi.Search (kagi_ex v0.1.0)

Copy Markdown View Source

Search response returned by Kagi.search/1..3.

Contains parsed result rows and related-search suggestions.

Fields

  • :results - search result rows, truncated to the requested :limit.
  • :related - related-search suggestions; empty when Kagi returns none.

Summary

Types

Search lens passed via the :lens option.

Result ordering passed via the :sort option.

t()

A parsed Kagi search response.

Relative time window passed via the :time option.

Types

lens()

@type lens() ::
  :default | :programming | :forums | :pdfs | :non_commercial | :world_news

Search lens passed via the :lens option.

sort()

@type sort() :: :recency | :website | :ad_trackers

Result ordering passed via the :sort option.

t()

@type t() :: %Kagi.Search{related: [String.t()], results: [Kagi.SearchResult.t()]}

A parsed Kagi search response.

time_range()

@type time_range() :: :day | :week | :month | :year

Relative time window passed via the :time option.