> ## 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.

# إعادة ترتيب المستندات

> رتّب المستندات المرشّحة بحسب صلتها باستعلام باستخدام POST /v1/rerank.

استدعِ `client.rerank.create()` لترتيب المستندات المرشّحة بحسب صلتها باستعلام باستخدام `POST /v1/rerank`. للدالة الاسم نفسه في TypeScript وPython؛ أما Rust فترسل بيانات JSON نفسها باستخدام `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()  # يقرأ 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}
// لا توجد دالة لإعادة الترتيب بعد: ترسل post() بيانات JSON إلى أي مسار في Phaseo.
use phaseo::Phaseo;
use serde_json::json;

let client = Phaseo::from_env()?; // يقرأ 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()` القاموس الذي تمرّره بوصفه جسم JSON وتعيد استجابة JSON؛ لا توجد دالة مساعدة `generate_rerank` ذات أنواع محددة. على `AsyncPhaseo`، استخدم await معها.

لا تتضمن حزم Go وC# وPHP وRuby وJava دالة لإعادة الترتيب. أرسل `POST /v1/rerank` باستخدام عميل HTTP الخاص بك، كما في [مرجع Rerank API](https://phaseo.app/docs/ar/v1/api-reference/endpoint/rerank.md).

تحقّق من معرّف النموذج باستخدام `GET /v1/models` قبل استخدامه في الإنتاج.

## المعاملات

أسماء الحقول في كل حزمة SDK هي حقول جسم JSON.

| الحقل | ملاحظات |
| - | - |
| `model`، `query`، `documents` | مطلوبة. يحتوي `documents` على سلسلة نصية أو كائن واحد على الأقل. |
| `top_n` | أعد أفضل `n` نتائج فقط. يُقبل `top_k` بوصفه اسمًا بديلًا. |
| `return_documents` | ضمّن كل مستند في نتيجته. |
| `rank_fields` | للمستندات من نوع الكائن، الحقول التي يُرتَّب على أساسها. |
| `max_chunks_per_doc`، `max_tokens_per_doc` | حدود للمستندات الطويلة، لدى المزوّدين الذين يدعمونها. |

## الاستجابة

تتضمن `RerankResponse` الحقل `results`، ولكل نتيجة `index` المستند في قائمتك، و`relevance_score` الخاص به، و`document` عند تعيين `return_documents`، إضافة إلى `usage`.


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