POST
/
v1
/
query
/
search
/
{docset_id}
{
  "results": [
    "<any>"
  ],
  "query_embedding": [
    123
  ],
  "next_page_token": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
docset_id
string
required

The ID of the docset to query.

Query Parameters

​
page_size
integer
default:100

The number of results to return per page.

​
page_token
string | null

Reserved for future use. A pagination token to retrieve the next page of results.

Body

application/json
​
query
string | null

The query to search for

​
query_type
enum<string>
default:lexical

The type of query to perform.

Available options:
keyword,
lexical,
vector,
hybrid
​
properties_filter
string | null

A filter to apply to the properties of the documents.

​
return_type
enum<string>
default:doc

The type of result to return.

Available options:
doc,
element
​
include_fields
string[] | null

When specified, the server performs a projection to return only the fields specified by this list of JsonPaths (see RFC 9535) given as a list of strings.

​
debug_info
boolean | null
default:false

When True, the server returns additional debug information (the embedding calculated for a vector or hybrid query) in the response.

​
include_element_embedding
boolean | null
default:false

When False, and return_type is "element", the server does not return the embeddings of elements in the response.

Response

200
application/json
Successful Response
​
results
any[]
required

The list of results returned by the query. These are Json objects representing the documents or elements that matched the query, possibly filtered by the optional projection specified by include_fields.

​
query_embedding
number[] | null

The embedding calculated for the query, if the query type is vector or hybrid and debug_info is True.

​
next_page_token
string | null

Reserved for future use. Will be a pagination token that can be used to retrieve the next page of results.

Was this page helpful?