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 USD。
- ユニットコスト基準:USD 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 各結果のファビコン 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 検索結果からアダルトまたは安全でないコンテンツを除外します。Enterprise のみ。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
検索結果のファビコン 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"
}