الانتقال إلى المحتوى الرئيسي
POST
Query every namespace

التفويضات

Authorization
string
header
مطلوب

A key from conare.ai/dashboard/keys with full access, some namespaces, or models only (/embed, /rerank, /v1, /v2/rerank, /parse).

الجسم

application/json
query
string

What to search for, in plain language; required unless cursor is set.

Required string length: 1 - 8000
top_k
integer
افتراضي:10

How many results to return; with cursor, the page size.

النطاق المطلوب: 1 <= x <= 500
max_results
integer

Rank this many documents and return them top_k at a time with next_cursor.

النطاق المطلوب: 1 <= x <= 5000
cursor
string

A previous page's next_cursor.

exclude_ids
string[]

Documents no result may be, as namespace/id.

Maximum array length: 10000
Pattern: ^[a-z0-9][a-z0-9_-]{0,63}/[A-Za-z0-9][A-Za-z0-9._:-]{0,255}$
filter
object

{"key": value} matches equal values (or arrays holding it); $eq, $ne, $in, $nin, $gt, $gte, $lt and $lte compare, $and and $or combine.

  • A filter holds at most 256 conditions (each value, $in item, range and join counts one), else 400 invalid_filter.
  • Ranges compare numbers with numbers and strings by UTF-8 bytes: write dates alike (2025-06-01) to sort them.
  • $ne and $nin work in queries, not deletes, and match documents without the key.
أمثلة:
rerank
boolean
افتراضي:true

Rerank the candidates with the reranking model.

rerank_depth
integer
افتراضي:100

How many top candidates to rerank; the rest (reranked: false) follow every reranked result.

النطاق المطلوب: 1 <= x <= 1000
hops
integer
افتراضي:1

2: the best two results seed a second search (see the namespace query).

النطاق المطلوب: 1 <= x <= 2
retrievers
enum<string>[]

Which retrievers to fuse, as on POST /namespaces/{namespace}/query.

Required array length: 1 - 2 elements
الخيارات المتاحة:
vector,
keyword
prefix
string

Search only the namespaces whose name starts with this, e.g. one user's.

Pattern: ^[a-z0-9][a-z0-9_-]{0,63}$
user
string

Only this user's documents. Combines with filter and user_prefix.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@-]{0,127}$
مثال:

"tenant-7:u_42"

user_prefix
string

Only the documents of users starting with this; it ends in :, e.g. tenant-7:.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:@-]{0,127}$
مثال:

"tenant-7:"

answer
boolean
افتراضي:false

Also answer query in prose; a language model writes the answer from the best passages, adding about 2 s.

الاستجابة

Results, best first, the namespaces searched and those skipped.

results
object[]
مطلوب
took_ms
integer
مطلوب

Time spent in Conare, in milliseconds.

answer
string

With answer: true, the answer; missing when nothing matched or with Conare-Degraded: answer.

namespaces
string[]

The namespaces searched (missing on a page read by cursor).

skipped_namespaces
string[]

Namespaces past the first 100, not searched (missing on a page read by cursor).

next_cursor
string

With max_results, the cursor to the next page; missing on the last page.