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

Slimme zoekopdracht die web- en academische resultaten combineert

Server:https://openapi.felo.ai
Clientbibliotheken

Slimme zoekopdracht die web- en academische resultaten combineert

​

Doorzoekt web en academische bronnen samen, voor vragen die beide raken. ⚠️ Parameters horen in de querystring: query (vereist), max_num_results, as_ylo/as_yhi. Retourneert een zoek-id en results[]; de vorm van de items verschilt per bron – elk resultaat heeft title, link en snippet, en academische resultaten bevatten daarnaast authors en number_of_citations, behandel die twee dus als optioneel in plaats van aan te nemen dat ze aanwezig zijn. Gebruik het wanneer je vooraf niet weet welk soort bron antwoord geeft. Als je dat wel weet, is post_scholar_search_web of post_scholar_search_scholar voorspelbaarder. Bewaar de id voor post_scholar_search_explain.

Prijsreferentie

  • Metering: Vaste kostenbasis per geslaagd verzoek.
  • Referentieschatting per verzoek: USD 0.01.
  • Referentieklantvermenigvuldiger: 1.0. Pas deze niet opnieuw toe op een afgerekend klantbedrag.

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

Queryparameters
  • as_yhi
    Type: integer | null
    min.:  
    1900
    max.:  
    2030

    Bovengrens van het publicatiejaar

  • as_ylo
    Type: integer | null
    min.:  
    1900
    max.:  
    2030

    Ondergrens van het publicatiejaar

  • max_num_results
    Type: integer
    min.:  
    1
    max.:  
    100

    Maximaal aantal terug te geven zoekresultaten, tot 100

  • query
    Type: string
    verplicht

    Zoekopdracht voor wetenschappelijk materiaal

Responsen
  • 200
    Type: object · Response8Da310D1D213_SmartSearchResponse

    Geslaagde zoekrespons

    • id
      Type: string
      verplicht

      Unieke identificatie voor het zoekverzoek

    • results
      Type: array object[] · Response8Da310D1D213_SmartResult[]
      verplicht

      Lijst met slimme zoekresultaten die web- en wetenschappelijke inhoud combineren

      • link
        Type: string Formaat: uri
        verplicht

        URL naar de inhoud

      • snippet
        Type: string
        verplicht

        Korte samenvatting of abstract

      • title
        Type: string
        verplicht

        Titel van het resultaat

      • authors
        Type: array string[]

        Lijst met auteurs (voor wetenschappelijke inhoud)

      • number_of_citations
        Type: integer
        min.:  
        0

        Aantal citaties (voor wetenschappelijke inhoud)

      • relevance_score
        Type: number
        min.:  
        0
        max.:  
        1

        Relevantiescore van het resultaat

      • type
        Type: string enum

        Type resultaat

        waarden
        • web
        • academic
    • search_type
      Type: string enum

      Type opgenomen zoekresultaten

      waarden
      • web
      • academic
      • hybrid
    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/scholar/search/mixed
curl 'https://openapi.felo.ai/v1/beta/scholar/search/mixed?query=machine%20learning' \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "string",
  "results": [
    {
      "title": "string",
      "link": "https://example.com",
      "snippet": "string",
      "authors": [
        "string"
      ],
      "number_of_citations": 0,
      "type": "web",
      "relevance_score": 0
    }
  ],
  "search_type": "web"
}
Smart search combining web and academic results