Felo API PlatformFelo API Platform
Усі endpoint Scholar Search
v0.2.0-beta
OpenAPI 3.1.0

Пояснити результати пошуку

Сервер:https://openapi.felo.ai
Клієнтські бібліотеки

Пояснити результати пошуку

​

Пояснює раніше отримані результати пошуку. Передайте search_id, повернутий пошуком Scholar, з необов'язковими detail_level і language. response_mode=NON_STREAMING повертає JSON із message; COMPLETE та INCREMENTAL повертають text/event-stream, де кожна подія містить накопичене пояснення. Ця операція пояснює наявний пошук і не запускає новий.

Довідкові ціни

  • Тарифікація: фіксована базова вартість успішного запиту.
  • Довідкова оцінка запиту: USD 0.01.
  • Довідковий множник для клієнта: 1.0. Не застосовуйте його повторно до вже розрахованої суми клієнта.

Довідкові метадані, а не котирування для облікового запису, гарантована ціна чи ліміт витрат. Кредити ресурсів — це не кредити Felo. Остаточні списання здійснюються за записами білінгу Felo.

Тіло
обов'язкове
application/json
  • search_id
    Тип: string
    обов'язкове

    ID пошуку, для якого потрібно надати пояснення

  • detail_level
    Тип: string перелік

    Рівень деталізації пояснення

    значення
    • BRIEF
    • MODERATE
    • DETAILED
  • language
    Тип: string

    Код мови пояснення (наприклад, en, zh, ar)

  • response_mode
    Тип: string перелік

    Формат відповіді з поясненням. COMPLETE і INCREMENTAL передають server-sent events потоком; NON_STREAMING повертає JSON-відповідь.

    значення
    • COMPLETE
    • INCREMENTAL
    • NON_STREAMING
Відповіді
  • 200
    Тип: object · Response8Da310D1D213_ExplainSearchResponse

    Успішна відповідь із поясненням. COMPLETE/INCREMENTAL передають text/event-stream; NON_STREAMING повертає application/json.

    Відповідь із поясненням у форматі JSON, що повертається, коли response_mode має значення NON_STREAMING.

    • message
      Тип: string
      обов'язкове

      Згенерований текст пояснення.

  • 400

    Не вдалося обробити запит. Перевірте параметри запиту.

  • 401

    Потрібен дійсний API-ключ Felo.

  • 402

    Запит неможливо виконати: умови білінгу не виконано.

  • 403

    Обліковий запис не має дозволу на цю операцію.

  • 429

    Досягнуто ліміту запитів або витрат.

  • 502

    Служба не змогла виконати запит.

  • 503

    API або служба білінгу тимчасово недоступні.

  • 504

    Час очікування обробки запиту вичерпано.

  • default

    Відповідь із помилкою; наскрізні відповіді апстріму можуть використовувати формати постачальника

    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