# `Kagi.Search`
[🔗](https://github.com/rubas/kagi_ex/blob/v0.1.0/lib/kagi/search.ex#L1)

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.

# `lens`

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

Search lens passed via the `:lens` option.

# `sort`

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

Result ordering passed via the `:sort` option.

# `t`

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

A parsed Kagi search response.

# `time_range`

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

Relative time window passed via the `:time` option.

---

*Consult [api-reference.md](api-reference.md) for complete listing*