Felo API PlatformFelo API Platform
Semua endpoint Tavily
v0.2.0-beta
OpenAPI 3.1.0

Tavily Search

Felo API Support
MIT
Pelayan:https://openapi.felo.ai
Pustaka Klien
Shell Curl

Tavily Search

​

Cari di web dan pulangkan hasil berkedudukan dengan tajuk, URL dan coretan kandungan. query diperlukan. Gunakan max_results untuk mengawal bilangan hasil dan search_depth untuk memilih mod carian. answer, images dan kandungan mentah tambahan hanya dipulangkan apabila diminta. Tetapkan include_usage untuk menerima maklumat penggunaan sumber; usage.credits bukan caj Felo.

Rujukan harga

  • Pemeteran: Unit respons dimeterkan.
  • Anggaran rujukan setiap permintaan: USD 0.016.
  • Asas kos unit: USD 0.008.
  • Unit sumber: tavily_credit.
  • Pengganda pelanggan rujukan: 1.0. Jangan gunakan semula pada amaun pelanggan yang telah diselesaikan.
  • Asas kos tidak menentukan harga pelanggan akhir, termasuk apabila sifar.

Metadata rujukan sahaja, bukan sebut harga akaun, harga terjamin atau had perbelanjaan. Kredit sumber bukan kredit Felo. Caj akhir mengikut rekod pengebilan Felo.

Badan
wajib
application/json
  • query
    Jenis: string
    wajib

    Pertanyaan carian untuk dilaksanakan dengan Tavily.

  • auto_parameters
    Jenis: boolean

    Konfigurasikan parameter carian secara automatik berdasarkan kandungan pertanyaan.

  • chunks_per_source
    Jenis: integer
    min:  
    1
    maks:  
    3

    Bilangan maksimum ketulan relevan yang dipulangkan setiap sumber.

  • country
    Jenis: string enum

    Tingkatkan hasil carian daripada negara tertentu. Hanya tersedia apabila topic ialah general.

    nilai
    • afghanistan
    • albania
    • algeria
    • andorra
    • angola
  • end_date
    Jenis: string Format: date

    Pulangkan hasil sebelum tarikh tamat yang ditentukan.

  • exclude_domains
    Jenis: array string[] …150

    Senarai domain yang secara khusus dikecualikan daripada hasil carian.

  • include_answer

    Sertakan jawapan yang dijana LLM. true menggunakan mod jawapan lalai; basic atau advanced memilih mod penjanaan jawapan.

    • Jenis: boolean

      Sertakan jawapan yang dijana LLM. true menggunakan mod jawapan lalai; basic atau advanced memilih mod penjanaan jawapan.

  • include_domains
    Jenis: array string[] …300

    Senarai domain yang secara khusus disertakan dalam hasil carian.

  • include_favicon
    Jenis: boolean

    Sertakan URL favicon untuk setiap hasil.

  • include_image_descriptions
    Jenis: boolean

    Tambah teks penerangan untuk setiap imej apabila include_images ialah true.

  • include_images
    Jenis: boolean

    Lakukan carian imej dan sertakan hasilnya.

  • include_raw_content

    Sertakan kandungan yang dibersihkan dan dihuraikan untuk setiap hasil carian. true atau markdown memulangkan markdown; text memulangkan teks biasa dan mungkin meningkatkan kependaman.

    • Jenis: boolean

      Sertakan kandungan yang dibersihkan dan dihuraikan untuk setiap hasil carian. true atau markdown memulangkan markdown; text memulangkan teks biasa dan mungkin meningkatkan kependaman.

  • include_usage
    Jenis: boolean

    Sertakan maklumat penggunaan sumber dalam respons. Ini bukan maklumat pengebilan Felo.

  • max_results
    Jenis: integer
    min:  
    0
    maks:  
    20

    Bilangan maksimum hasil carian untuk dipulangkan.

  • Jenis: boolean

    Tapis kandungan dewasa atau tidak selamat daripada hasil carian. Hanya Enterprise; tidak disokong apabila search_depth ialah fast atau ultra-fast.

  • search_depth
    Jenis: string enum

    Mengawal tradeoff kependaman vs kerelevanan. advanced memberikan kerelevanan tertinggi dengan kependaman dan kos lebih tinggi; basic seimbang; fast dan ultra-fast mengoptimumkan kependaman lebih rendah.

    nilai
    • advanced
    • basic
    • fast
    • ultra-fast
  • start_date
    Jenis: string Format: date

    Pulangkan hasil selepas tarikh mula yang ditentukan.

  • time_range
    Jenis: string enum

    Julat masa untuk menapis hasil berdasarkan tarikh terbit.

    nilai
    • day
    • week
    • month
    • year
    • d
    • w
    • m
    • y
  • topic
    Jenis: string enum

    Kategori carian.

    nilai
    • general
    • news
    • finance
Respons
  • 200
    Jenis: object

    Hasil carian berjaya dikembalikan.

    • answer
      Jenis: string | null

      Jawapan ringkas yang dijana LLM. Dipaparkan sebagai null apabila include_answer ialah false atau tiada jawapan dijana.

    • images
      Jenis: array object[]
      • description
        Jenis: string

        Penerangan imej.

      • url
        Jenis: string

        URL imej.

    • query
      Jenis: string

      Pertanyaan carian yang dilaksanakan.

    • request_id
      Jenis: string

      Pengecam permintaan unik.

    • response_time
      Jenis: number Format: float

      Masa dalam saat yang diambil untuk menyelesaikan permintaan.

    • results
      Jenis: array object[]
      • content
        Jenis: string

        Petikan kandungan hasil carian.

      • favicon
        Jenis: string | null

        URL favicon hasil carian.

      • raw_content
        Jenis: string | null

        Kandungan sumber yang dibersihkan dan dihuraikan. Null kecuali include_raw_content diminta atau tiada kandungan mentah tersedia.

      • score
        Jenis: number Format: float

        Skor kerelevanan hasil carian.

      • title
        Jenis: string

        Tajuk hasil carian.

      • url
        Jenis: string

        URL hasil carian.

    • usage
      Jenis: object
      • credits
        Jenis: integer

        Unit sumber yang digunakan oleh permintaan ini, bukan USD atau kredit Felo.

    application/json
  • 400

    Permintaan tidak dapat diproses. Semak parameter permintaan.

  • 401

    Kunci API Felo yang sah diperlukan.

  • 402

    Permintaan tidak dapat diteruskan kerana keperluan pengebilan tidak dipenuhi.

  • 403

    Akaun tidak dibenarkan melakukan operasi ini.

  • 429

    Had permintaan atau had perbelanjaan telah dicapai.

  • 502

    Perkhidmatan tidak dapat menyelesaikan permintaan.

  • 503

    API atau perkhidmatan pengebilan tidak tersedia buat sementara waktu.

  • 504

    Perkhidmatan tamat masa semasa memproses permintaan.

  • default

    Respons ralat; respons passthrough huluan mungkin menggunakan format penyedia

    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"
}

Hasil carian berjaya dikembalikan.

Tavily Search