TUturbopuffer

POST /v2/namespaces/{namespace}/query

Changed on

Query, filter, full-text search and vector search documents.

Request

Path parameters

namespacestring required

The name of the namespace.

Request body

rank_byunknown
top_kinteger

The number of results to return.

offsetinteger

Number of documents to skip before returning results. Supported only in v2 queries with an explicit rank_by and top_k or limit.

filtersunknown
exclude_attributesstring[]

List of attribute names to exclude from the response. All other attributes will be included in the response.

aggregate_byobject

Aggregations to compute over all documents in the namespace that match the filters.

compute_attributesobject

Computes additional values on documents returned by a query. Each key is the name of the computed attribute; each value is an expression describing how to compute it.

Response

The schema of the namespace.

aggregationsobject
aggregation_groupsAggregationGroup[]

Changes

  • eaacb7c9194cRevision changes
    • breaking

      the //// request property type changed from object to no type

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • info

      added discriminator to //// request property

    • info

      added subschema #1: strong subschema #2: eventual to the //// request property oneOf list

  • f0229c82104eRevision changes
    • info

      added the new optional request property /////