Perplexity API
Generate answers and research reports with web citations.
Perplexity Sonar
با استنادهای وب پاسخی مختصر تولید کنید. model و messages الزامی‌اند؛ برای این نقطه پایانی از مدل sonar استفاده کنید. این قرارداد عمومی پاسخ‌های JSON بدون جریان‌سازی با stream false را پوشش می‌دهد. پاسخ را از choices[].message.content و منابع را از citations و search_results بخوانید. usage مصرف منابع را گزارش می‌کند، نه هزینه اعتباری Felo را.
مرجع قیمت‌گذاری
- اندازه‌گیری: هزینه گزارش‌شده پاسخ.
- برآورد درخواست مرجع: 0.12783 دلار آمریکا.
- ضریب مشتری مرجع: 1.0. آن را دوباره روی مبلغ تسویه‌شده مشتری اعمال نکنید.
فقط فراداده مرجع است، نه نقل‌قول حساب، نه قیمت تضمین‌شده و نه سقف هزینه. اعتبار منابع، اعتبار Felo نیست. هزینه‌های نهایی تابع سوابق صورت‌حساب Felo است.
- نوع: array object[]messagesالزامی
فهرستی از پیام‌ها که گفتگو تا این لحظه را تشکیل می‌دهند.
- contentنوع: stringالزامی
محتوای پیام.
- roleنوع: string فهرست مقادیرالزامی
نقش نویسنده پیام.
مقادیر- system
- user
- assistant
- نوع: string فهرست مقادیرmodelالزامی
مدل Sonar برای استفاده.
مقادیر- sonar
- sonar
-pro - sonar
-reasoning -pro - sonar
-deep -research
- نوع: numberfrequency
_penalty حداقل:0حداکثر:2توکن‌های جدید را بر اساس فراوانی موجودشان در متن تا این لحظه جریمه می‌کند. مقادیر مثبت احتمال تکرار عین همان خط را کاهش می‌دهند.
- نوع: integermax
_tokens حداکثر تعداد توکن‌هایی که در پاسخ تولید می‌شود.
- نوع: numberpresence
_penalty حداقل:-2حداکثر:2توکن‌های جدید را بر اساس اینکه آیا در متن تا این لحظه ظاهر شده‌اند جریمه می‌کند. مقادیر مثبت احتمال صحبت درباره موضوعات جدید را افزایش می‌دهند.
- نوع: booleanreturn
_citations اینکه ارجاع‌ها و نتایج جستجو در پاسخ برگردانده شوند یا نه.
- نوع: string فهرست مقادیرsearch
_context میزان زمینه جستجوی مورد استفاده را کنترل می‌کند. بر هزینه هر درخواست اثر می‌گذارد.
مقادیر- low
- medium
- high
- نوع: array string[]search
_domain _filter محدودکردن جستجو به دامنه‌های مشخص.
- نوع: string فهرست مقادیرsearch
_recency _filter فیلتر نتایج جستجو بر اساس تازگی.
مقادیر- month
- week
- day
- hour
- نوع: booleanstream
اینکه پاسخ با استفاده از رویدادهای ارسال‌شده از سرور استریم شود یا نه.
- نوع: numbertemperatureحداقل:0حداکثر:2
دمای نمونه‌گیری بین 0 و 2. مقادیر پایین‌تر خروجی را متمرکزتر و قطعی‌تر می‌کند.
- نوع: integertop
_k حداقل:0حداکثر:2048تعداد توکن‌هایی که برای فیلتر top-k نگه داشته می‌شود.
- نوع: numbertop
_p حداقل:0حداکثر:1پارامتر نمونه‌گیری هسته‌ای. مدل توکن‌هایی با جرم احتمال top_p را در نظر می‌گیرد.
- نوع: object · ResponseD5E2470Dd28B_ChatCompletionResponse200
پاسخ موفق همراه با پاسخ هوش مصنوعی و استنادها
- نوع: array object[]choices
- finishنوع: string فهرست مقادیر
_reason مقادیر- stop
- length
- indexنوع: integer
Integer numbers.
- messageنوع: object
- contentنوع: string
پاسخ تولیدشده با AI، همراه با ارجاع‌های استنادی درون‌متنی مانند [1][2].
- roleنوع: string
- نوع: array string[]citations
فهرست نشانی‌های URL منبع که در پاسخ به آن‌ها ارجاع شده است.
- نوع: integercreated
مهر زمانی Unix زمان ایجاد تکمیل.
- نوع: stringid
شناسه یکتای تکمیل.
- نوع: stringmodel
مدل استفاده‌شده برای تکمیل.
- نوع: stringobject
- نوع: array object[]search
_results نتایج جستجوی تفصیلی همراه با عنوان‌ها، قطعه‌متن‌ها و نشانی‌های URL.
- dateنوع: string
- snippetنوع: string
- sourceنوع: string
- titleنوع: string
- urlنوع: string
- نوع: objectusage
- completionنوع: integer
_tokens Integer numbers.
- promptنوع: integer
_tokens Integer numbers.
- searchنوع: string
_context _size - totalنوع: integer
_tokens Integer numbers.
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/perplexity/sonar \
--header "Authorization: Bearer ${FELO_API_KEY:?Set FELO_API_KEY}" \
--header 'Content-Type: application/json' \
--data '{"model": "sonar", "messages": [{"role": "user", "content": "What is HTTP caching? Cite the relevant documentation."}], "max_tokens": 512, "stream": false}'
{
"id": "example-sonar-completion",
"model": "sonar",
"object": "chat.completion",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "HTTP caching reuses stored responses when permitted by cache rules. [1]"
},
"finish_reason": "stop"
}
],
"citations": [
"https://www.rfc-editor.org/rfc/rfc9111.html"
],
"search_results": [
{
"title": "HTTP Caching",
"url": "https://www.rfc-editor.org/rfc/rfc9111.html"
}
],
"usage": {
"prompt_tokens": 20,
"completion_tokens": 30,
"total_tokens": 50
}
}