Felo API PlatformFelo API Platform
Alle Endpoints von Scholar Search
v0.2.0-beta
OpenAPI 3.1.0

Suchergebnisse erläutern

Server:https://openapi.felo.ai
Client-Bibliotheken

Suchergebnisse erläutern

​

Erläutert zuvor abgerufene Suchergebnisse. Übergeben Sie die search_id, die eine Scholar-Suche zurückgegeben hat, mit optionalem detail_level und language. response_mode=NON_STREAMING gibt JSON mit message zurück; COMPLETE und INCREMENTAL geben text/event-stream zurück, wobei jedes Ereignis die akkumulierte Erläuterung enthält. Dieser Vorgang erläutert eine bestehende Suche und startet keine weitere Suche.

Preisreferenz

  • Abrechnung: Feste Kostenbasis pro erfolgreicher Anfrage.
  • Referenzschätzung pro Anfrage: USD 0.01.
  • Referenz-Kundenmultiplikator: 1.0. Nicht erneut auf einen abgerechneten Kundenbetrag anwenden.

Nur Referenzmetadaten, kein Kontenangebot, kein garantierter Preis und keine Ausgabenobergrenze. Ressourcen-Credits sind keine Felo-Credits. Endgültige Abrechnungen richten sich nach den Felo-Abrechnungsbelegen.

Body
erforderlich
application/json
  • search_id
    Typ: string
    erforderlich

    ID der zu erläuternden Suche

  • detail_level
    Typ: string enum

    Detailgrad der Erläuterung

    Werte
    • BRIEF
    • MODERATE
    • DETAILED
  • language
    Typ: string

    Sprachcode für die Erläuterung (z. B. en, zh, ar)

  • response_mode
    Typ: string enum

    Format der Erläuterungsantwort. COMPLETE und INCREMENTAL streamen Server-Sent Events; NON_STREAMING gibt eine JSON-Antwort zurück.

    Werte
    • COMPLETE
    • INCREMENTAL
    • NON_STREAMING
Antworten
  • 200
    Typ: object · Response8Da310D1D213_ExplainSearchResponse

    Erfolgreiche Erläuterungsantwort. COMPLETE/INCREMENTAL streamen text/event-stream; NON_STREAMING gibt application/json zurück.

    JSON-Antwort mit der Erklärung, die zurückgegeben wird, wenn response_mode den Wert NON_STREAMING hat.

    • message
      Typ: string
      erforderlich

      Generierter Erklärungstext.

  • 400

    Die Anfrage konnte nicht verarbeitet werden. Prüfen Sie die Anfrageparameter.

  • 401

    Ein gültiger Felo-API-Schlüssel ist erforderlich.

  • 402

    Die Anfrage kann nicht fortgesetzt werden, da eine Abrechnungsvoraussetzung nicht erfüllt ist.

  • 403

    Das Konto ist für diesen Vorgang nicht berechtigt.

  • 429

    Ein Anfrage- oder Ausgabenlimit wurde erreicht.

  • 502

    Der Dienst konnte die Anfrage nicht abschließen.

  • 503

    Die API oder der Abrechnungsdienst ist vorübergehend nicht verfügbar.

  • 504

    Beim Verarbeiten der Anfrage ist eine Zeitüberschreitung aufgetreten.

  • default

    Fehlerantwort; Upstream-Passthrough-Antworten können Anbieterformate verwenden

    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