Felo API PlatformFelo API Platform
Все эндпоинты 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 enum

    Уровень детализации объяснения

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

    Код языка объяснения (например, en, zh, ar)

  • response_mode
    Тип: string enum

    Формат ответа с объяснением. 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

    Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера

    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

Нужна помощь?