Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Filter composition: AND, OR, and NOT operators nest to build complex filter logic on document payloads
Filters narrow results using logical operators to combine conditions. They operate on document payloads (metadata, enrichments, passthrough fields) and can be applied in retriever execution or as dedicated filter@v1 stages.

​
Payload Indexes

Filters require payload indexes on the fields you filter by. Without an index, the vector store performs a full scan — which is slow on large collections and may return incomplete results.
Create indexes on your namespace before using filters: 
curl -X PATCH https://api.mixpeek.com/v1/namespaces/{namespace_id} \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "payload_indexes": [
      {"field_name": "metadata.category", "type": "keyword"},
      {"field_name": "metadata.price", "type": "integer"},
      {"field_name": "metadata.status", "type": "keyword"}
    ]
  }'
Supported index types:
TypeUse for
keywordExact-match strings (categories, IDs, tags)
integerWhole numbers
floatDecimal numbers
boolBoolean fields
datetimeTimestamps
textFull-text search
geoGeospatial queries
If you filter on an unindexed field, the response includes a warnings array telling you which fields need indexes: 
{
  "warnings": [
    "Filter field 'brand' has no payload index — filtering may be slow or unreliable on large collections. Create an index via PATCH /v1/namespaces/{namespace_id} with payload_indexes: [{\"field_name\": \"brand\", \"type\": \"keyword\"}]"
  ]
}
System fields (collection_id, bucket_id, object_id, batch_id) and _internal.* fields are indexed automatically — you only need to create indexes for your own fields.

​
Logical Operators

Mixpeek filters support three logical operators for composing conditions:
OperatorDescriptionUsage
ANDAll conditions must be trueCombine multiple required constraints
ORAt least one condition must be trueMatch any of several alternatives
NOTInverts the conditionExclude matching documents

​
AND Operator

Requires all nested conditions to match: 
{
  "AND": [
    { "field": "metadata.status", "operator": "eq", "value": "published" },
    { "field": "metadata.price", "operator": "lte", "value": 100 }
  ]
}

​
OR Operator

Matches if any nested condition is true: 
{
  "OR": [
    { "field": "metadata.category", "operator": "eq", "value": "video" },
    { "field": "metadata.category", "operator": "eq", "value": "audio" }
  ]
}

​
NOT Operator

Excludes documents matching the condition: 
{
  "NOT": {
    "field": "metadata.status", "operator": "eq", "value": "draft"
  }
}

​
Nesting Operators

Logical operators can be nested to create complex filter logic: 
{
  "AND": [
    { "field": "metadata.status", "operator": "eq", "value": "published" },
    {
      "OR": [
        { "field": "metadata.category", "operator": "eq", "value": "video" },
        { "field": "metadata.category", "operator": "eq", "value": "audio" }
      ]
    },
    {
      "NOT": {
        "field": "metadata.restricted", "operator": "eq", "value": true
      }
    }
  ]
}
This filter matches documents that are:
  • Published AND
  • Either video or audio AND
  • Not restricted

​
Comparison Operators

Use these operators within conditions:
OperatorDescription
eqEquals
neNot equals
gtGreater than
gteGreater than or equal
ltLess than
lteLess than or equal
inValue in list
ninValue not in list
existsField exists
is_nullField is null
containsString contains substring
starts_withString starts with prefix
ends_withString ends with suffix
regexMatches regular expression

​
Lineage Shortcuts

Every Mixpeek document carries a _internal.lineage block recording where it came from. To filter by lineage you don’t have to use the underscore-prefixed paths — use the friendly aliases below in any field position.
AliasResolves toUse for
from_object_internal.lineage.root_object_id”Everything derived from this bucket object”
from_bucket_internal.lineage.root_bucket_id”Everything derived from this bucket”
from_document_internal.lineage.source_document_idDirect children of one upstream document
from_collection_internal.lineage.source_collection_idDocuments whose immediate parent was in this collection
{
  "AND": [
    { "field": "from_object", "operator": "eq", "value": "obj_video_123" }
  ]
}
You can mix lineage aliases with regular fields and templates: 
{
  "AND": [
    { "field": "from_object", "operator": "eq", "value": "{{INPUT.object_id}}" },
    { "field": "metadata.scene_score", "operator": "gte", "value": 0.8 }
  ]
}
The aliases are also accepted by document list endpoints and retriever filter stages — the same vocabulary works everywhere field is used.

​
Using Templates

Reference request inputs or stage outputs in filter values: 
{
  "AND": [
    { "field": "metadata.category", "operator": "eq", "value": "{{INPUT.category}}" },
    { "field": "metadata.price", "operator": "lte", "value": "{{INPUT.max_price}}" }
  ]
}

​
Filter Stage Example

{
  "stage_name": "filter",
  "version": "v1",
  "parameters": {
    "strategy": "structured",
    "structured_filter": {
      "AND": [
        { "field": "metadata.category", "operator": "eq", "value": "audio" },
        { "field": "metadata.price", "operator": "lte", "value": "{{INPUT.max_price}}" }
      ]
    }
  }
}

​
Options

OptionDefaultDescription
case_sensitivefalseEnable case-sensitive string comparisons
{
  "field": "metadata.title",
  "operator": "contains",
  "value": "AI",
  "case_sensitive": true
}