خروجی ساخت‌یافته

رتبه‌بندی مجدد

یک پرسش و فهرستی از متن‌ها بفرستید و متن‌ها را به ترتیب ارتباط با پرسش و همراه با امتیاز پس بگیرید؛ مناسب بعد از جست‌وجوی برداری در RAG.

POST/v1/rerank

جست‌وجوی برداری سریع و تقریبی است. معمولاً چند ده نتیجه‌ی اول را به این مسیر می‌دهید تا دقیق‌تر مرتب شوند و فقط چند نتیجه‌ی بهتر را به مدل بدهید.

نتیجه‌ها از بیشترین relevance_score به کمترین مرتب‌اند و index جای متن در آرایه‌ی documents شماست. top_n پس از مرتب‌سازی فقط چند نتیجه‌ی اول را نگه می‌دارد. به‌طور پیش‌فرض متن هر سند هم در document.text برمی‌گردد؛ با return_documents: false فقط index و امتیاز می‌آید.

شکل پاسخ برای همه‌ی مدل‌ها یکی است. هزینه یا به ازای واحد جست‌وجو حساب می‌شود (برای مدل‌های قیمت‌گذاری‌شده به‌صورت «هر پرسش»، مثلاً هر ۱۰۰ سند یک واحد) یا بر اساس توکن؛ مقدار آن در usage.search_units و برای مدل‌های توکنی usage.total_tokens می‌آید.

نمونه‌ها

curl https://1ai.ir/v1/rerank \
  -H "Authorization: Bearer $ONEAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "cohere/rerank-v4.0-fast",
  "query": "How do I change my password?",
  "documents": [
    "Open Settings and go to the Security section to change your password.",
    "Support is open from 9 to 17.",
    "If you forgot your password, use the recovery option."
  ],
  "top_n": 2
}'
200پاسخ
{
  "id": "rerank-req_example",
  "object": "list",
  "model": "cohere/rerank-v4.0-fast",
  "results": [
    {
      "index": 0,
      "relevance_score": 0.91,
      "document": {
        "text": "Open Settings and go to the Security section to change your password."
      }
    },
    {
      "index": 2,
      "relevance_score": 0.64,
      "document": {
        "text": "If you forgot your password, use the recovery option."
      }
    }
  ],
  "usage": {
    "search_units": 1
  }
}

بدنه‌ی درخواست

  • modelstringالزامی

    شناسه‌ی مدل rerank.

  • querystringالزامی

    پرسش یا جست‌وجوی کاربر، تا ۲۰٬۰۰۰ نویسه.

  • documentsarrayالزامی

    متن‌هایی که باید رتبه بگیرند، از ۱ تا ۱۰۰۰ مورد. هر مورد رشته (تا ۱۰۰٬۰۰۰ نویسه) یا شیء { "text": "…" } است.

  • top_ninteger

    تعداد نتیجه‌ی برگشتی، از ۱ تا ۱۰۰۰. بدون آن همه‌ی اسناد برمی‌گردند.

  • return_documentsbooleanپیش‌فرض: true

    اگر false باشد متن اسناد در پاسخ نمی‌آید.

خطاها

  • invalid_request400

    بدنه معتبر نیست؛ مثلاً documents خالی یا بیشتر از ۱۰۰۰ مورد.

  • model_kind_mismatch400

    مدل از دسته‌ی rerank نیست.

  • insufficient_credits402

    اعتبار برای این درخواست کافی نیست.

  • model_not_found404

    مدل وجود ندارد یا به آن دسترسی ندارید.

صفحه‌های مرتبط