Felo API PlatformFelo API Platform
همه endpointهای Scholar Search
v0.2.0-beta
OpenAPI 3.1.0

توضیح نتایج جستجو

سرور:https://openapi.felo.ai
کتابخانه‌های کلاینت

توضیح نتایج جستجو

​

نتایج جستجوی واکشی‌شده قبلی را توضیح دهید. search_id بازگردانده‌شده توسط جستجوی Scholar را همراه با detail_level و language اختیاری ارائه دهید. response_mode=NON_STREAMING یک JSON با message برمی‌گرداند؛ COMPLETE و INCREMENTAL نوع text/event-stream را برمی‌گردانند که هر رویداد آن شامل توضیح انباشته است. این عملیات یک جستجوی موجود را توضیح می‌دهد و جستجوی دیگری آغاز نمی‌کند.

مرجع قیمت‌گذاری

  • اندازه‌گیری: مبنای هزینه ثابت برای درخواست موفق.
  • برآورد درخواست مرجع: 0.01 دلار آمریکا.
  • ضریب مشتری مرجع: 1.0. آن را دوباره روی مبلغ تسویه‌شده مشتری اعمال نکنید.

فقط فراداده مرجع است، نه نقل‌قول حساب، نه قیمت تضمین‌شده و نه سقف هزینه. اعتبار منابع، اعتبار Felo نیست. هزینه‌های نهایی تابع سوابق صورت‌حساب Felo است.

بدنه
الزامی
application/json
  • search_id
    نوع: string
    الزامی

    شناسه جستجو برای توضیح

  • detail_level
    نوع: string فهرست مقادیر

    سطح جزئیات در توضیح

    مقادیر
    • BRIEF
    • MODERATE
    • DETAILED
  • language
    نوع: string

    کد زبان برای توضیح (مثلاً en، zh، ar)

  • response_mode
    نوع: string فهرست مقادیر

    قالب پاسخ توضیح. COMPLETE و INCREMENTAL رویدادهای ارسال‌شده از سرور را استریم می‌کنند؛ NON_STREAMING پاسخ JSON برمی‌گرداند.

    مقادیر
    • COMPLETE
    • INCREMENTAL
    • NON_STREAMING
پاسخ‌ها
  • 200
    نوع: object · Response8Da310D1D213_ExplainSearchResponse

    پاسخ توضیح موفق. COMPLETE/INCREMENTAL نوع text/event-stream را جریان می‌دهند؛ NON_STREAMING نوع application/json را برمی‌گرداند.

    پاسخ توضیح JSON که هنگام NON_STREAMING بودن response_mode برگردانده می‌شود.

    • message
      نوع: string
      الزامی

      متن توضیح تولیدشده.

  • 400

    درخواست پردازش نشد. پارامترهای درخواست را بررسی کنید.

  • 401

    یک کلید API معتبر Felo لازم است.

  • 402

    درخواست ادامه نمی‌یابد چون یک الزام صورت‌حساب برآورده نشده است.

  • 403

    حساب مجاز به انجام این عملیات نیست.

  • 429

    به سقف درخواست یا هزینه رسیده‌اید.

  • 502

    سرویس نتوانست درخواست را کامل کند.

  • 503

    سرویس API یا صورت‌حساب موقتاً در دسترس نیست.

  • 504

    سرویس هنگام پردازش درخواست به پایان مهلت رسید.

  • default

    پاسخ خطا؛ پاسخ‌های عبوری بالادست ممکن است از قالب‌های ارائه‌دهنده استفاده کنند

    application/json
Request Example for post/v1/beta/scholar/search/explain
curl https://openapi.felo.ai/v1/beta/scholar/search/explain \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "search_id": "",
  "response_mode": "NON_STREAMING",
  "language": "ar",
  "detail_level": "MODERATE"
}'
{
  "message": "string"
}
Explain search results