Retrieval Proxy

Обновлено 6 марта 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

query

string[]

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

is_references_enabled

boolean

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

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

is_ranker_enabled

boolean

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

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

doc_count

integer

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

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

text_sources

dict[str, dict][]

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

images_sources

dict[str, dict]

Возможные значения: [rambler]

По умолчанию: [object Object]

Список источников с картинками с возможными параметрами для поиска. Если будет прислан пустой словарь, будут взяты значения по дефолту

send_debug_info

boolean

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

Включение / выключение в ответ поля debug_info.

Ответы

• 200
• 422

ОК

• application/json

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

Schema

payload

object

required

status

Status (string)

required

query

Query (string)

required

documents

undefined[]

required

images

undefined[]

required

sources

object

title

Title (string)

required

url

Url (string)

required
debug_info
object

{
  "payload": {
    "status": "string",
    "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 (string)

required

type

Error Type (string)

required

]

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

Loading...

Loading...