Felo API PlatformFelo API Platform
Alle endpoints van Tavily
v0.2.0-beta
OpenAPI 3.1.0

Tavily-zoekopdracht

Felo API Support
MIT
Server:https://openapi.felo.ai
Clientbibliotheken
Shell Curl

Tavily-zoekopdracht

​

Doorzoekt het web en retourneert gerangschikte resultaten met titels, URL's en inhoudsfragmenten. query is verplicht. Gebruik max_results om het aantal resultaten te regelen en search_depth om de zoekmodus te kiezen. Aanvullende antwoorden, afbeeldingen en ruwe inhoud worden alleen op verzoek geretourneerd. Stel include_usage in om informatie over resourcegebruik te ontvangen; usage.credits is geen Felo-kostenpost.

Prijsreferentie

  • Metering: Gemeten responseenheden.
  • Referentieschatting per verzoek: USD 0.016.
  • Kostenbasis per eenheid: USD 0.008.
  • Resource-eenheid: tavily_credit.
  • Referentiemultiplier voor klanten: 1.0. Niet opnieuw toepassen op een al afgerekend klantbedrag.
  • Kostenbases bepalen niet de uiteindelijke klantprijs, ook niet wanneer die nul is.

Alleen referentiemetadata, geen accountofferte en geen gegarandeerde prijs of bestedingslimiet. Resourcecredits zijn geen Felo-tegoed. De uiteindelijke kosten volgen de factureringsgegevens van Felo.

Body
verplicht
application/json
  • query
    Type: string
    verplicht

    De zoekopdracht die met Tavily wordt uitgevoerd.

  • auto_parameters
    Type: boolean

    Zoekparameters automatisch configureren op basis van de inhoud van de zoekopdracht.

  • chunks_per_source
    Type: integer
    min.:  
    1
    max.:  
    3

    Maximaal aantal relevante chunks dat per bron wordt geretourneerd.

  • country
    Type: string enum

    Zoekresultaten uit een specifiek land versterken. Alleen beschikbaar wanneer topic general is.

    waarden
    • afghanistan
    • albania
    • algeria
    • andorra
    • angola
  • end_date
    Type: string Formaat: date

    Resultaten vóór de opgegeven einddatum retourneren.

  • exclude_domains
    Type: array string[] …150

    Lijst met domeinen die expliciet van de zoekresultaten moeten worden uitgesloten.

  • include_answer

    Een door een LLM gegenereerd antwoord opnemen. true gebruikt de standaard antwoordmodus; basic of advanced selecteert de modus voor antwoordgeneratie.

    • Type: boolean

      Een door een LLM gegenereerd antwoord opnemen. true gebruikt de standaard antwoordmodus; basic of advanced selecteert de modus voor antwoordgeneratie.

  • include_domains
    Type: array string[] …300

    Lijst met domeinen die expliciet in de zoekresultaten moeten worden opgenomen.

  • include_favicon
    Type: boolean

    De favicon-URL voor elk resultaat opnemen.

  • include_image_descriptions
    Type: boolean

    Beschrijvende tekst voor elke afbeelding toevoegen wanneer include_images true is.

  • include_images
    Type: boolean

    Een afbeeldingzoekopdracht uitvoeren en resultaten opnemen.

  • include_raw_content

    Opgeschoonde en geparseerde inhoud voor elk zoekresultaat opnemen. true of markdown retourneert markdown; text retourneert platte tekst en kan de latentie verhogen.

    • Type: boolean

      Opgeschoonde en geparseerde inhoud voor elk zoekresultaat opnemen. true of markdown retourneert markdown; text retourneert platte tekst en kan de latentie verhogen.

  • include_usage
    Type: boolean

    Informatie over resourcegebruik opnemen in de respons. Dit zijn geen Felo-factureringsgegevens.

  • max_results
    Type: integer
    min.:  
    0
    max.:  
    20

    Maximaal aantal terug te geven zoekresultaten.

  • Type: boolean

    Volwassen of onveilige inhoud uit de zoekresultaten filteren. Alleen Enterprise; niet ondersteund wanneer search_depth fast of ultra-fast is.

  • search_depth
    Type: string enum

    Bepaalt de afweging tussen latentie en relevantie. advanced geeft de hoogste relevantie met hogere latentie en kosten; basic is uitgebalanceerd; fast en ultra-fast optimaliseren voor lagere latentie.

    waarden
    • advanced
    • basic
    • fast
    • ultra-fast
  • start_date
    Type: string Formaat: date

    Resultaten na de opgegeven startdatum retourneren.

  • time_range
    Type: string enum

    Tijdsbereik om resultaten op publicatiedatum te filteren.

    waarden
    • day
    • week
    • month
    • year
    • d
    • w
    • m
    • y
  • topic
    Type: string enum

    Categorie van de zoekopdracht.

    waarden
    • general
    • news
    • finance
Responsen
  • 200
    Type: object

    Zoekresultaten succesvol geretourneerd.

    • answer
      Type: string | null

      Een kort door een LLM gegenereerd antwoord. Is null wanneer include_answer false is of er geen antwoord wordt gegenereerd.

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

        Afbeeldingsbeschrijving.

      • url
        Type: string

        Afbeeldings-URL.

    • query
      Type: string

      De zoekopdracht die is uitgevoerd.

    • request_id
      Type: string

      Unieke verzoekidentificatie.

    • response_time
      Type: number Formaat: float

      Tijd in seconden die nodig was om het verzoek te voltooien.

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

        Inhoudssnippet van het zoekresultaat.

      • favicon
        Type: string | null

        Favicon-URL van het zoekresultaat.

      • raw_content
        Type: string | null

        Opgeschoonde en geparseerde broninhoud. Null, tenzij include_raw_content wordt aangevraagd of er geen ruwe inhoud beschikbaar is.

      • score
        Type: number Formaat: float

        Relevantiescore van het zoekresultaat.

      • title
        Type: string

        Titel van het zoekresultaat.

      • url
        Type: string

        URL van het zoekresultaat.

    • usage
      Type: object
      • credits
        Type: integer

        Door dit verzoek verbruikte resource-eenheden, niet USD of Felo-credits.

    application/json
  • 400

    Het verzoek kon niet worden verwerkt. Controleer de verzoekparameters.

  • 401

    Een geldige Felo-API-sleutel is vereist.

  • 402

    Het verzoek kan niet doorgaan omdat niet aan een factureringsvoorwaarde is voldaan.

  • 403

    Het account mag deze bewerking niet uitvoeren.

  • 429

    Een verzoek- of bestedingslimiet is bereikt.

  • 502

    De dienst kon het verzoek niet voltooien.

  • 503

    De API of factureringsdienst is tijdelijk niet beschikbaar.

  • 504

    Er is een time-out opgetreden bij het verwerken van het verzoek.

  • default

    Foutrespons; upstream-passthrough-responsen kunnen indelingen van de provider gebruiken

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

Zoekresultaten succesvol geretourneerd.

Tavily Search