Search

GET

/v1/search

curl --request GET \
  --url 'https://api.cloud.agentums.ru/v1/search?q=&top_k=0&include_hidden=false' \
  --header 'Authorization: Bearer <token>'

• Прод

Найти файлы: вектор, полнотекст и имя с расширением одной выдачей.

Три способа ищут разное и объединяются ранжированием, поэтому запрос вида договор аренды и запрос вида акт-2024.pdf работают оба. Пустой q возвращает пустую выдачу, а не ошибку.

doc_type (contract, invoice, passport, meeting_minutes и др.) сужает поиск по типу документа и работает дешевле и точнее свободной формулировки.

top_k ограничен сверху настройкой сервера: запрошенное большее число молча урезается — рассчитывать на выдачу произвольного размера нельзя.

Файлы из «Скрытых» в выдачу не попадают, пока зона не разблокирована: нужен include_hidden=true вместе с заголовком X-Hidden-Token, который выдаёт разблокировка по PIN. Без токена флаг гасится молча — иначе разница в ответах выдавала бы сам факт существования скрытого файла.

Ответ — совпадения с оценкой; содержимое файла отдают /objects/{id}/text-content (текст) и /objects/{id}/content (временная ссылка на скачивание).

Authorizations

• bearerAuth

Parameters

Query Parameters

q

Q

string

"" <= 2000 characters

doc_type

Any of:

string

string

null

null

top_k

Top K

integer

0

include_hidden

Include Hidden

boolean

Header Parameters

x-hidden-token

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

SearchResponse

object

hits

Hits

Array<object>

SearchHit

object

doc_type

Doc Type

string

default: other

filename

Filename

string

""

object_id

required

Object Id

string format: uuid

score

Score

number

0

snippet

Snippet

string

""

summary

Summary

string

""

title

Title

string

""

query

required

Query

string

Example

{
  "hits": [
    {
      "doc_type": "other",
      "filename": "",
      "score": 0,
      "snippet": "",
      "summary": "",
      "title": ""
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}