> ## Documentation Index
> Fetch the complete documentation index at: https://phaseo.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Phaseo Gateway base URL: https://api.phaseo.app/v1. Send `Authorization: Bearer $PHASEO_API_KEY` with every request.
> Model IDs look like `provider/model`, for example `openai/gpt-6-astra`. Do not guess IDs: list them with `GET /v1/models` or check https://phaseo.app/models. `phaseo/free` routes to an available free model and needs no wallet balance.
> For new text integrations prefer `POST /v1/responses`. `POST /v1/chat/completions` (OpenAI format) and `POST /v1/messages` (Anthropic format) suit existing code.
> The full API contract is https://phaseo.app/docs/openapi/v1/openapi.yaml. Official SDKs: `@phaseo/sdk` (TypeScript) and `phaseo` (Python), plus Go, C#, PHP, Ruby and Rust.
> Search these docs over MCP at https://phaseo.app/docs/mcp, and install Phaseo skills with `npx skills add https://phaseo.app/docs`. If a page is wrong or out of date, report it with the MCP `submit_feedback` tool.
> Manage Phaseo accounts with the `phaseo` CLI (`npm install -g @phaseo/cli`, then `phaseo login` or `phaseo login --device-code`), the `/v1` Management API or the MCP server at `https://mcp.phaseo.app/mcp?access=manage`. Do not send users to the dashboard for account tasks. A person is still needed for sign-up, approving a sign-in, paying the first top-up on the checkout link that `phaseo credits add` returns when no card is saved, confirming each saved-card top-up from the emailed link, and account security (password, MFA, passkeys). Create API keys with `phaseo keys create --name <name> --json`; never guess one. Credit top-ups need `phaseo login --scopes billing:write` first. Task map: https://phaseo.app/docs/v1/developers/manage-from-an-agent.md.

# Reordenar documentos

> Ordene documentos candidatos por relevância para uma consulta com POST /v1/rerank.

Chame `client.rerank.create()` para ordenar documentos candidatos por relevância para uma consulta com `POST /v1/rerank`. O método tem o mesmo nome em TypeScript e Python; o Rust envia o mesmo JSON com `client.post()`.

```typescript TypeScript theme={null}
import Phaseo from "@phaseo/sdk";

const client = new Phaseo({ apiKey: process.env.PHASEO_API_KEY! });

const result = await client.rerank.create({
  model: "voyage/rerank-2",
  query: "How do I check whether a model is routable?",
  documents: [
    "Call GET /v1/models and use the default availability filter.",
    "Create an image with POST /v1/images/generations.",
  ],
});

console.log(result.results);
```

```python Python theme={null}
from phaseo import Phaseo

client = Phaseo()  # lê PHASEO_API_KEY

result = client.rerank.create({
    "model": "voyage/rerank-2",
    "query": "How do I check whether a model is routable?",
    "documents": [
        "Call GET /v1/models and use the default availability filter.",
        "Create an image with POST /v1/images/generations.",
    ],
})

print(result["results"])
```

```rust Rust theme={null}
// Ainda não há método de rerank: post() envia JSON para qualquer caminho do Phaseo.
use phaseo::Phaseo;
use serde_json::json;

let client = Phaseo::from_env()?; // lê PHASEO_API_KEY

let result = client.post("/rerank", &json!({
    "model": "voyage/rerank-2",
    "query": "How do I check whether a model is routable?",
    "documents": [
        "Call GET /v1/models and use the default availability filter.",
        "Create an image with POST /v1/images/generations."
    ]
}))?;

println!("{}", result.body["results"]);
```

**Python:** `client.rerank.create()` envia o dict que você passa como corpo JSON e retorna a resposta JSON; não há um helper tipado `generate_rerank`. Em `AsyncPhaseo`, use await.

Os SDKs de Go, C#, PHP, Ruby e Java não têm método de rerank. Envie `POST /v1/rerank` com o seu cliente HTTP, como na [referência da API de rerank](https://phaseo.app/docs/pt-BR/v1/api-reference/endpoint/rerank.md).

Confirme o ID do modelo com `GET /v1/models` antes de usá-lo em produção.

## Parâmetros

Os nomes dos campos são os campos do corpo JSON em todos os SDKs.

| Campo | Observações |
| - | - |
| `model`, `query`, `documents` | Obrigatórios. `documents` contém pelo menos uma string ou um objeto. |
| `top_n` | Retorna apenas os `n` melhores resultados. `top_k` é aceito como alias. |
| `return_documents` | Inclui cada documento no seu resultado. |
| `rank_fields` | Para documentos do tipo objeto, os campos usados na classificação. |
| `max_chunks_per_doc`, `max_tokens_per_doc` | Limites para documentos longos, nos provedores que dão suporte. |

## Resposta

`RerankResponse` tem `results`, cada um com o `index` do documento na sua lista, o `relevance_score` dele e o `document` quando `return_documents` está definido, além de `usage`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.