Search document summaries

1 import requests 2 3 url = "https://api.sciphi.ai/v3/documents/search" 4 5 payload = { "query": "query" } 6 headers = { 7 "Authorization": "Bearer <token>", 8 "Content-Type": "application/json" 9 } 10 11 response = requests.post(url, json=payload, headers=headers) 12 13 print(response.json())

1 { 2 "results": [ 3 { 4 "id": "123e4567-e89b-12d3-a456-426614174000", 5 "collection_ids": [ 6 "123e4567-e89b-12d3-a456-426614174000" 7 ], 8 "owner_id": "123e4567-e89b-12d3-a456-426614174000", 9 "document_type": "pdf", 10 "metadata": { 11 "title": "Sample Document" 12 }, 13 "version": "1.0", 14 "title": "Sample Document", 15 "size_in_bytes": 123456, 16 "ingestion_status": "pending", 17 "extraction_status": "pending", 18 "created_at": "2021-01-01T00:00:00Z", 19 "updated_at": "2021-01-01T00:00:00Z", 20 "ingestion_attempt_number": 0, 21 "summary": "A summary of the document", 22 "summary_embedding": [ 23 0.1, 24 0.2, 25 0.3 26 ], 27 "total_tokens": 1000 28 } 29 ] 30 }

Perform a search query on the automatically generated document summaries in the system.

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.

Perform a search query on the automatically generated document summaries in the system. 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`.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

querystringRequired

The search query to perform.

search_modeenumOptional

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.

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.

Allowed values:

search_settingsobjectOptional

Settings for document search

Response

Successful Response

resultslist of objects

Authentication

Headers

Request

Response

Errors