Retrieve

post

https://api.ragie.ai/retrievals

Body Params

query

string

required

The query to search with when retrieving document chunks.

top_k

integer

Defaults to 8

The maximum number of chunks to return. Defaults to 8.

filter

object

The metadata search filter on documents. Returns chunks only from documents which match the filter. The following filter operators are supported: $eq - Equal to (number, string, boolean), $ne - Not equal to (number, string, boolean), $gt - Greater than (number), $gte - Greater than or equal to (number), $lt - Less than (number), $lte - Less than or equal to (number), $in - In array (string or number), $nin - Not in array (string or number). The operators can be combined with AND and OR. Read Metadata & Filters guide for more details and examples.

rerank

boolean

Defaults to false

Reranks the chunks for semantic relevancy post cosine similarity. Will be slower but returns a subset of highly relevant chunks. Best for reducing hallucinations and improving accuracy for LLM generation.

max_chunks_per_document

integer

Maximum number of chunks to retrieve per document. Use this to increase the number of documents the final chunks are retrieved from. This feature is in beta and may change in the future.

partition

string

The partition to scope a retrieval to. If omitted, the retrieval will be scoped to the default partition, which includes any documents that have not been created in a partition.

recency_bias

boolean

Defaults to false

Enables recency bias which will favor more recent documents vs older documents. https://docs.ragie.ai/docs/retrievals-recency-bias

Responses

200Successful Response

401Unauthorized

402Payment Required

422Validation Error

429Too Many Requests

500Internal Server Error