Web Search
Search public web content with Tavily.
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 است.
- نوع: stringqueryالزامی
کوئری جستجو برای اجرا با Tavily.
- نوع: booleanauto
_parameters پیکربندی خودکار پارامترهای جستجو بر اساس محتوای کوئری.
- نوع: integerchunks
_per _source حداقل:1حداکثر:3حداکثر تعداد قطعه‌های مرتبط برگشتی برای هر منبع.
- نوع: string فهرست مقادیرcountry
تقویت نتایج جستجو از یک کشور مشخص. فقط زمانی در دسترس است که topic برابر general باشد.
مقادیر- afghanistan
- albania
- algeria
- andorra
- angola
- نوع: string قالب: dateend
_date برگرداندن نتایج پیش از تاریخ پایان مشخص‌شده.
- نوع: array string[] …150exclude
_domains فهرست دامنه‌هایی که به‌طور مشخص از نتایج جستجو حذف شوند.
- include
_answer شامل‌کردن پاسخ تولیدشده با LLM. true از حالت پاسخ پیش‌فرض استفاده می‌کند؛ basic یا advanced حالت تولید پاسخ را انتخاب می‌کند.
- نوع: boolean
شامل‌کردن پاسخ تولیدشده با LLM. true از حالت پاسخ پیش‌فرض استفاده می‌کند؛ basic یا advanced حالت تولید پاسخ را انتخاب می‌کند.
- نوع: array string[] …300include
_domains فهرست دامنه‌هایی که به‌طور مشخص در نتایج جستجو گنجانده شوند.
- نوع: booleaninclude
_favicon شامل‌کردن URL فاوآیکون برای هر نتیجه.
- نوع: booleaninclude
_image _descriptions افزودن متن توصیفی برای هر تصویر وقتی include_images برابر true است.
- نوع: booleaninclude
_images انجام جستجوی تصویر و شامل‌کردن نتایج.
- include
_raw _content شامل‌کردن محتوای پاک‌سازی‌شده و تجزیه‌شده برای هر نتیجه جستجو. true یا markdown قالب markdown را برمی‌گردانند؛ text متن ساده را برمی‌گرداند و ممکن است تأخیر را افزایش دهد.
- نوع: boolean
شامل‌کردن محتوای پاک‌سازی‌شده و تجزیه‌شده برای هر نتیجه جستجو. true یا markdown قالب markdown را برمی‌گردانند؛ text متن ساده را برمی‌گرداند و ممکن است تأخیر را افزایش دهد.
- نوع: booleaninclude
_usage شامل‌کردن اطلاعات مصرف منابع در پاسخ. این اطلاعات صورت‌حساب Felo نیست.
- نوع: integermax
_results حداقل:0حداکثر:20حداکثر تعداد نتایج جستجو برای برگرداندن.
- نوع: booleansafe
_search فیلتر محتوای بزرگسالان یا ناایمن از نتایج جستجو. فقط برای سازمان‌ها؛ وقتی search_depth برابر fast یا ultra-fast است پشتیبانی نمی‌شود.
- نوع: string فهرست مقادیرsearch
_depth توازن بین تأخیر و ارتباط را کنترل می‌کند. advanced بالاترین ارتباط را با تأخیر و هزینه بیشتر می‌دهد؛ basic متوازن است؛ fast و ultra-fast تأخیر کمتر را بهینه می‌کنند.
مقادیر- advanced
- basic
- fast
- ultra
-fast
- نوع: string قالب: datestart
_date برگرداندن نتایج پس از تاریخ شروع مشخص‌شده.
- نوع: string فهرست مقادیرtime
_range بازه زمانی برای فیلتر نتایج بر اساس تاریخ انتشار.
مقادیر- day
- week
- month
- year
- d
- w
- m
- y
- نوع: string فهرست مقادیرtopic
دسته‌بندی جستجو.
مقادیر- general
- news
- finance
- نوع: object200
نتایج جستجو با موفقیت برگردانده شد.
- نوع: string | nullanswer
پاسخ کوتاه تولیدشده با LLM. وقتی include_answer برابر false است یا پاسخی تولید نشده، به‌صورت null ظاهر می‌شود.
- نوع: array object[]images
- descriptionنوع: string
توضیحات تصویر.
- urlنوع: string
URL تصویر.
- نوع: stringquery
کوئری جستجویی که اجرا شد.
- نوع: stringrequest
_id شناسه یکتای درخواست.
- نوع: number قالب: floatresponse
_time زمان به ثانیه که تکمیل درخواست طول کشید.
- نوع: array object[]results
- contentنوع: string
بریده محتوای نتیجه جستجو.
- faviconنوع: string | null
URL فاوآیکون نتیجه جستجو.
- rawنوع: string | null
_content محتوای منبع پاک‌سازی‌شده و تجزیه‌شده. Null مگر اینکه include_raw_content درخواست شود یا محتوای خامی موجود نباشد.
- scoreنوع: number قالب: float
امتیاز ارتباط نتیجه جستجو.
- titleنوع: string
عنوان نتیجه جستجو.
- urlنوع: string
URL نتیجه جستجو.
- نوع: objectusage
- creditsنوع: integer
واحدهای منابع مصرف‌شده توسط این درخواست، نه دلار آمریکایی یا اعتبارهای Felo.
application/json - 400
درخواست پردازش نشد. پارامترهای درخواست را بررسی کنید.
- 401
یک کلید API معتبر Felo لازم است.
- 402
درخواست ادامه نمی‌یابد چون یک الزام صورت‌حساب برآورده نشده است.
- 403
حساب مجاز به انجام این عملیات نیست.
- 429
به سقف درخواست یا هزینه رسیده‌اید.
- 502
سرویس نتوانست درخواست را کامل کند.
- 503
سرویس API یا صورت‌حساب موقتاً در دسترس نیست.
- 504
سرویس هنگام پردازش درخواست به پایان مهلت رسید.
- default
پاسخ خطا؛ پاسخ‌های عبوری بالادست ممکن است از قالب‌های ارائه‌دهنده استفاده کنند
application/json
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"
}