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

Tavily Extract

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

Web Content

​

Web crawling, URL discovery and page extraction.

Web Content عملیات

Tavily Extract

​

محتوای خوانا را از یک URL یا آرایه‌ای از URLها استخراج می‌کند. متن یا Markdown را با format انتخاب کنید. هم results و هم failed_results را بررسی کنید: ممکن است یک URL ناموفق در پاسخ HTTP موفق گزارش شود. include_usage را تنظیم کنید تا اطلاعات مصرف منابع دریافت کنید؛ usage.credits هزینه Felo نیست.

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

  • اندازه‌گیری: واحدهای پاسخ اندازه‌گیری‌شده.
  • برآورد درخواست مرجع: 0.024 دلار آمریکا.
  • مبنای هزینه واحد: 0.008 دلار آمریکا.
  • واحد منبع: tavily_credit.
  • ضریب مشتری مرجع: 1.0. آن را دوباره روی مبلغ تسویه‌شده مشتری اعمال نکنید.
  • مبناهای هزینه، قیمت نهایی مشتری را تعیین نمی‌کنند، از جمله وقتی صفر باشند.

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

بدنه
الزامی
application/json
  • urls
    الزامی

    URL یا URLهایی برای استخراج محتوا. هم رشته URL واحد و هم آرایه‌ای از رشته‌های URL پذیرفته می‌شود.

    • نوع: string

      URL یا URLهایی برای استخراج محتوا. هم رشته URL واحد و هم آرایه‌ای از رشته‌های URL پذیرفته می‌شود.

  • chunks_per_source
    نوع: integer
    حداقل:  
    1
    حداکثر:  
    5

    حداکثر تعداد قطعه‌های مرتبط برگشتی برای هر منبع. فقط زمانی در دسترس است که query ارائه شود.

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

    عمق فرایند استخراج.

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

    قالب محتوای صفحه وب استخراج‌شده.

    مقادیر
    • markdown
    • text
  • include_favicon
    نوع: boolean

    شامل‌کردن URL فاوآیکون برای هر نتیجه.

  • include_images
    نوع: boolean

    شامل‌کردن فهرستی از تصاویر استخراج‌شده از URLها.

  • include_usage
    نوع: boolean

    شامل‌کردن اطلاعات مصرف منابع در پاسخ. این اطلاعات صورت‌حساب Felo نیست.

  • query
    نوع: string

    قصد کاربر برای رتبه‌بندی مجدد قطعه‌های محتوای استخراج‌شده.

  • timeout
    نوع: number قالب: float
    حداقل:  
    1
    حداکثر:  
    60

    حداکثر زمان به ثانیه برای انتظار استخراج URL. در صورت حذف، مهلت‌های پیش‌فرض به extract_depth بستگی دارند: 10 ثانیه برای basic و 30 ثانیه برای advanced.

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

    نتایج استخراج با موفقیت برگردانده شد.

    • failed_results
      نوع: array string[]

      فهرست URLهایی که پردازش نشدند.

    • request_id
      نوع: string

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

    • response_time
      نوع: number قالب: float

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

    • results
      نوع: array object[]
      • favicon
        نوع: string | null

        URL فاوآیکون محتوای استخراج‌شده.

      • images
        نوع: array string[]

        تصاویر استخراج‌شده از URL وقتی include_images برابر true است.

      • raw_content
        نوع: string

        محتوای خام استخراج‌شده از URL.

      • 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/extract
curl --request POST https://openapi.felo.ai/v1/beta/tavily/extract \
  --header "Authorization: Bearer ${FELO_API_KEY:?Set FELO_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{"urls": ["https://example.com"], "extract_depth": "basic", "format": "text", "include_usage": true}'
{
  "results": [
    {
      "url": "https://example.com",
      "title": "Example Domain",
      "raw_content": "This domain is for use in documentation examples.",
      "images": []
    }
  ],
  "failed_results": [],
  "response_time": 0.5,
  "usage": {
    "credits": 1
  },
  "request_id": "example-extract-request"
}
Tavily Extract