Felo API PlatformFelo API Platform
Усі endpoint 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 і сирий вміст повертаються лише на запит. Установіть include_usage, щоб отримувати відомості про використання ресурсів; usage.credits — це не списання Felo.

Довідкові ціни

  • Тарифікація: тарифіковані одиниці відповіді.
  • Довідкова оцінка запиту: USD 0.016.
  • Базова вартість одиниці: USD 0.008.
  • Одиниця ресурсу: tavily_credit.
  • Довідковий множник для клієнта: 1.0. Не застосовуйте його повторно до вже розрахованої суми клієнта.
  • Базові вартості не визначають остаточну ціну для клієнта, зокрема коли вони дорівнюють нулю.

Лише довідкові метадані, а не котирування для облікового запису, гарантована ціна чи ліміт витрат. Кредити ресурсів — це не кредити Felo. Остаточні списання здійснюються за записами білінгу Felo.

Тіло
обов'язкове
application/json
  • query
    Тип: string
    обов'язкове

    Пошуковий запит для виконання за допомогою Tavily.

  • auto_parameters
    Тип: boolean

    Автоматично налаштовувати параметри пошуку на основі вмісту запиту.

  • chunks_per_source
    Тип: integer
    мін.:  
    1
    макс.:  
    3

    Максимальна кількість релевантних чанків, що повертаються на джерело.

  • country
    Тип: string перелік

    Підвищувати релевантність результатів пошуку з певної країни. Доступно лише коли 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

    Відфільтровувати контент для дорослих або небезпечний контент з результатів пошуку. Лише для Enterprise; не підтримується, коли search_depth має значення fast або ultra-fast.

  • search_depth
    Тип: string перелік

    Керує компромісом між затримкою та релевантністю. advanced дає максимальну релевантність за вищої затримки й вартості; basic — збалансований варіант; fast і ultra-fast оптимізовані для меншої затримки.

    значення
    • advanced
    • basic
    • fast
    • ultra-fast
  • start_date
    Тип: string Формат: date

    Повертати результати після вказаної початкової дати.

  • time_range
    Тип: string перелік

    Часовий діапазон для фільтрації результатів за датою публікації.

    значення
    • day
    • week
    • month
    • year
    • d
    • w
    • m
    • y
  • topic
    Тип: string перелік

    Категорія пошуку.

    значення
    • 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

        Одиниці ресурсів, витрачені цим запитом; не USD і не кредити 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