Felo API PlatformFelo API Platform
جميع endpoints الخاصة بـ Tavily
v0.2.0-beta
OpenAPI 3.1.0

Tavily Search

الخادم:https://openapi.felo.ai
مكتبات العملاء

Tavily Search

​

ابحث في الويب وأعد نتائج مرتّبة مع العناوين وعناوين URL ومقتطفات المحتوى. query مطلوب. استخدم max_results للتحكم في عدد النتائج وsearch_depth لاختيار وضع البحث. لا تُعاد answer وimages وraw content الإضافية إلا عند طلبها. اضبط include_usage لتلقي معلومات استخدام الموارد؛ usage.credits ليست رسومًا من Felo.

مرجع التسعير

  • القياس: وحدات الاستجابة المقيسة.
  • تقدير الطلب المرجعي: 0.016 دولار أمريكي.
  • أساس تكلفة الوحدة: 0.008 دولار أمريكي.
  • وحدة المورد: tavily_credit.
  • مضاعف العميل المرجعي: 1.0. لا تُطبّقه مرة أخرى على مبلغ عميل مسوّى.
  • لا تحدد أسس التكلفة السعر النهائي للعميل، بما في ذلك عندما تكون صفرًا.

بيانات وصفية مرجعية فقط، وليست عرض سعر للحساب ولا سعرًا مضمونًا ولا حدًا للإنفاق. أرصدة الموارد ليست أرصدة Felo. تتبع الرسوم النهائية سجلات فوترة Felo.

الجسم
مطلوب
application/json
  • query
    النوع: string
    مطلوب

    استعلام البحث المراد تنفيذه باستخدام Tavily.

  • auto_parameters
    النوع: boolean

    تكوين معاملات البحث تلقائيًا بناءً على محتوى الاستعلام.

  • chunks_per_source
    النوع: integer
    الحد الأدنى:  
    1
    الحد الأقصى:  
    3

    الحد الأقصى لعدد المقاطع ذات الصلة المعادة لكل مصدر.

  • country
    النوع: string تعداد

    تعزيز نتائج البحث من بلد محدد. متاح فقط عندما تكون topic هي general.

    القيم
    • afghanistan
    • albania
    • algeria
    • andorra
    • angola
  • end_date
    النوع: string التنسيق: date

    إرجاع النتائج قبل تاريخ الانتهاء المحدد.

  • exclude_domains
    النوع: array string[] …150

    قائمة النطاقات المراد استبعادها تحديدًا من نتائج البحث.

  • include_answer

    تضمين إجابة مولّدة بواسطة LLM. true تستخدم وضع الإجابة الافتراضي؛ basic أو advanced تحدد وضع توليد الإجابة.

    • النوع: boolean

      تضمين إجابة مولّدة بواسطة LLM. true تستخدم وضع الإجابة الافتراضي؛ basic أو advanced تحدد وضع توليد الإجابة.

  • include_domains
    النوع: array string[] …300

    قائمة النطاقات المراد تضمينها تحديدًا في نتائج البحث.

  • include_favicon
    النوع: boolean

    تضمين عنوان URL لأيقونة الموقع لكل نتيجة.

  • include_image_descriptions
    النوع: boolean

    إضافة نص وصفي لكل صورة عندما تكون include_images هي true.

  • include_images
    النوع: boolean

    إجراء بحث عن الصور وتضمين النتائج.

  • include_raw_content

    تضمين محتوى منظّف ومُحلَّل لكل نتيجة بحث. true أو markdown يعيدان markdown؛ وtext يعيد نصًا عاديًا وقد يزيد زمن الاستجابة.

    • النوع: boolean

      تضمين محتوى منظّف ومُحلَّل لكل نتيجة بحث. true أو markdown يعيدان markdown؛ وtext يعيد نصًا عاديًا وقد يزيد زمن الاستجابة.

  • include_usage
    النوع: boolean

    تضمين معلومات استخدام الموارد في الاستجابة. هذه ليست معلومات فوترة Felo.

  • max_results
    النوع: integer
    الحد الأدنى:  
    0
    الحد الأقصى:  
    20

    الحد الأقصى لعدد نتائج البحث المراد إرجاعها.

  • النوع: boolean

    استبعاد المحتوى للبالغين أو غير الآمن من نتائج البحث. للمؤسسات فقط؛ غير مدعوم عندما تكون search_depth هي fast أو ultra-fast.

  • search_depth
    النوع: string تعداد

    يتحكم في المقايضة بين زمن الاستجابة والصلة. يمنح advanced أعلى صلة بزمن استجابة وتكلفة أعلى؛ وbasic متوازن؛ ويحسّن fast وultra-fast زمن استجابة أقل.

    القيم
    • advanced
    • basic
    • fast
    • ultra-fast
  • start_date
    النوع: string التنسيق: date

    إرجاع النتائج بعد تاريخ البدء المحدد.

  • time_range
    النوع: string تعداد

    النطاق الزمني لتصفية النتائج بناءً على تاريخ النشر.

    القيم
    • day
    • week
    • month
    • year
    • d
    • w
    • m
    • y
  • topic
    النوع: string تعداد

    فئة البحث.

    القيم
    • general
    • news
    • finance
الاستجابات
  • 200
    النوع: object

    أُعيدت نتائج البحث بنجاح.

    • answer
      النوع: string | null

      إجابة قصيرة مولّدة بواسطة LLM. تظهر كـ null عندما تكون include_answer هي false أو لم تُولَّد إجابة.

    • images
      النوع: array object[]
      • description
        النوع: string

        وصف الصورة.

      • url
        النوع: string

        عنوان URL للصورة.

    • query
      النوع: string

      استعلام البحث الذي جرى تنفيذه.

    • request_id
      النوع: string

      معرّف فريد للطلب.

    • response_time
      النوع: number التنسيق: float

      الوقت بالثواني المستغرق لإكمال الطلب.

    • results
      النوع: array object[]
      • content
        النوع: string

        مقتطف محتوى نتيجة البحث.

      • favicon
        النوع: string | null

        عنوان URL لأيقونة الموقع لنتيجة البحث.

      • raw_content
        النوع: string | null

        المحتوى المصدر المنظّف والمُحلَّل. Null إلا إذا طُلب include_raw_content أو لم يتوفر محتوى خام.

      • score
        النوع: number التنسيق: float

        درجة الصلة لنتيجة البحث.

      • title
        النوع: string

        عنوان نتيجة البحث.

      • url
        النوع: string

        عنوان URL لنتيجة البحث.

    • usage
      النوع: object
      • credits
        النوع: integer

        وحدات الموارد التي يستهلكها هذا الطلب، وليست دولارات أمريكية أو أرصدة Felo.

    application/json
  • 400

    تعذّرت معالجة الطلب. تحقق من معاملات الطلب.

  • 401

    مطلوب مفتاح API صالح من Felo.

  • 402

    لا يمكن متابعة الطلب لأن أحد متطلبات الفوترة غير مستوفٍ.

  • 403

    الحساب غير مصرّح له بهذه العملية.

  • 429

    تم بلوغ حد الطلبات أو حد الإنفاق.

  • 502

    تعذّر على الخدمة إكمال الطلب.

  • 503

    خدمة API أو الفوترة غير متاحة مؤقتًا.

  • 504

    انتهت مهلة الخدمة أثناء معالجة الطلب.

  • default

    استجابة خطأ؛ قد تستخدم استجابات المنبع الممرَّرة تنسيقات المزوّد

    application/json
Request Example for post/v1/beta/tavily/search
curl --request POST https://openapi.felo.ai/v1/beta/tavily/search \
  --header "Authorization: Bearer ${FELO_API_KEY:?Set FELO_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{"query": "Python official documentation", "search_depth": "basic", "max_results": 2, "include_usage": true}'
{
  "query": "Python official documentation",
  "answer": null,
  "images": [],
  "results": [
    {
      "title": "Python Documentation",
      "url": "https://docs.python.org/3/",
      "content": "Documentation for the Python programming language.",
      "score": 0.98,
      "raw_content": null
    }
  ],
  "response_time": 1.2,
  "usage": {
    "credits": 1
  },
  "request_id": "example-search-request"
}
Tavily Search