Filtering Content

Add filter metadata to each document during ingest. GroundX copies it to every chunk so you can restrict which documents a search returns.

Include a filter expression when searching a bucket to return only matching documents. Without a filter expression, search includes the entire bucket.

Supported metadata types

Filter metadata must be a JSON object with string keys. Values can be:

• String
• Number (integers and decimals are stored as 64-bit floating-point values)
• Boolean (true or false)
• List of strings or numbers
• Nested objects following the same rules

These metadata objects are valid:

{
    "security_level": 1,
    "organization": "corporate",
    "roles": ["director","executive"]
}

{
    "permissions": {
      "security_level": 1,
      "organization": "corporate",
      "roles": ["director","executive"]
    },
    "graph": {
      "nodes": ["corporate policy","version 1.0.112"]
    }
}

Filter Metadata Size

Filter metadata is limited to 40 KB per document.

Filter Query Syntax

Filter queries are based on MongoDB’s query and projection operators. GroundX supports a subset of these selectors:

This document’s filter metadata includes a "roles" list:

{ "roles": ["director", "executive"] }

The document has both "director" and "executive" roles. All these queries match it:

{"roles":"director"}

{"roles": {"$in":["director","executive","employee"]}}

{"$and": [{"roles": "director"}, {"roles":"executive"}]}

This query does not match:

{ "$and": [{ "roles": "director" }, { "roles": "employee" }] }

These invalid queries return an error:

# INVALID QUERY:
{"roles": [true, false]}

# INVALID QUERY:
{"roles": {"$eq": ["director", "employee"]}}