Skip to main content
POST
/
api
/
r2r
/
v3
/
documents
/
search
Search document summaries
curl --request POST \
  --url https://api.intelligence.io.solutions/api/r2r/v3/documents/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "search_mode": "basic",
  "search_settings": {
    "use_hybrid_search": false,
    "use_semantic_search": true,
    "use_fulltext_search": false,
    "filters": "<string>",
    "limit": 10,
    "offset": "0",
    "include_metadatas": true,
    "include_scores": true,
    "search_strategy": "vanilla",
    "hybrid_settings": {
      "full_text_weight": 1,
      "semantic_weight": 5,
      "full_text_limit": 200,
      "rrf_k": 50
    },
    "chunk_settings": {
      "index_measure": "l2_distance",
      "probes": 10,
      "ef_search": 40,
      "enabled": true
    },
    "graph_settings": {
      "limits": "<array>",
      "enabled": true
    },
    "num_sub_queries": 5
  }
}
'
{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "collection_ids": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "owner_id": "123e4567-e89b-12d3-a456-426614174000",
      "document_type": "pdf",
      "metadata": {
        "title": "Sample Document"
      },
      "version": "1.0",
      "title": "Sample Document",
      "size_in_bytes": 123456,
      "ingestion_status": "pending",
      "extraction_status": "pending",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z",
      "ingestion_attempt_number": 0,
      "summary": "A summary of the document",
      "summary_embedding": [
        0.1,
        0.2,
        0.3
      ],
      "total_tokens": 1000
    }
  ]
}
This endpoint allows for complex filtering of search results using PostgreSQL-based queries. Filters can be applied to various fields such as document_id, and internal metadata values. Allowed operators include eq, neq, gt, gte, lt, lte, like, ilike, in, and nin.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
query
string
required

The search query to perform.

​
search_mode
enum<string>

Default value of custom allows full control over search settings. Pre-configured search modes: basic: A simple semantic-based search. advanced: A more powerful hybrid search combining semantic and full-text. custom: Full control via search_settings. If filters or limit are provided alongside basic or advanced, they will override the default settings for that mode.

Available options:
basic,
advanced,
custom
​
search_settings
object

Settings for document search

Response

200

​
results
object[]