Web Search
Search public web content with Tavily.
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 计费记录为准。
- 类型: stringquery必填
使用 Tavily 执行的搜索查询。
- 类型: booleanauto
_parameters 根据查询内容自动配置搜索参数。
- 类型: integerchunks
_per _source 最小值:1最大值:3每个来源返回的相关分块最大数。
- 类型: string 枚举country
提升来自特定国家的搜索结果。仅在 topic 为 general 时可用。
值- afghanistan
- albania
- algeria
- andorra
- angola
- 类型: string 格式: dateend
_date 返回指定结束日期之前的结果。
- 类型: array string[] …150exclude
_domains 要从搜索结果中明确排除的域名列表。
- include
_answer 包含 LLM 生成的答案。true 使用默认答案模式;basic 或 advanced 指定答案生成模式。
- 类型: boolean
包含 LLM 生成的答案。true 使用默认答案模式;basic 或 advanced 指定答案生成模式。
- 类型: array string[] …300include
_domains 要明确包含在搜索结果中的域名列表。
- 类型: booleaninclude
_favicon 为每条结果包含 favicon URL。
- 类型: booleaninclude
_image _descriptions include_images 为 true 时,为每张图片添加描述文本。
- 类型: booleaninclude
_images 执行图片搜索并包含结果。
- include
_raw _content 为每条搜索结果包含清洗并解析后的内容。true 或 markdown 返回 Markdown;text 返回纯文本,可能增加延迟。
- 类型: boolean
为每条搜索结果包含清洗并解析后的内容。true 或 markdown 返回 Markdown;text 返回纯文本,可能增加延迟。
- 类型: booleaninclude
_usage 在响应中包含资源用量信息。此信息不是 Felo 计费信息。
- 类型: integermax
_results 最小值:0最大值:20要返回的最大搜索结果数。
- 类型: booleansafe
_search 从搜索结果中过滤成人或不安全内容。仅限企业版;search_depth 为 fast 或 ultra-fast 时不支持。
- 类型: string 枚举search
_depth 控制延迟与相关性的取舍。advanced 相关性最高,但延迟和成本也更高;basic 较为均衡;fast 和 ultra-fast 侧重降低延迟。
值- advanced
- basic
- fast
- ultra
-fast
- 类型: string 格式: datestart
_date 返回指定开始日期之后的结果。
- 类型: string 枚举time
_range 按发布日期筛选结果的时间范围。
值- day
- week
- month
- year
- d
- w
- m
- y
- 类型: string 枚举topic
搜索类别。
值- general
- news
- finance
- 类型: object200
搜索结果已成功返回。
- 类型: string | nullanswer
简短的 LLM 生成答案。include_answer 为 false 或未生成答案时为 null。
- 类型: array object[]images
- description类型: string
图片描述。
- url类型: string
图片 URL。
- 类型: stringquery
实际执行的搜索查询。
- 类型: stringrequest
_id 唯一的请求标识符。
- 类型: number 格式: floatresponse
_time 完成该请求所用的时间(秒)。
- 类型: array object[]results
- content类型: string
搜索结果的内容摘要。
- favicon类型: string | null
搜索结果的 Favicon URL。
- raw类型: string | null
_content 清洗并解析后的来源内容。除非请求 include_raw_content,否则为 null;没有可用的原始内容时同样为 null。
- score类型: number 格式: float
搜索结果的相关性得分。
- title类型: string
搜索结果的标题。
- url类型: string
搜索结果的 URL。
- 类型: objectusage
- credits类型: integer
此请求消耗的资源单位,不是美元或 Felo 额度。
application/json - 400
无法处理该请求。请检查请求参数。
- 401
需要有效的 Felo API 密钥。
- 402
由于未满足计费要求,请求无法继续。
- 403
该账户无权执行此操作。
- 429
已达到请求或支出限额。
- 502
服务无法完成该请求。
- 503
API 或计费服务暂时不可用。
- 504
服务在处理请求时超时。
- default
错误响应;上游透传响应可能采用提供方格式
application/json
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"
}