Skip to main content
POST
/
queries
/
top-pages
Top Pages
curl --request POST \
  --url https://api.zeroentropy.dev/v1/queries/top-pages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "collection_name": "<string>",
  "query": "<string>",
  "k": 123,
  "filter": {},
  "include_content": false,
  "include_metadata": false,
  "latency_mode": "low"
}
'
{
  "results": [
    {
      "path": "<string>",
      "page_index": 123,
      "score": 123,
      "content": "<string>",
      "image_url": "<string>"
    }
  ],
  "document_results": [
    {
      "path": "<string>",
      "score": 123,
      "metadata": {},
      "file_url": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The Authorization header must be provided in the format Bearer <your-api-key>.

You can get your API Key at the Dashboard!

Body

application/json
​
collection_name
string
required

The name of the collection.

​
query
string
required

The natural language query to search with. This cannot exceed 4096 UTF-8 bytes.

​
k
integer
required

The number of pages to return. If there are not enough pages matching your filters, then fewer may be returned. This number must be between 1 and 1024, inclusive.

​
filter
object

The query filter to apply. Please read Metadata Filtering for more information. If not provided, then all documents will be searched.

​
include_content
boolean
default:false

If set to true, then the content of all pages will be returned.

​
include_metadata
boolean
default:false

Whether or not to include the document metadata in the response. If not provided, then the default will be False.

​
latency_mode
enum<string>
default:low

This option selects between our two latency modes. The higher latency mode takes longer, but can allow for more accurate responses. If desired, test both to customize your search experience for your particular use-case, or use the default of "low" and only swap if you need an additional improvement in search result quality.

Available options:
low,
high

Response

Successful Response

​
results
PageRetrievalResponse · object[]
required
​
document_results
DocumentRetrievalResponse · object[]
required

The array of associated document information. Note how each result page has an associated document path. After deduplicating the document paths, this array will contain document info for each document path that is referenced by at least one page result.