Felo API PlatformFelo API Platform
Все эндпоинты Scholar Search
v0.2.0-beta
OpenAPI 3.1.0

Умный поиск, объединяющий веб- и академические результаты

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

Умный поиск, объединяющий веб- и академические результаты

​

Ищет одновременно в вебе и академических источниках для вопросов, затрагивающих обе области. ⚠️ Параметры передаются в строке запроса: query (обязателен), max_num_results, as_ylo/as_yhi. Возвращает id поиска и results[]; структура записи зависит от источника — у каждого результата есть title, link и snippet, а академические дополнительно содержат authors и number_of_citations, поэтому считайте эти два поля необязательными, а не предполагайте их наличие. Используйте, когда заранее неизвестно, какой тип источника даст ответ. Когда известно, post_scholar_search_web или post_scholar_search_scholar предсказуемее. Сохраните id для post_scholar_search_explain.

Справочные цены

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

Справочные метаданные, а не коммерческое предложение для аккаунта, гарантированная цена или лимит расходов. Кредиты ресурсов — не кредиты Felo. Итоговые списания определяются записями биллинга Felo.

Query-параметры
  • as_yhi
    Тип: integer | null
    мин.:  
    1900
    макс.:  
    2030

    Верхняя граница года публикации

  • as_ylo
    Тип: integer | null
    мин.:  
    1900
    макс.:  
    2030

    Нижняя граница года публикации

  • max_num_results
    Тип: integer
    мин.:  
    1
    макс.:  
    100

    Максимальное количество результатов поиска, до 100

  • query
    Тип: string
    обязательно

    Поисковый запрос для научных материалов

Ответы
  • 200
    Тип: object · Response8Da310D1D213_SmartSearchResponse

    Успешный ответ на поиск

    • id
      Тип: string
      обязательно

      Уникальный идентификатор поискового запроса

    • results
      Тип: array object[] · Response8Da310D1D213_SmartResult[]
      обязательно

      Список результатов умного поиска, объединяющих веб- и научный контент

      • link
        Тип: string Формат: uri
        обязательно

        URL для доступа к контенту

      • snippet
        Тип: string
        обязательно

        Краткое резюме или аннотация

      • title
        Тип: string
        обязательно

        Название результата

      • authors
        Тип: array string[]

        Список авторов (для научного контента)

      • number_of_citations
        Тип: integer
        мин.:  
        0

        Число цитирований (для научного контента)

      • relevance_score
        Тип: number
        мин.:  
        0
        макс.:  
        1

        Оценка релевантности результата

      • type
        Тип: string enum

        Тип результата

        значения
        • web
        • academic
    • search_type
      Тип: string enum

      Тип включённых результатов поиска

      значения
      • web
      • academic
      • hybrid
    application/json
  • 400

    Запрос не удалось обработать. Проверьте параметры запроса.

  • 401

    Требуется действительный API-ключ Felo.

  • 402

    Запрос не может быть выполнен: не выполнено требование биллинга.

  • 403

    Аккаунту не разрешено выполнять эту операцию.

  • 429

    Достигнут лимит запросов или расходов.

  • 502

    Сервис не смог выполнить запрос.

  • 503

    API или сервис биллинга временно недоступны.

  • 504

    Истекло время ожидания обработки запроса.

  • default

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

    application/json
Request Example for post/v1/beta/scholar/search/mixed
curl 'https://openapi.felo.ai/v1/beta/scholar/search/mixed?query=machine%20learning' \
  --request POST \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "string",
  "results": [
    {
      "title": "string",
      "link": "https://example.com",
      "snippet": "string",
      "authors": [
        "string"
      ],
      "number_of_citations": 0,
      "type": "web",
      "relevance_score": 0
    }
  ],
  "search_type": "web"
}
Smart search combining web and academic results

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