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

جستجوی وب مبتنی بر مدل (OpenAI).

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

جستجوی وب مبتنی بر مدل (OpenAI).

​

با یک مدل OpenAI و جستجوی وب، پاسخی دارای استناد تولید کنید. input را به‌صورت رشته یا آرایه پیام ارائه دهید. مدل، ابزارها و سقف جستجو توسط سرویس مدیریت می‌شوند. پاسخ یک شیء Responses است که output آن شامل موارد web_search_call و پیام‌های دارای استناد URL است. usage مصرف منابع را گزارش می‌کند، نه هزینه Felo را.

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

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

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

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

    پرسش یا دستور شما، با همان قالب input در OpenAI Responses API. آرایه پیام نیز پذیرفته می‌شود.

  • instructions
    نوع: string

    دستورهای سطح‌بالای اختیاری برای هدایت لحن یا قالب پاسخ.

  • max_output_tokens
    نوع: integer

    سقف اختیاری تعداد توکن‌های تولیدشده در پاسخ.

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

    یک شیء استاندارد OpenAI Responses. output[] موارد web_search_call و پیام پاسخ مستند را در هم می‌آمیزد؛ تعداد موارد web_search_call همان تعداد جستجوی صورت‌حساب‌شده است.

    • id
      نوع: string
    • object
      نوع: string
    • output
      نوع: array object[]

      آیتم‌های مرتب: web_search_call (جستجوهای انجام‌شده) و message (پاسخ ارجاع‌شده).

      شیء خالی
    • status
      نوع: string
    • usage
      نوع: object
      • input_tokens
        نوع: integer

        Integer numbers.

      • input_tokens_details
        نوع: object
        • cached_tokens
          نوع: integer

          Integer numbers.

      • output_tokens
        نوع: integer

        Integer numbers.

    application/json
  • 400

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

  • 401

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

  • 402

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

  • 403

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

  • 429

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

  • 502

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

  • 503

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

  • 504

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

  • default

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

    application/json
Request Example for post/v1/beta/openai-websearch/search
curl https://openapi.felo.ai/v1/beta/openai-websearch/search \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "input": "What are the three biggest AI announcements this week? Give one sentence each with sources.",
  "max_output_tokens": 1024
}'
{
  "id": "string",
  "object": "response",
  "status": "completed",
  "output": [
    {}
  ],
  "usage": {
    "input_tokens": 1,
    "output_tokens": 1,
    "input_tokens_details": {
      "cached_tokens": 1
    }
  }
}
Model-grounded web search (OpenAI).