Health
Collections
Collection Documents
Collection Features
Retriever Stages
Taxonomies
Clusters
Retriever Interactions
Namespaces
Research
Get Retriever
curl --request GET \
--url https://api.mixpeek.com/v1/retrievers/retrievers/{retriever_id}{
"retriever_id": "<string>",
"retriever_name": "<string>",
"description": "<string>",
"input_schema": {
"properties": {}
},
"collection_ids": [
"<string>"
],
"stages": [
{
"stage_name": "<string>",
"version": "<string>",
"module_path": "<string>",
"parameters": {},
"pre_filters": {
"AND": [
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
],
"OR": [
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
],
"NOT": [
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
],
"case_sensitive": true
},
"post_filters": {
"AND": [
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
],
"OR": [
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
],
"NOT": [
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
],
"case_sensitive": true
},
"timeout_seconds": 123,
"exclude_from_final": false
}
],
"metadata": {},
"cache_config": {
"enabled": true,
"ttl_seconds": 123,
"score_threshold": 123
}
}Headers
Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'
Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.
Path Parameters
Response
Definition of a retriever
Name of the retriever
Schema defining the expected input format
Schema field definition for retriever inputs
Enum for field types in bucket schemas
string, number, integer, boolean, object, array, date, datetime, json, text, image, audio, video, pdf, document, spreadsheet, presentation, dense_vector, sparse_vector, int8_vector Schema field definition for bucket objects
Enum for field types in bucket schemas
string, number, integer, boolean, object, array, date, datetime, json, text, image, audio, video, pdf, document, spreadsheet, presentation, dense_vector, sparse_vector, int8_vector Schema field definition for bucket objects
Whether this field is required for the retriever
List of collection IDs to search in
List of stages to execute in order
Configuration for how a retriever stage processes queries and handles results.
This model consolidates stage-specific settings that control behavior during retrieval operations, making it easier to configure stages with consistent options.
Name of the stage
Version of the stage
Python module path for the stage
Parameters for the stage
Filters to apply before the main search is executed
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
Filters to apply to search results after retrieval
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
Logical AND operation - all conditions must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
]
Logical OR operation - at least one condition must be true
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
]
Logical NOT operation - all conditions must be false
Represents a logical operation (AND, OR, NOT) on filter conditions.
Attributes: AND: List of conditions that must all be true OR: List of conditions where at least one must be true NOT: List of conditions that must all be false case_sensitive: Whether string comparisons are case sensitive
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
[
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
]
Whether to perform case-sensitive matching
true
Maximum execution time for this stage in seconds
If True, results from this stage are used for subsequent stages but excluded from final output
Unique identifier for the retriever
Description of the retriever
Was this page helpful?
curl --request GET \
--url https://api.mixpeek.com/v1/retrievers/retrievers/{retriever_id}{
"retriever_id": "<string>",
"retriever_name": "<string>",
"description": "<string>",
"input_schema": {
"properties": {}
},
"collection_ids": [
"<string>"
],
"stages": [
{
"stage_name": "<string>",
"version": "<string>",
"module_path": "<string>",
"parameters": {},
"pre_filters": {
"AND": [
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
],
"OR": [
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
],
"NOT": [
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
],
"case_sensitive": true
},
"post_filters": {
"AND": [
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
],
"OR": [
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
],
"NOT": [
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
],
"case_sensitive": true
},
"timeout_seconds": 123,
"exclude_from_final": false
}
],
"metadata": {},
"cache_config": {
"enabled": true,
"ttl_seconds": 123,
"score_threshold": 123
}
}