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

Zoekresultaten toelichten

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

Zoekresultaten toelichten

​

Licht eerder opgehaalde zoekresultaten toe. Geef de search_id mee die een Scholar-zoekopdracht heeft geretourneerd, met optionele detail_level en language. response_mode=NON_STREAMING retourneert JSON met message; COMPLETE en INCREMENTAL retourneren text/event-stream, waarbij elke gebeurtenis de opgebouwde toelichting bevat. Deze bewerking licht een bestaande zoekopdracht toe en start geen nieuwe zoekopdracht.

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.

Body
verplicht
application/json
  • search_id
    Type: string
    verplicht

    ID van de zoekopdracht die moet worden toegelicht

  • detail_level
    Type: string enum

    Detailniveau van de toelichting

    waarden
    • BRIEF
    • MODERATE
    • DETAILED
  • language
    Type: string

    Taalcode voor de toelichting (bijv. en, zh, ar)

  • response_mode
    Type: string enum

    Formaat van de toelichtingsrespons. COMPLETE en INCREMENTAL streamen server-sent events; NON_STREAMING retourneert een JSON-respons.

    waarden
    • COMPLETE
    • INCREMENTAL
    • NON_STREAMING
Responsen
  • 200
    Type: object · Response8Da310D1D213_ExplainSearchResponse

    Succesvolle toelichtingsrespons. COMPLETE/INCREMENTAL streamen text/event-stream; NON_STREAMING retourneert application/json.

    JSON-antwoord met de uitleg dat wordt geretourneerd wanneer response_mode de waarde NON_STREAMING heeft.

    • message
      Type: string
      verplicht

      Gegenereerde uitlegtekst.

  • 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/explain
curl https://openapi.felo.ai/v1/beta/scholar/search/explain \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "search_id": "",
  "response_mode": "NON_STREAMING",
  "language": "ar",
  "detail_level": "MODERATE"
}'
{
  "message": "string"
}
Explain search results