# `ReqLLM.RerankResponse`
[🔗](https://github.com/agentjido/req_llm/blob/main/lib/req_llm/rerank_response.ex#L1)

Canonical reranking response for ReqLLM.

Results are ordered from most relevant to least relevant and include the
original document text for convenience.

# `result_item`

```elixir
@type result_item() :: %{
  index: non_neg_integer(),
  relevance_score: float(),
  document: String.t()
}
```

# `t`

```elixir
@type t() :: %ReqLLM.RerankResponse{
  id: String.t() | nil,
  meta: map() | nil,
  model: String.t() | nil,
  query: String.t(),
  results: [result_item()]
}
```

---

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