Felo API PlatformFelo API Platform
Všechny endpointy Tavily
v0.2.0-beta
OpenAPI 3.1.0

Vyhledávání Tavily

Server:https://openapi.felo.ai
Klientské knihovny

Vyhledávání Tavily

​

Prohledává web a vrací seřazené výsledky s názvy, URL a úryvky obsahu. query je povinné. Pomocí max_results ovládejte počet výsledků a pomocí search_depth vyberte režim vyhledávání. Další answer, images a surový obsah se vracejí pouze na vyžádání. Nastavte include_usage, abyste obdrželi informace o využití prostředků; usage.credits není poplatek Felo.

Cenová reference

  • Účtování: měřené jednotky odpovědi.
  • Referenční odhad požadavku: USD 0.016.
  • Základ jednotkových nákladů: USD 0.008.
  • Jednotka prostředku: tavily_credit.
  • Referenční multiplikátor zákazníka: 1.0. Neaplikujte jej znovu na zúčtovanou částku zákazníka.
  • Nákladové základny neurčují konečnou cenu pro zákazníka, a to ani když jsou nulové.

Pouze referenční metadata, nikoli nabídka pro účet, garantovaná cena či limit utrácení. Kredity prostředků nejsou kredity Felo. Konečné účtování se řídí fakturačními záznamy Felo.

Tělo
povinné
application/json
  • query
    Typ: string
    povinné

    Vyhledávací dotaz, který se má provést v Tavily.

  • auto_parameters
    Typ: boolean

    Automaticky konfigurovat parametry vyhledávání na základě obsahu dotazu.

  • chunks_per_source
    Typ: integer
    min:  
    1
    max:  
    3

    Maximální počet relevantních částí vrácených na zdroj.

  • country
    Typ: string enum

    Zvýhodnit výsledky vyhledávání z konkrétní země. Dostupné pouze tehdy, když je topic general.

    hodnoty
    • afghanistan
    • albania
    • algeria
    • andorra
    • angola
  • end_date
    Typ: string Formát: date

    Vrátit výsledky před zadaným koncovým datem.

  • exclude_domains
    Typ: array string[] …150

    Seznam domén, které se mají z výsledků vyhledávání výslovně vyloučit.

  • include_answer

    Zahrnout odpověď vygenerovanou LLM. true používá výchozí režim odpovědi; basic nebo advanced volí režim generování odpovědi.

    • Typ: boolean

      Zahrnout odpověď vygenerovanou LLM. true používá výchozí režim odpovědi; basic nebo advanced volí režim generování odpovědi.

  • include_domains
    Typ: array string[] …300

    Seznam domén, které se mají do výsledků vyhledávání výslovně zahrnout.

  • include_favicon
    Typ: boolean

    Zahrnout adresu URL favikony pro každý výsledek.

  • include_image_descriptions
    Typ: boolean

    Přidat popisný text ke každému obrázku, když je include_images true.

  • include_images
    Typ: boolean

    Provést vyhledávání obrázků a zahrnout výsledky.

  • include_raw_content

    Zahrnout očištěný a parsovaný obsah pro každý výsledek vyhledávání. true nebo markdown vrací markdown; text vrací prostý text a může zvýšit latenci.

    • Typ: boolean

      Zahrnout očištěný a parsovaný obsah pro každý výsledek vyhledávání. true nebo markdown vrací markdown; text vrací prostý text a může zvýšit latenci.

  • include_usage
    Typ: boolean

    Zahrnout do odpovědi informace o spotřebě prostředků. Nejde o fakturační informace Felo.

  • max_results
    Typ: integer
    min:  
    0
    max:  
    20

    Maximální počet výsledků vyhledávání, které se mají vrátit.

  • Typ: boolean

    Odfiltrovat obsah pro dospělé nebo nebezpečný obsah z výsledků vyhledávání. Pouze Enterprise; není podporováno, když je search_depth fast nebo ultra-fast.

  • search_depth
    Typ: string enum

    Řídí kompromis mezi latencí a relevancí. advanced poskytuje nejvyšší relevanci s vyšší latencí a náklady; basic je vyvážený; fast a ultra-fast optimalizují nižší latenci.

    hodnoty
    • advanced
    • basic
    • fast
    • ultra-fast
  • start_date
    Typ: string Formát: date

    Vrátit výsledky po zadaném počátečním datu.

  • time_range
    Typ: string enum

    Časový rozsah pro filtrování výsledků podle data publikace.

    hodnoty
    • day
    • week
    • month
    • year
    • d
    • w
    • m
    • y
  • topic
    Typ: string enum

    Kategorie vyhledávání.

    hodnoty
    • general
    • news
    • finance
Odpovědi
  • 200
    Typ: object

    Výsledky hledání byly úspěšně vráceny.

    • answer
      Typ: string | null

      Krátká odpověď vygenerovaná LLM. Má hodnotu null, když je include_answer false nebo se nevygeneruje žádná odpověď.

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

        Popis obrázku.

      • url
        Typ: string

        Adresa URL obrázku.

    • query
      Typ: string

      Vyhledávací dotaz, který byl proveden.

    • request_id
      Typ: string

      Jedinečný identifikátor požadavku.

    • response_time
      Typ: number Formát: float

      Doba v sekundách, za kterou byl požadavek dokončen.

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

        Úryvek obsahu výsledku vyhledávání.

      • favicon
        Typ: string | null

        Adresa URL favikony výsledku vyhledávání.

      • raw_content
        Typ: string | null

        Očištěný a parsovaný obsah zdroje. Null, pokud není vyžádán include_raw_content nebo není k dispozici žádný surový obsah.

      • score
        Typ: number Formát: float

        Skóre relevance výsledku vyhledávání.

      • title
        Typ: string

        Název výsledku vyhledávání.

      • url
        Typ: string

        Adresa URL výsledku vyhledávání.

    • usage
      Typ: object
      • credits
        Typ: integer

        Jednotky prostředků spotřebované tímto požadavkem, nikoli USD nebo kredity Felo.

    application/json
  • 400

    Požadavek se nepodařilo zpracovat. Zkontrolujte parametry požadavku.

  • 401

    Je vyžadován platný API klíč Felo.

  • 402

    V požadavku nelze pokračovat, protože není splněn požadavek na fakturaci.

  • 403

    Účet nemá oprávnění tuto operaci provést.

  • 429

    Byl dosažen limit požadavků nebo útraty.

  • 502

    Služba nemohla požadavek dokončit.

  • 503

    API nebo fakturační služba je dočasně nedostupná.

  • 504

    Při zpracování požadavku vypršel časový limit služby.

  • default

    Chybová odpověď; odpovědi předávané přímo od upstream poskytovatele mohou používat formáty poskytovatele

    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