Retrieval Proxy

Обновлено 21 января 2025

Скачать спецификацию

POST

/retrieval_proxy

Отвечает за поиск различных типов контента, таких как сниппеты, URL-адреса, результаты текстового поиска и другие элементы.

Запрос

Header Parameters

Authorization

api-key-like

required

Токен авторизации

X-User-ID

ascii строка, 36 символов (не валидируется)

ID пользователя

X-Client-ID

ascii строка, 36 символов (не валидируется)

ID клиента-поверхности

X-Request-ID

ascii строка, 36 символов (не валидируется)

ID запроса. Если отсутствует в запросе, ID будет присвоен на стороне сервера.

X-Session-ID

ascii строка, 36 символов (не валидируется)

ID сессии

• application/json

Body

required

queries

string[]

required

Массив фраз для поиска.

is_references_enabled

boolean

По умолчанию: false

Включение \ выключение в ответ ссылок на найденные документы.

is_ranker_enabled

boolean

По умолчанию: true

Включение \ выключение функциональности ранжирования документов.

doc_count

integer

По умолчанию: 5

Количество документов на выходе.

sources

string[]

Возможные значения: [news, facts, rambler_snippet]

Массив строк, указывающих какие источники использовать. Если массив пустой (sources: None), будут взяты все значения.

rambler_params object

Параметры фильтрации и сортировки для рамблера. None — будут взяты параметры по умолчанию

lr

integer

По умолчанию: 213 Москва

Регион.

page

integer

По умолчанию: 1

Cтраница.

filter_pagelen

integer

Количество результатов на странице (10, 15, 30, 50).

filter_sort

integer

Сортировка результатов. 0 — cтраницы по релевантности; 1 — cтраницы по дате; 3 — cайты по релевантности; 6 — cайты по дате.

filter_adult

string

Фильтр по возрастным ограничениям (moderate — умеренный фильтр; none — без ограничений; strict — cемейный поиск).

filter_lang

string

Язык. Пустое значение — любой язык; ru — русский; en — английский; uk — украинский; kk — казахский; be — белорусский; tt — татарский; fr — французский; de — немецкий; tr — турецкий.

filter_period

string

Временной интервал. Пустое значение — за все время; day — за сутки; week - за неделю; month — за месяц.

filter_limitcontext

integer

Точность запроса. Пустое значение — все результаты; 2 — точная фраза.

filter_mime

string

Формат документов в выдаче. Пустое значение — любой формат; pdf — документы pdf; doc — документы doc; rtf — документы rtf; xls — документы xls; ppt — документы ppt; swf — документы swf; odt — документы odt; ods — документы ods; odp — документы odp; odg — документы odg.

filter_site

string

Фильтр по сайту. Пустое значение — без фильтра.

maxpassages

integer

Максимальное количество пассажей.

Ответы

• 200
• 422

ОК

• application/json

• Схема
• Пример из схемы

Schema

payload objectrequired
status
Status
required
results object[]required
Array [
query
Query
required
documents
undefined[]
required
images
undefined[]
required
]
sources object
title
Title
required
url
Url
required
debug_info
object

{
  "payload": {
    "status": "string",
    "results": [
      {
        "query": "string",
        "documents": [
          null
        ],
        "images": [
          null
        ]
      }
    ]
  },
  "sources": {
    "title": "string",
    "url": "string"
  },
  "debug_info": {}
}

Ошибка валидации.

• application/json

• Схема
• Пример из схемы

Schema

detail object[]
Array [
loc object[]required
Array [
anyOf
• MOD1
• MOD2
string
integer
]
msg
Message
required
type
Error Type
required
]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...

Loading...