Felo API PlatformFelo API Platform
כל ה-endpoints של Tavily
v0.2.0-beta
OpenAPI 3.1.0

Tavily Search

Felo API Support
MIT
שרת:https://openapi.felo.ai
ספריות לקוח
Shell Curl

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 enum

    חיזוק תוצאות חיפוש ממדינה ספציפית. זמין רק כאשר 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 של ה-favicon עבור כל תוצאה.

  • 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 enum

    שולט באיזון בין זמן תגובה לרלוונטיות. advanced נותן את הרלוונטיות הגבוהה ביותר עם זמן תגובה ועלות גבוהים יותר; basic מאוזן; fast ו-ultra-fast מייעלים לזמן תגובה נמוך יותר.

    ערכים
    • advanced
    • basic
    • fast
    • ultra-fast
  • start_date
    סוג: string פורמט: date

    החזרת תוצאות אחרי תאריך ההתחלה שצוין.

  • time_range
    סוג: string enum

    טווח זמן לסינון תוצאות לפי תאריך פרסום.

    ערכים
    • day
    • week
    • month
    • year
    • d
    • w
    • m
    • y
  • topic
    סוג: string enum

    קטגוריית החיפוש.

    ערכים
    • 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 של favicon של תוצאת החיפוש.

      • 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