mixpeek 0.81.1

package/dist/models/stage-defs-query-preprocessing.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Configuration for query preprocessing — large file decomposition at query time.  When a query input is a large file (video, PDF, long text), preprocessing decomposes it using the same extractor pipeline that indexed the data, generates N embeddings (one per chunk), runs N parallel searches, and fuses the results into a single ranked list.  This is \"ingestion applied to the query\" — same decomposition and embedding, but vectors are used for search instead of storage.
+ * @export
+ * @interface StageDefsQueryPreprocessing
+ */
+export interface StageDefsQueryPreprocessing {
+    /**
+     * Feature URI for the extractor pipeline to use for decomposition. If None, inherits from the parent search\'s feature_uri.
+     * @type {string}
+     * @memberof StageDefsQueryPreprocessing
+     */
+    'feature_uri'?: string;
+    /**
+     * Extractor-specific parameter overrides. Same params as ingestion: split_method, time_split_interval, chunk_size, chunk_overlap, etc.
+     * @type {{ [key: string]: any; }}
+     * @memberof StageDefsQueryPreprocessing
+     */
+    'params'?: {
+        [key: string]: any;
+    };
+    /**
+     * Maximum number of chunks to search with. Caps parallel queries and embedding calls to control cost. Chunks are evenly sampled across the file if the extractor produces more than max_chunks.
+     * @type {number}
+     * @memberof StageDefsQueryPreprocessing
+     */
+    'max_chunks'?: number;
+    /**
+     * Fusion strategy for combining results from N chunk queries. \'rrf\': Reciprocal Rank Fusion (balanced, recommended). \'max\': Keep highest score per document (best for \'find this exact moment\'). \'avg\': Average scores (best for \'find similar overall content\').
+     * @type {string}
+     * @memberof StageDefsQueryPreprocessing
+     */
+    'aggregation'?: string;
+    /**
+     * Optional payload field to deduplicate results by. E.g., \'_internal.document_id\' to collapse chunks from the same parent document.
+     * @type {string}
+     * @memberof StageDefsQueryPreprocessing
+     */
+    'dedup_field'?: string;
+}
+//# sourceMappingURL=stage-defs-query-preprocessing.d.ts.map

package/dist/models/stage-defs-query-preprocessing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage-defs-query-preprocessing.d.ts","sourceRoot":"","sources":["../../models/stage-defs-query-preprocessing.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;IACnC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B"}

package/dist/models/stage-defs-rate-limit-config.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Rate limiting configuration.
+ * @export
+ * @interface StageDefsRateLimitConfig
+ */
+export interface StageDefsRateLimitConfig {
+    /**
+     * Maximum requests per minute per domain
+     * @type {number}
+     * @memberof StageDefsRateLimitConfig
+     */
+    'requests_per_minute'?: number;
+    /**
+     * Maximum requests per hour per domain
+     * @type {number}
+     * @memberof StageDefsRateLimitConfig
+     */
+    'requests_per_hour'?: number;
+}
+//# sourceMappingURL=stage-defs-rate-limit-config.d.ts.map

package/dist/models/stage-defs-rate-limit-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage-defs-rate-limit-config.d.ts","sourceRoot":"","sources":["../../models/stage-defs-rate-limit-config.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAChC"}

package/dist/models/stage-defs-result-handling.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * How to handle multiple result rows from SQL query.  Values:     FIRST: Return only the first row (most common for lookups)         - Use when expecting single result (lookup by primary key)         - Result stored as object      ALL: Return all rows as array         - Use when query may return multiple matches         - Result stored as array of objects      ERROR_IF_EMPTY: Raise error if no rows returned         - Use when result is mandatory         - Fails enrichment if query returns nothing      ERROR_IF_MULTIPLE: Raise error if more than one row returned         - Use for strict single-result lookups         - Validates uniqueness constraint at runtime
+ * @export
+ * @enum {string}
+ */
+export declare const StageDefsResultHandling: {
+    readonly First: "first";
+    readonly All: "all";
+    readonly ErrorIfEmpty: "error_if_empty";
+    readonly ErrorIfMultiple: "error_if_multiple";
+};
+export type StageDefsResultHandling = typeof StageDefsResultHandling[keyof typeof StageDefsResultHandling];
+//# sourceMappingURL=stage-defs-result-handling.d.ts.map

package/dist/models/stage-defs-result-handling.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage-defs-result-handling.d.ts","sourceRoot":"","sources":["../../models/stage-defs-result-handling.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AAEH,eAAO,MAAM,uBAAuB;;;;;CAK1B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAC,MAAM,OAAO,uBAAuB,CAAC,CAAC"}

package/dist/models/stage-defs-sort-direction.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Sort direction options.
+ * @export
+ * @enum {string}
+ */
+export declare const StageDefsSortDirection: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type StageDefsSortDirection = typeof StageDefsSortDirection[keyof typeof StageDefsSortDirection];
+//# sourceMappingURL=stage-defs-sort-direction.d.ts.map

package/dist/models/stage-defs-sort-direction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage-defs-sort-direction.d.ts","sourceRoot":"","sources":["../../models/stage-defs-sort-direction.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AAEH,eAAO,MAAM,sBAAsB;;;CAGzB,CAAC;AAEX,MAAM,MAAM,sBAAsB,GAAG,OAAO,sBAAsB,CAAC,MAAM,OAAO,sBAAsB,CAAC,CAAC"}

package/dist/models/stage-defs-stage-cache-behavior.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Cache behavior modes for retriever stages.  Controls internal caching of stage operations for performance optimization. All modes are safe and automatic with LRU eviction - no manual cache management needed.  Values:     AUTO: Smart automatic caching (default, recommended)     DISABLED: Skip internal caching completely     AGGRESSIVE: Cache even non-deterministic operations (use with caution)  Cache Architecture:     - Redis with LRU eviction policy (memory-bounded)     - Namespace-isolated per organization (multi-tenant safe)     - Stage-specific keyspaces prevent conflicts     - Cache keys hash (stage_name, inputs, parameters)     - Automatic invalidation on parameter changes  Performance Impact:     - AUTO: 50-90% latency reduction for repeated operations     - Cache lookup overhead: <5ms     - Hit rates: Typically 60-80% in production  When to Use Each Mode:     AUTO (default):         - Deterministic transformations (parsing, formatting, reshaping)         - Stable external API calls (embeddings, standard inference)         - Operations without side effects         - Most use cases - this is the recommended default      DISABLED:         - Templates with now(), random(), or time-sensitive functions         - External APIs that must be called every time (real-time data)         - Operations with side effects         - Rapidly changing data where caching would serve stale results      AGGRESSIVE:         - When you fully understand caching implications         - For debugging or testing cache behavior         - Only use if you know cache invalidation is handled elsewhere         - Generally not recommended for production  Examples:     Basic usage (auto mode, no config needed):         {\"cache_behavior\": \"auto\"}  # or omit - this is the default      Disable for time-sensitive operations:         {\"cache_behavior\": \"disabled\"}  # Template has {{now()}}      With custom TTL:         {\"cache_behavior\": \"auto\", \"cache_ttl_seconds\": 300}
+ * @export
+ * @enum {string}
+ */
+export declare const StageDefsStageCacheBehavior: {
+    readonly Auto: "auto";
+    readonly Disabled: "disabled";
+    readonly Aggressive: "aggressive";
+};
+export type StageDefsStageCacheBehavior = typeof StageDefsStageCacheBehavior[keyof typeof StageDefsStageCacheBehavior];
+//# sourceMappingURL=stage-defs-stage-cache-behavior.d.ts.map

package/dist/models/stage-defs-stage-cache-behavior.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage-defs-stage-cache-behavior.d.ts","sourceRoot":"","sources":["../../models/stage-defs-stage-cache-behavior.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AAEH,eAAO,MAAM,2BAA2B;;;;CAI9B,CAAC;AAEX,MAAM,MAAM,2BAA2B,GAAG,OAAO,2BAA2B,CAAC,MAAM,OAAO,2BAA2B,CAAC,CAAC"}

package/dist/models/stage-defs-text-query-input.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Text-based query input for text embedding search.  Plain text is always treated as literal text, even if it looks like a URL. Perfect for searching text that happens to contain URLs or special characters.  Use Cases:     - Semantic text search     - Question answering     - Document search by description     - Template-based text queries  Examples:     Simple text:         ```json         {\"input_mode\": \"text\", \"value\": \"machine learning best practices\"}         ```      Template-based:         ```json         {\"input_mode\": \"text\", \"value\": \"{{INPUT.user_query}}\"}         ```      Legacy syntax (backward compatible):         ```json         {\"input_mode\": \"text\", \"text\": \"machine learning\"}         ```
+ * @export
+ * @interface StageDefsTextQueryInput
+ */
+export interface StageDefsTextQueryInput {
+    /**
+     * Discriminator field. Always \'text\' for text-based queries.
+     * @type {string}
+     * @memberof StageDefsTextQueryInput
+     */
+    'input_mode'?: StageDefsTextQueryInputInputModeEnum;
+    /**
+     * Plain text query string (RECOMMENDED). Always treated as literal text for embedding, even if it looks like a URL. Supports template variables: {{INPUT.field_name}}. Empty strings are allowed (creates zero vector for optional inputs).
+     * @type {string}
+     * @memberof StageDefsTextQueryInput
+     */
+    'value'?: string;
+    /**
+     * Legacy text field (DEPRECATED - use \'value\' instead). Supports template variables: {{INPUT.field_name}}.
+     * @type {string}
+     * @memberof StageDefsTextQueryInput
+     */
+    'text'?: string;
+}
+export declare const StageDefsTextQueryInputInputModeEnum: {
+    readonly Text: "text";
+};
+export type StageDefsTextQueryInputInputModeEnum = typeof StageDefsTextQueryInputInputModeEnum[keyof typeof StageDefsTextQueryInputInputModeEnum];
+//# sourceMappingURL=stage-defs-text-query-input.d.ts.map

package/dist/models/stage-defs-text-query-input.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage-defs-text-query-input.d.ts","sourceRoot":"","sources":["../../models/stage-defs-text-query-input.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC;;;;OAIG;IACH,YAAY,CAAC,EAAE,oCAAoC,CAAC;IACpD;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,eAAO,MAAM,oCAAoC;;CAEvC,CAAC;AAEX,MAAM,MAAM,oCAAoC,GAAG,OAAO,oCAAoC,CAAC,MAAM,OAAO,oCAAoC,CAAC,CAAC"}

package/dist/models/stage-defs-urlpatterns.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * URL pattern filters for crawling.  Used to include or exclude specific URL patterns when crawling. Patterns are Python regular expressions.
+ * @export
+ * @interface StageDefsURLPatterns
+ */
+export interface StageDefsURLPatterns {
+    /**
+     * Regex patterns for URLs to include. If provided, URLs must match at least one pattern to be crawled. If empty, all URLs (subject to other filters) are included. Example: [\'/blog/.*\', \'/docs/.*\']
+     * @type {Array<string>}
+     * @memberof StageDefsURLPatterns
+     */
+    'include'?: Array<string>;
+    /**
+     * Regex patterns for URLs to exclude. URLs matching any pattern are skipped. Applied after include patterns. Example: [\'/login\', \'/admin/.*\', \'\\\\?.*\']
+     * @type {Array<string>}
+     * @memberof StageDefsURLPatterns
+     */
+    'exclude'?: Array<string>;
+}
+//# sourceMappingURL=stage-defs-urlpatterns.d.ts.map

package/dist/models/stage-defs-urlpatterns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage-defs-urlpatterns.d.ts","sourceRoot":"","sources":["../../models/stage-defs-urlpatterns.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC7B"}

package/dist/models/stage-defs-vector-query-input.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Value2 } from './value2';
+/**
+ * Raw embedding vector query input for direct vector similarity search.  Accepts a pre-computed embedding vector and uses it directly for similarity search without any inference. Useful for programmatic use cases such as taxonomy enrichment where embeddings are already available.  Use Cases:     - Taxonomy enrichment (passing pre-computed document embeddings)     - Programmatic similarity search with known vectors     - Cross-collection matching with pre-extracted features     - ColBERT/multi-vector search with pre-computed token embeddings  Examples:     Single dense vector:         ```json         {\"input_mode\": \"vector\", \"value\": [0.1, 0.2, 0.3, ...]}         ```      Multi-dense vector (ColBERT — list of token embeddings):         ```json         {\"input_mode\": \"vector\", \"value\": [[0.1, 0.2], [0.3, 0.4], ...]}         ```      Template-based (from taxonomy input mapping):         ```json         {\"input_mode\": \"vector\", \"value\": \"{{INPUT.query_image}}\"}         ```
+ * @export
+ * @interface StageDefsVectorQueryInput
+ */
+export interface StageDefsVectorQueryInput {
+    /**
+     * Discriminator field. Always \'vector\' for raw embedding queries.
+     * @type {string}
+     * @memberof StageDefsVectorQueryInput
+     */
+    'input_mode'?: StageDefsVectorQueryInputInputModeEnum;
+    /**
+     *
+     * @type {Value2}
+     * @memberof StageDefsVectorQueryInput
+     */
+    'value'?: Value2;
+}
+export declare const StageDefsVectorQueryInputInputModeEnum: {
+    readonly Vector: "vector";
+};
+export type StageDefsVectorQueryInputInputModeEnum = typeof StageDefsVectorQueryInputInputModeEnum[keyof typeof StageDefsVectorQueryInputInputModeEnum];
+//# sourceMappingURL=stage-defs-vector-query-input.d.ts.map

package/dist/models/stage-defs-vector-query-input.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage-defs-vector-query-input.d.ts","sourceRoot":"","sources":["../../models/stage-defs-vector-query-input.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACtC;;;;OAIG;IACH,YAAY,CAAC,EAAE,sCAAsC,CAAC;IACtD;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,eAAO,MAAM,sCAAsC;;CAEzC,CAAC;AAEX,MAAM,MAAM,sCAAsC,GAAG,OAAO,sCAAsC,CAAC,MAAM,OAAO,sCAAsC,CAAC,CAAC"}

package/dist/models/stage-discovery.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Extended stage discovery information with examples.  Includes everything from RetrieverStageDefinition plus usage examples and common patterns.
+ * @export
+ * @interface StageDiscovery
+ */
+export interface StageDiscovery {
+    /**
+     * Unique identifier for the stage
+     * @type {string}
+     * @memberof StageDiscovery
+     */
+    'stage_id': string;
+    /**
+     * Human-readable description of stage behavior
+     * @type {string}
+     * @memberof StageDiscovery
+     */
+    'description': string;
+    /**
+     * Transformation category: filter, sort, reduce, apply, enrich
+     * @type {string}
+     * @memberof StageDiscovery
+     */
+    'category': string;
+    /**
+     * Lucide React icon identifier
+     * @type {string}
+     * @memberof StageDiscovery
+     */
+    'icon': string;
+    /**
+     * JSON Schema for stage parameters
+     * @type {{ [key: string]: any; }}
+     * @memberof StageDiscovery
+     */
+    'parameter_schema'?: {
+        [key: string]: any;
+    };
+    /**
+     * Example stage configuration
+     * @type {{ [key: string]: any; }}
+     * @memberof StageDiscovery
+     */
+    'example_config'?: {
+        [key: string]: any;
+    };
+    /**
+     * Common scenarios where this stage is useful
+     * @type {Array<string>}
+     * @memberof StageDiscovery
+     */
+    'common_use_cases'?: Array<string>;
+    /**
+     * Relative cost tier: cheap, moderate, expensive
+     * @type {string}
+     * @memberof StageDiscovery
+     */
+    'cost_tier'?: string;
+    /**
+     * Whether this stage requires collection access
+     * @type {boolean}
+     * @memberof StageDiscovery
+     */
+    'requires_collections'?: boolean;
+}
+//# sourceMappingURL=stage-discovery.d.ts.map

package/dist/models/stage-discovery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage-discovery.d.ts","sourceRoot":"","sources":["../../models/stage-discovery.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAIH;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,kBAAkB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;IAC7C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;IAC3C;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACnC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;CACpC"}

package/dist/models/stage-instance-config.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { LogicalOperatorInput } from './logical-operator-input';
+import type { StagePerformanceInput } from './stage-performance-input';
+/**
+ * User-provided configuration for a stage instance in a retriever pipeline.  This model is used when creating a retriever to define the specific parameters for each stage.
+ * @export
+ * @interface StageInstanceConfig
+ */
+export interface StageInstanceConfig {
+    /**
+     *
+     * @type {string}
+     * @memberof StageInstanceConfig
+     */
+    'stage_name': string;
+    /**
+     * Stage implementation ID (overrides stage_name for lookups)
+     * @type {string}
+     * @memberof StageInstanceConfig
+     */
+    'stage_id'?: string;
+    /**
+     * Stage parameters
+     * @type {{ [key: string]: any; }}
+     * @memberof StageInstanceConfig
+     */
+    'parameters'?: {
+        [key: string]: any;
+    };
+    /**
+     * Filters to apply to the documents *before* this stage is executed.These filters are combined with any global retriever filters.
+     * @type {LogicalOperatorInput}
+     * @memberof StageInstanceConfig
+     */
+    'pre_filters'?: LogicalOperatorInput;
+    /**
+     * Filters to apply to the documents *after* this stage is executed.These filters are applied to the results of this stage before passing to the next.
+     * @type {LogicalOperatorInput}
+     * @memberof StageInstanceConfig
+     */
+    'post_filters'?: LogicalOperatorInput;
+    /**
+     * Performance statistics for this stage
+     * @type {StagePerformanceInput}
+     * @memberof StageInstanceConfig
+     */
+    'stats'?: StagePerformanceInput;
+}
+//# sourceMappingURL=stage-instance-config.d.ts.map

package/dist/models/stage-instance-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage-instance-config.d.ts","sourceRoot":"","sources":["../../models/stage-instance-config.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAGrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAEvE;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,YAAY,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;IACvC;;;;OAIG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;IACrC;;;;OAIG;IACH,cAAc,CAAC,EAAE,oBAAoB,CAAC;IACtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACnC"}

package/dist/models/stage-params-aggregate.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { StageDefsAggregationOperation } from './stage-defs-aggregation-operation';
+import type { StageDefsGroupByFieldConfig } from './stage-defs-group-by-field-config';
+/**
+ * Configuration for the aggregate REDUCE stage.  ┌─────────────────────────────────────────────────────────────────────────────┐ │ Stage Category: REDUCE                                                      │ │                                                                             │ │ Transformation: N documents → M aggregation results                         │ │                                                                             │ │ This stage operates on IN-MEMORY pipeline results, NOT the database.        │ │ Use this for analytics on already-retrieved documents.                      │ └─────────────────────────────────────────────────────────────────────────────┘  Purpose:     Compute aggregations (counts, sums, averages, etc.) on pipeline results.     Useful for analytics, summaries, and metadata extraction from search results.  When to Use:     - Compute statistics on retrieved documents (avg score, total count)     - Group results by a field and count per group     - Extract summary metrics for display (e.g., \"45 results in 3 categories\")     - Post-search analytics that don\'t need database queries  When NOT to Use:     - For faceted search (use feature_search.facets instead - queries Qdrant)     - For full-collection analytics (use aggregation API directly)     - The aggregate stage only sees pipeline results, not full filtered dataset  Performance:     - Fast: In-memory Python operations on already-fetched documents     - No database queries     - Suitable for up to ~10K documents  Common Pipeline Position:     FILTER → SORT → REDUCE (this stage)  Example Use Cases:     - \"Show average relevance score of top 100 results\"     - \"Count results per category from search results\"     - \"Get min/max prices from product search\"     - \"List unique authors in search results\"
+ * @export
+ * @interface StageParamsAggregate
+ */
+export interface StageParamsAggregate {
+    /**
+     * List of aggregation operations to compute. At least one aggregation is required. Multiple aggregations can be computed in a single stage.
+     * @type {Array<StageDefsAggregationOperation>}
+     * @memberof StageParamsAggregate
+     */
+    'aggregations'?: Array<StageDefsAggregationOperation>;
+    /**
+     * OPTIONAL. Fields to group by before aggregating. When specified, aggregations are computed per-group. When None, aggregations are computed across all documents (global). Multiple fields create composite groups (e.g., category + year).
+     * @type {Array<StageDefsGroupByFieldConfig>}
+     * @memberof StageParamsAggregate
+     */
+    'group_by'?: Array<StageDefsGroupByFieldConfig>;
+    /**
+     * OPTIONAL. Metric alias to sort aggregation results by. Must match an alias from the aggregations list. Only applies when group_by is specified.
+     * @type {string}
+     * @memberof StageParamsAggregate
+     */
+    'sort_by'?: string;
+    /**
+     * OPTIONAL. Sort order for aggregation results. \'desc\': Highest values first (default). \'asc\': Lowest values first.
+     * @type {string}
+     * @memberof StageParamsAggregate
+     */
+    'sort_order'?: StageParamsAggregateSortOrderEnum;
+    /**
+     * OPTIONAL. Maximum number of aggregation results to return. Only applies when group_by is specified. Useful for \'top N\' queries (e.g., top 10 categories by count).
+     * @type {number}
+     * @memberof StageParamsAggregate
+     */
+    'limit'?: number;
+    /**
+     * OPTIONAL. Whether to include the original documents in output. False (default): Only return aggregation results in metadata. True: Pass through documents and add aggregation results to metadata. Set to True when aggregations are supplementary to search results.
+     * @type {boolean}
+     * @memberof StageParamsAggregate
+     */
+    'include_documents'?: boolean;
+}
+export declare const StageParamsAggregateSortOrderEnum: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+export type StageParamsAggregateSortOrderEnum = typeof StageParamsAggregateSortOrderEnum[keyof typeof StageParamsAggregateSortOrderEnum];
+//# sourceMappingURL=stage-params-aggregate.d.ts.map

package/dist/models/stage-params-aggregate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage-params-aggregate.d.ts","sourceRoot":"","sources":["../../models/stage-params-aggregate.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AAGxF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oCAAoC,CAAC;AAEtF;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;;OAIG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACtD;;;;OAIG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAChD;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,YAAY,CAAC,EAAE,iCAAiC,CAAC;IACjD;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,eAAO,MAAM,iCAAiC;;;CAGpC,CAAC;AAEX,MAAM,MAAM,iCAAiC,GAAG,OAAO,iCAAiC,CAAC,MAAM,OAAO,iCAAiC,CAAC,CAAC"}

package/dist/models/stage-params-api-call.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { StageDefsAuthConfig } from './stage-defs-auth-config';
+import type { StageDefsErrorHandling } from './stage-defs-error-handling';
+import type { StageDefsLogicalOperator } from './stage-defs-logical-operator';
+import type { StageDefsRateLimitConfig } from './stage-defs-rate-limit-config';
+/**
+ * Configuration for API call enrichment stage.  **Stage Category**: ENRICH (1-1 Enrichment)  **⚠️ CRITICAL SECURITY WARNINGS ⚠️**:  1. **SSRF Risk**: This stage makes external HTTP requests which can be exploited    for Server-Side Request Forgery attacks. ALWAYS use `allowed_domains` allowlist.  2. **Data Exfiltration**: Malicious configurations could send internal data to    external endpoints. Audit all configurations before deployment.  3. **Credential Safety**: NEVER store credentials directly in configuration.    Always use `auth.secret_ref` to reference vault-stored credentials.  4. **Rate Limiting**: Set rate limits to prevent abuse and excessive costs.  5. **Domain Allowlist**: REQUIRED. Explicitly list allowed domains. Never use \"*\".  **Transformation**: N documents → N documents (same count, expanded schema)  **Purpose**: Enriches documents by calling external HTTP APIs. Enables integration with third-party services (Stripe, GitHub, weather APIs, etc.) to augment documents with real-time data. Due to security risks, this stage implements strict controls including domain allowlisting, SSRF protection, rate limiting, and secure credential management.  **When to Use**:     - Enrich documents with data from external APIs     - Integrate third-party services (Stripe, GitHub, Salesforce)     - Fetch real-time data (weather, stocks, currency rates)     - Validate data against external systems     - Lookup additional context from APIs  **When NOT to Use**:     - For untrusted/user-provided URLs (major security risk)     - When API credentials can\'t be securely stored     - For high-volume enrichment (rate limits apply)     - When response time is critical (network latency)     - For internal-only APIs behind firewalls  Requirements:     - url: REQUIRED, API endpoint URL (supports templates)     - allowed_domains: REQUIRED, domain allowlist (NEVER use \"*\")     - method: OPTIONAL, HTTP method (default: GET)     - auth: OPTIONAL, authentication configuration     - headers: OPTIONAL, additional headers     - body: OPTIONAL, request body (for POST/PUT)     - output_field: REQUIRED, where to store response     - timeout: OPTIONAL, request timeout (default: 10s)     - max_response_size: OPTIONAL, max response size (default: 10MB)     - when: OPTIONAL, conditional enrichment filter     - on_error: OPTIONAL, error handling (skip/remove/raise)  Use Cases:     - Stripe customer lookup: Enrich with billing data     - GitHub repo info: Fetch commit stats     - Weather API: Add location-based weather     - Currency conversion: Real-time exchange rates     - Address validation: Verify and standardize addresses
+ * @export
+ * @interface StageParamsApiCall
+ */
+export interface StageParamsApiCall {
+    /**
+     * API endpoint URL to call. Supports template variables: {INPUT.field}, {DOC.field}. Must be HTTP/HTTPS. Domain must be in allowed_domains list. Default uses httpbin.org for testing. Examples: \'https://api.stripe.com/v1/customers/{DOC.metadata.customer_id}\'
+     * @type {string}
+     * @memberof StageParamsApiCall
+     */
+    'url'?: string;
+    /**
+     * Allowlist of domains that can be called. CRITICAL FOR SECURITY - prevents SSRF attacks. Supports wildcards: \'*.example.com\' matches subdomains. NEVER use \'*\' (all domains) in production. Default allows httpbin.org for testing. Examples: [\'api.stripe.com\', \'*.github.com\', \'api.weatherapi.com\']
+     * @type {Array<string>}
+     * @memberof StageParamsApiCall
+     */
+    'allowed_domains'?: Array<string>;
+    /**
+     * HTTP method: GET, POST, PUT, PATCH, DELETE. Default: GET.
+     * @type {string}
+     * @memberof StageParamsApiCall
+     */
+    'method'?: string;
+    /**
+     * OPTIONAL. Authentication configuration. Uses organization vault for credential storage. See AuthConfig for details.
+     * @type {StageDefsAuthConfig}
+     * @memberof StageParamsApiCall
+     */
+    'auth'?: StageDefsAuthConfig;
+    /**
+     * OPTIONAL. Additional HTTP headers to include. Do NOT include authentication headers here - use \'auth\' field. Supports template variables in values. Example: {\'Content-Type\': \'application/json\', \'X-Custom\': \'{{INPUT.value}}\'}
+     * @type {{ [key: string]: string; }}
+     * @memberof StageParamsApiCall
+     */
+    'headers'?: {
+        [key: string]: string;
+    };
+    /**
+     * OPTIONAL. Request body (for POST/PUT/PATCH). Serialized as JSON. Supports template variables in values. Only used for non-GET requests.
+     * @type {{ [key: string]: any; }}
+     * @memberof StageParamsApiCall
+     */
+    'body'?: {
+        [key: string]: any;
+    };
+    /**
+     * Dot-path where API response should be stored. Creates nested structure if needed. Response stored as-is (JSON object/array/primitive). Example: \'metadata.api_data\'
+     * @type {string}
+     * @memberof StageParamsApiCall
+     */
+    'output_field'?: string;
+    /**
+     * Request timeout in seconds. Range: 1-60. Default: 10.
+     * @type {number}
+     * @memberof StageParamsApiCall
+     */
+    'timeout'?: number;
+    /**
+     * Maximum response size in bytes. Prevents memory exhaustion. Default: 10MB.
+     * @type {number}
+     * @memberof StageParamsApiCall
+     */
+    'max_response_size'?: number;
+    /**
+     * OPTIONAL. Rate limiting configuration per domain.
+     * @type {StageDefsRateLimitConfig}
+     * @memberof StageParamsApiCall
+     */
+    'rate_limit'?: StageDefsRateLimitConfig;
+    /**
+     * OPTIONAL. JSONPath expression to extract specific field from response. If not specified, stores entire response. Examples: \'$.data\', \'$.results[0]\', \'$.customer.email\'
+     * @type {string}
+     * @memberof StageParamsApiCall
+     */
+    'response_path'?: string;
+    /**
+     * OPTIONAL. Conditional filter for selective enrichment. Only documents matching condition will call API. RECOMMENDED for cost/performance optimization.
+     * @type {StageDefsLogicalOperator}
+     * @memberof StageParamsApiCall
+     */
+    'when'?: StageDefsLogicalOperator;
+    /**
+     * Error handling strategy: \'skip\': Pass document through unchanged. \'remove\': Remove failed documents. \'raise\': Halt pipeline on error. Default: \'skip\'.
+     * @type {StageDefsErrorHandling}
+     * @memberof StageParamsApiCall
+     */
+    'on_error'?: StageDefsErrorHandling;
+}
+//# sourceMappingURL=stage-params-api-call.d.ts.map

package/dist/models/stage-params-api-call.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stage-params-api-call.d.ts","sourceRoot":"","sources":["../../models/stage-params-api-call.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAKH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAGpE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAG1E,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAG9E,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAE/E;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B;;;;OAIG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;KAAE,CAAC;IACvC;;;;OAIG;IACH,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KAAE,CAAC;IACjC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,YAAY,CAAC,EAAE,wBAAwB,CAAC;IACxC;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,wBAAwB,CAAC;IAClC;;;;OAIG;IACH,UAAU,CAAC,EAAE,sBAAsB,CAAC;CACvC"}