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

جستجوی هوشمند ترکیب‌کننده نتایج وب و دانشگاهی

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

جستجوی هوشمند ترکیب‌کننده نتایج وب و دانشگاهی

​

وب و منابع دانشگاهی را با هم جستجو کنید، برای پرسش‌هایی که هر دو را در بر می‌گیرند. ⚠️ پارامترها در query string قرار می‌گیرند: query (الزامی)، max_num_results، as_ylo/as_yhi. یک id جستجو و results[] برمی‌گرداند؛ شکل هر ورودی بسته به منبع متفاوت است — هر نتیجه title، link و snippet دارد و نتایج دانشگاهی علاوه بر آن authors و number_of_citations را حمل می‌کنند، پس این دو را اختیاری بدانید و وجودشان را فرض نکنید. وقتی از پیش نمی‌دانید کدام نوع منبع پاسخ می‌دهد از آن استفاده کنید. وقتی می‌دانید، post_scholar_search_web یا post_scholar_search_scholar قابل پیش‌بینی‌تر است. id را برای post_scholar_search_explain نگه دارید.

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

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

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

پارامترهای پرس‌وجو
  • as_yhi
    نوع: integer | null
    حداقل:  
    1900
    حداکثر:  
    2030

    کران بالای سال انتشار

  • as_ylo
    نوع: integer | null
    حداقل:  
    1900
    حداکثر:  
    2030

    کران پایین سال انتشار

  • max_num_results
    نوع: integer
    حداقل:  
    1
    حداکثر:  
    100

    حداکثر تعداد نتایج جستجو برای برگرداندن، تا 100

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

    کوئری جستجو برای منابع علمی

پاسخ‌ها
  • 200
    نوع: object · Response8Da310D1D213_SmartSearchResponse

    پاسخ جستجوی موفق

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

      شناسه یکتای درخواست جست‌وجو

    • results
      نوع: array object[] · Response8Da310D1D213_SmartResult[]
      الزامی

      فهرست نتایج جستجوی هوشمند که محتوای وب و دانشگاهی را ترکیب می‌کند

      • link
        نوع: string قالب: uri
        الزامی

        نشانی URL برای دسترسی به محتوا

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

        خلاصه کوتاه یا چکیده

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

        عنوان نتیجه

      • authors
        نوع: array string[]

        فهرست نویسندگان (برای محتوای دانشگاهی)

      • number_of_citations
        نوع: integer
        حداقل:  
        0

        تعداد استنادها (برای محتوای دانشگاهی)

      • relevance_score
        نوع: number
        حداقل:  
        0
        حداکثر:  
        1

        امتیاز مرتبط بودن نتیجه

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

        نوع نتیجه

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

      نوع نتایج جستجوی شامل‌شده

      مقادیر
      • web
      • academic
      • hybrid
    application/json
  • 400

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

  • 401

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

  • 402

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

  • 403

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

  • 429

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

  • 502

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

  • 503

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

  • 504

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

  • default

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

    application/json
Request Example for post/v1/beta/scholar/search/mixed
curl 'https://openapi.felo.ai/v1/beta/scholar/search/mixed?query=machine%20learning' \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "string",
  "results": [
    {
      "title": "string",
      "link": "https://example.com",
      "snippet": "string",
      "authors": [
        "string"
      ],
      "number_of_citations": 0,
      "type": "web",
      "relevance_score": 0
    }
  ],
  "search_type": "web"
}
Smart search combining web and academic results