Felo API PlatformFelo API Platform
全部 Tavily 端点
v0.2.0-beta
OpenAPI 3.1.0

Tavily Search

服务器:https://openapi.felo.ai
客户端库

Tavily Search

​

搜索网络并返回带标题、URL 和内容摘要的排序结果。query 为必填项。使用 max_results 控制结果数量,使用 search_depth 选择搜索模式。附加的 answer、images 和原始内容仅在请求时返回。设置 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 枚举

    提升来自特定国家的搜索结果。仅在 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

    为每条结果包含 favicon URL。

  • 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 枚举

    控制延迟与相关性的取舍。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 生成答案。include_answer 为 false 或未生成答案时为 null。

    • 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

        搜索结果的 Favicon URL。

      • raw_content
        类型: string | null

        清洗并解析后的来源内容。除非请求 include_raw_content,否则为 null;没有可用的原始内容时同样为 null。

      • score
        类型: number 格式: float

        搜索结果的相关性得分。

      • title
        类型: string

        搜索结果的标题。

      • url
        类型: string

        搜索结果的 URL。

    • usage
      类型: object
      • credits
        类型: integer

        此请求消耗的资源单位,不是美元或 Felo 额度。

    application/json
  • 400

    无法处理该请求。请检查请求参数。

  • 401

    需要有效的 Felo API 密钥。

  • 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

需要帮助?