Felo API PlatformFelo API Platform
Wszystkie endpointy Tavily
v0.2.0-beta
OpenAPI 3.1.0

Wyszukiwanie Tavily

Felo API Support
MIT
Serwer:https://openapi.felo.ai
Biblioteki klienckie
Shell Curl

Wyszukiwanie Tavily

​

Przeszukuje sieć i zwraca uszeregowane wyniki z tytułami, adresami URL i fragmentami treści. query jest wymagane. Użyj max_results, aby kontrolować liczbę wyników, a search_depth, aby wybrać tryb wyszukiwania. Dodatkowe answer, images i surowa treść są zwracane tylko na żądanie. Ustaw include_usage, aby otrzymać informacje o zużyciu zasobów; usage.credits nie jest opłatą Felo.

Cennik referencyjny

  • Rozliczanie: naliczone jednostki odpowiedzi.
  • Szacunek referencyjny dla żądania: USD 0.016.
  • Podstawa kosztu jednostkowego: USD 0.008.
  • Jednostka zasobu: tavily_credit.
  • Referencyjny mnożnik klienta: 1.0. Nie stosuj go ponownie do rozliczonej kwoty klienta.
  • Podstawy kosztu nie ustalają ostatecznej ceny dla klienta, również gdy wynoszą zero.

Wyłącznie metadane referencyjne, a nie wycena konta, gwarantowana cena lub limit wydatków. Kredyty zasobów nie są kredytami Felo. Ostateczne obciążenia są zgodne z zapisami rozliczeniowymi Felo.

Treść
wymagane
application/json
  • query
    Typ: string
    wymagane

    Zapytanie wyszukiwania do wykonania w Tavily.

  • auto_parameters
    Typ: boolean

    Automatycznie konfiguruj parametry wyszukiwania na podstawie treści zapytania.

  • chunks_per_source
    Typ: integer
    min.:  
    1
    maks.:  
    3

    Maksymalna liczba odpowiednich fragmentów zwracanych na źródło.

  • country
    Typ: string enum

    Wzmocnij wyniki wyszukiwania z określonego kraju. Dostępne tylko wtedy, gdy topic ma wartość general.

    wartości
    • afghanistan
    • albania
    • algeria
    • andorra
    • angola
  • end_date
    Typ: string Format: date

    Zwróć wyniki sprzed podanej daty końcowej.

  • exclude_domains
    Typ: array string[] …150

    Lista domen, które mają być wyraźnie wykluczone z wyników wyszukiwania.

  • include_answer

    Uwzględnij odpowiedź wygenerowaną przez LLM. true używa domyślnego trybu odpowiedzi; basic lub advanced wybiera tryb generowania odpowiedzi.

    • Typ: boolean

      Uwzględnij odpowiedź wygenerowaną przez LLM. true używa domyślnego trybu odpowiedzi; basic lub advanced wybiera tryb generowania odpowiedzi.

  • include_domains
    Typ: array string[] …300

    Lista domen, które mają być wyraźnie uwzględnione w wynikach wyszukiwania.

  • include_favicon
    Typ: boolean

    Uwzględnij adres URL favikony dla każdego wyniku.

  • include_image_descriptions
    Typ: boolean

    Dodaj opisowy tekst do każdego obrazu, gdy include_images ma wartość true.

  • include_images
    Typ: boolean

    Wykonaj wyszukiwanie obrazów i uwzględnij wyniki.

  • include_raw_content

    Uwzględnij oczyszczoną i przetworzoną treść dla każdego wyniku wyszukiwania. true lub markdown zwraca markdown; text zwraca zwykły tekst i może zwiększyć opóźnienie.

    • Typ: boolean

      Uwzględnij oczyszczoną i przetworzoną treść dla każdego wyniku wyszukiwania. true lub markdown zwraca markdown; text zwraca zwykły tekst i może zwiększyć opóźnienie.

  • include_usage
    Typ: boolean

    Uwzględnij informacje o zużyciu zasobów w odpowiedzi. To nie są informacje rozliczeniowe Felo.

  • max_results
    Typ: integer
    min.:  
    0
    maks.:  
    20

    Maksymalna liczba wyników wyszukiwania do zwrócenia.

  • Typ: boolean

    Odfiltruj treści dla dorosłych lub niebezpieczne z wyników wyszukiwania. Tylko w wersji Enterprise; nieobsługiwane, gdy search_depth ma wartość fast lub ultra-fast.

  • search_depth
    Typ: string enum

    Kontroluje kompromis między opóźnieniem a trafnością. advanced zapewnia najwyższą trafność przy większym opóźnieniu i koszcie; basic jest zrównoważony; fast i ultra-fast optymalizują pod kątem niższego opóźnienia.

    wartości
    • advanced
    • basic
    • fast
    • ultra-fast
  • start_date
    Typ: string Format: date

    Zwróć wyniki po podanej dacie początkowej.

  • time_range
    Typ: string enum

    Zakres czasu do filtrowania wyników według daty publikacji.

    wartości
    • day
    • week
    • month
    • year
    • d
    • w
    • m
    • y
  • topic
    Typ: string enum

    Kategoria wyszukiwania.

    wartości
    • general
    • news
    • finance
Odpowiedzi
  • 200
    Typ: object

    Wyniki wyszukiwania zwrócone pomyślnie.

    • answer
      Typ: string | null

      Krótka odpowiedź wygenerowana przez LLM. Przyjmuje wartość null, gdy include_answer ma wartość false lub nie wygenerowano odpowiedzi.

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

        Opis obrazu.

      • url
        Typ: string

        Adres URL obrazu.

    • query
      Typ: string

      Zapytanie wyszukiwania, które zostało wykonane.

    • request_id
      Typ: string

      Unikalny identyfikator żądania.

    • response_time
      Typ: number Format: float

      Czas w sekundach potrzebny na ukończenie żądania.

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

        Fragment treści wyniku wyszukiwania.

      • favicon
        Typ: string | null

        Adres URL favikony wyniku wyszukiwania.

      • raw_content
        Typ: string | null

        Oczyszczona i przetworzona treść źródłowa. Wartość null, chyba że zażądano include_raw_content lub żadna surowa treść nie jest dostępna.

      • score
        Typ: number Format: float

        Ocena trafności wyniku wyszukiwania.

      • title
        Typ: string

        Tytuł wyniku wyszukiwania.

      • url
        Typ: string

        Adres URL wyniku wyszukiwania.

    • usage
      Typ: object
      • credits
        Typ: integer

        Jednostki zasobów zużyte przez to żądanie, a nie USD ani kredyty Felo.

    application/json
  • 400

    Nie można przetworzyć żądania. Sprawdź parametry żądania.

  • 401

    Wymagany jest prawidłowy klucz API Felo.

  • 402

    Nie można kontynuować żądania, ponieważ nie spełniono wymogu rozliczeniowego.

  • 403

    Konto nie ma uprawnień do wykonania tej operacji.

  • 429

    Osiągnięto limit żądań lub wydatków.

  • 502

    Usługa nie mogła ukończyć żądania.

  • 503

    API lub usługa rozliczeniowa jest tymczasowo niedostępna.

  • 504

    Upłynął limit czasu usługi podczas przetwarzania żądania.

  • default

    Odpowiedź błędu; odpowiedzi przekazywane bezpośrednio od dostawcy upstream mogą używać formatów dostawcy

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

Wyniki wyszukiwania zwrócone pomyślnie.

Tavily Search