Felo API PlatformFelo API Platform
Все эндпоинты 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 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

    Отфильтровывать контент для взрослых или небезопасный контент из результатов поиска. Только для Enterprise; не поддерживается, когда 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

        Единицы ресурсов, израсходованные этим запросом; не USD и не кредиты Felo.

    application/json
  • 400

    Запрос не удалось обработать. Проверьте параметры запроса.

  • 401

    Требуется действительный API-ключ Felo.

  • 402

    Запрос не может быть выполнен: не выполнено требование биллинга.

  • 403

    Аккаунту не разрешено выполнять эту операцию.

  • 429

    Достигнут лимит запросов или расходов.

  • 502

    Сервис не смог выполнить запрос.

  • 503

    API или сервис биллинга временно недоступны.

  • 504

    Истекло время ожидания обработки запроса.

  • default

    Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

    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

Нужна помощь?