Felo API PlatformFelo API Platform
Tüm Tavily endpoint'leri
v0.2.0-beta
OpenAPI 3.1.0

Tavily Araması

Sunucu:https://openapi.felo.ai
İstemci Kitaplıkları

Tavily Araması

​

Web'de arama yapar ve başlıklar, URL'ler ve içerik parçacıkları içeren sıralanmış sonuçlar döndürür. query zorunludur. Sonuç sayısını kontrol etmek için max_results, arama modunu seçmek için search_depth kullanın. Ek answer, images ve ham içerik yalnızca istendiğinde döndürülür. Kaynak kullanım bilgilerini almak için include_usage değerini ayarlayın; usage.credits bir Felo ücreti değildir.

Fiyatlandırma referansı

  • Ölçümlendirme: ölçümlendirilen yanıt birimleri.
  • Referans istek tahmini: USD 0.016.
  • Birim maliyet esası: USD 0.008.
  • Kaynak birimi: tavily_credit.
  • Referans müşteri çarpanı: 1.0. Kesinleşmiş müşteri tutarına yeniden uygulamayın.
  • Maliyet esasları, sıfır olduğunda dahi nihai müşteri fiyatını belirlemez.

Yalnızca referans üst verisidir; hesap teklifi, garantili fiyat veya harcama üst sınırı değildir. Kaynak kredileri Felo kredisi değildir. Nihai ücretler Felo faturalandırma kayıtlarını izler.

Gövde
gerekli
application/json
  • query
    Tür: string
    gerekli

    Tavily ile yürütülecek arama sorgusu.

  • auto_parameters
    Tür: boolean

    Arama parametrelerini sorgu içeriğine göre otomatik olarak yapılandırın.

  • chunks_per_source
    Tür: integer
    min:  
    1
    maks:  
    3

    Kaynak başına döndürülen maksimum ilgili parça sayısı.

  • country
    Tür: string enum

    Belirli bir ülkeden gelen arama sonuçlarını öne çıkarın. Yalnızca topic general olduğunda kullanılabilir.

    değerler
    • afghanistan
    • albania
    • algeria
    • andorra
    • angola
  • end_date
    Tür: string Biçim: date

    Belirtilen bitiş tarihinden önceki sonuçları döndürün.

  • exclude_domains
    Tür: array string[] …150

    Arama sonuçlarından özellikle hariç tutulacak alan adları listesi.

  • include_answer

    LLM tarafından oluşturulan bir yanıt ekleyin. true varsayılan yanıt modunu kullanır; basic veya advanced yanıt oluşturma modunu seçer.

    • Tür: boolean

      LLM tarafından oluşturulan bir yanıt ekleyin. true varsayılan yanıt modunu kullanır; basic veya advanced yanıt oluşturma modunu seçer.

  • include_domains
    Tür: array string[] …300

    Arama sonuçlarına özellikle dahil edilecek alan adları listesi.

  • include_favicon
    Tür: boolean

    Her sonuç için favicon URL'sini ekleyin.

  • include_image_descriptions
    Tür: boolean

    include_images true olduğunda her görsel için açıklayıcı metin ekleyin.

  • include_images
    Tür: boolean

    Görsel araması yapın ve sonuçları dahil edin.

  • include_raw_content

    Her arama sonucu için temizlenmiş ve ayrıştırılmış içerik ekleyin. true veya markdown markdown döndürür; text düz metin döndürür ve gecikmeyi artırabilir.

    • Tür: boolean

      Her arama sonucu için temizlenmiş ve ayrıştırılmış içerik ekleyin. true veya markdown markdown döndürür; text düz metin döndürür ve gecikmeyi artırabilir.

  • include_usage
    Tür: boolean

    Yanıta kaynak kullanım bilgilerini dahil edin. Bu, Felo faturalandırma bilgisi değildir.

  • max_results
    Tür: integer
    min:  
    0
    maks:  
    20

    Döndürülecek maksimum arama sonucu sayısı.

  • Tür: boolean

    Yetişkinlere yönelik veya güvenli olmayan içerikleri arama sonuçlarından filtreleyin. Yalnızca Enterprise; search_depth fast veya ultra-fast olduğunda desteklenmez.

  • search_depth
    Tür: string enum

    Gecikme ile alaka düzeyi arasındaki dengeyi kontrol eder. advanced, daha yüksek gecikme ve maliyetle en yüksek alaka düzeyini sunar; basic dengelidir; fast ve ultra-fast daha düşük gecikme için optimize eder.

    değerler
    • advanced
    • basic
    • fast
    • ultra-fast
  • start_date
    Tür: string Biçim: date

    Belirtilen başlangıç tarihinden sonraki sonuçları döndürün.

  • time_range
    Tür: string enum

    Sonuçları yayın tarihine göre filtrelemek için zaman aralığı.

    değerler
    • day
    • week
    • month
    • year
    • d
    • w
    • m
    • y
  • topic
    Tür: string enum

    Aramanın kategorisi.

    değerler
    • general
    • news
    • finance
Yanıtlar
  • 200
    Tür: object

    Arama sonuçları başarıyla döndürüldü.

    • answer
      Tür: string | null

      Kısa, LLM tarafından oluşturulan yanıt. include_answer false olduğunda veya yanıt oluşturulmadığında null olarak bulunur.

    • images
      Tür: array object[]
      • description
        Tür: string

        Görsel açıklaması.

      • url
        Tür: string

        Görsel URL'si.

    • query
      Tür: string

      Yürütülen arama sorgusu.

    • request_id
      Tür: string

      Benzersiz istek tanımlayıcısı.

    • response_time
      Tür: number Biçim: float

      İsteğin tamamlanmasının aldığı süre (saniye).

    • results
      Tür: array object[]
      • content
        Tür: string

        Arama sonucunun içerik parçası.

      • favicon
        Tür: string | null

        Arama sonucunun favicon URL'si.

      • raw_content
        Tür: string | null

        Temizlenmiş ve ayrıştırılmış kaynak içeriği. include_raw_content istenmediğinde veya ham içerik mevcut olmadığında null.

      • score
        Tür: number Biçim: float

        Arama sonucunun alaka puanı.

      • title
        Tür: string

        Arama sonucunun başlığı.

      • url
        Tür: string

        Arama sonucunun URL'si.

    • usage
      Tür: object
      • credits
        Tür: integer

        Bu istek tarafından tüketilen kaynak birimleri; USD veya Felo kredisi değil.

    application/json
  • 400

    İstek işlenemedi. İstek parametrelerini kontrol edin.

  • 401

    Geçerli bir Felo API anahtarı gerekir.

  • 402

    Faturalandırma koşulu karşılanmadığı için istek devam edemiyor.

  • 403

    Hesabın bu işlemi gerçekleştirme izni yok.

  • 429

    İstek veya harcama sınırına ulaşıldı.

  • 502

    Hizmet isteği tamamlayamadı.

  • 503

    API veya faturalandırma hizmeti geçici olarak kullanılamıyor.

  • 504

    İstek işlenirken hizmet zaman aşımına uğradı.

  • default

    Hata yanıtı; upstream sağlayıcıdan doğrudan aktarılan yanıtlar sağlayıcı biçimlerini kullanabilir

    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