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

Vysvětlit výsledky vyhledávání

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

Vysvětlit výsledky vyhledávání

​

Vysvětlí dříve načtené výsledky vyhledávání. Zadejte search_id vrácené vyhledáváním Scholar s volitelnými detail_level a language. response_mode=NON_STREAMING vrací JSON s message; COMPLETE a INCREMENTAL vrací text/event-stream, kde každá událost obsahuje kumulované vysvětlení. Tato operace vysvětluje existující vyhledávání a nezačíná další.

Cenová reference

  • Měření: pevná nákladová základna za úspěšný požadavek.
  • Referenční odhad požadavku: USD 0.01.
  • Referenční multiplikátor zákazníka: 1.0. Znovu jej neaplikujte na již zúčtovanou částku zákazníka.

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
  • search_id
    Typ: string
    povinné

    ID vyhledávání, které se má vysvětlit

  • detail_level
    Typ: string enum

    Úroveň podrobnosti vysvětlení

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

    Kód jazyka vysvětlení (např. en, zh, ar)

  • response_mode
    Typ: string enum

    Formát odpovědi s vysvětlením. COMPLETE a INCREMENTAL streamují události odesílané serverem; NON_STREAMING vrací odpověď JSON.

    hodnoty
    • COMPLETE
    • INCREMENTAL
    • NON_STREAMING
Odpovědi
  • 200
    Typ: object · Response8Da310D1D213_ExplainSearchResponse

    Úspěšná odpověď s vysvětlením. COMPLETE/INCREMENTAL streamují text/event-stream; NON_STREAMING vrací application/json.

    Odpověď s vysvětlením JSON vracená, když má response_mode hodnotu NON_STREAMING.

    • message
      Typ: string
      povinné

      Vygenerovaný text vysvětlení.

  • 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/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