@exulu/backend 1.48.2 → 1.49.0

package/dist/index.d.cts

@@ -1897,6 +1897,95 @@ declare class MarkdownChunker {
     }[]>;
 }
 
+/**
+ * Python Environment Setup Utility
+ *
+ * Provides functions to set up and validate the Python environment for Exulu backend.
+ * This can be called manually by package consumers or run automatically on install.
+ */
+/**
+ * Options for Python environment setup
+ */
+interface PythonSetupOptions {
+    /**
+     * Package root directory (where @exulu/backend is installed)
+     * @default Auto-detected from package location
+     */
+    packageRoot?: string;
+    /**
+     * Whether to force reinstall even if environment exists
+     * @default false
+     */
+    force?: boolean;
+    /**
+     * Whether to show verbose output
+     * @default false
+     */
+    verbose?: boolean;
+    /**
+     * Timeout for setup process in milliseconds
+     * @default 600000 (10 minutes)
+     */
+    timeout?: number;
+}
+/**
+ * Result of Python environment setup
+ */
+interface PythonSetupResult {
+    /** Whether setup was successful */
+    success: boolean;
+    /** Message describing the result */
+    message: string;
+    /** Whether the environment already existed */
+    alreadyExists: boolean;
+    /** Python version installed */
+    pythonVersion?: string;
+    /** Full output from setup script */
+    output?: string;
+}
+/**
+ * Check if Python environment is already set up
+ */
+declare function isPythonEnvironmentSetup(packageRoot?: string): boolean;
+/**
+ * Set up the Python environment by running the setup script
+ *
+ * @param options - Setup configuration options
+ * @returns Result of the setup operation
+ *
+ * @example
+ * ```typescript
+ * import { setupPythonEnvironment } from '@exulu/backend';
+ *
+ * // Basic usage
+ * const result = await setupPythonEnvironment();
+ * if (result.success) {
+ *   console.log('Python environment ready!');
+ * }
+ *
+ * // With options
+ * const result = await setupPythonEnvironment({
+ *   force: true,
+ *   verbose: true
+ * });
+ * ```
+ */
+declare function setupPythonEnvironment(options?: PythonSetupOptions): Promise<PythonSetupResult>;
+/**
+ * Get helpful setup instructions for users
+ */
+declare function getPythonSetupInstructions(): string;
+/**
+ * Validate Python environment and provide helpful error messages
+ *
+ * @param packageRoot - Package root directory
+ * @returns Object with validation status and message
+ */
+declare function validatePythonEnvironment(packageRoot?: string): Promise<{
+    valid: boolean;
+    message: string;
+}>;
+
 type DocumentProcessorConfig = {
     vlm?: {
         model: LanguageModel;
@@ -2011,5 +2100,11 @@ declare const ExuluChunkers: {
         rules: typeof RecursiveRules;
     };
 };
+declare const ExuluPython: {
+    setup: typeof setupPythonEnvironment;
+    check: typeof isPythonEnvironmentSetup;
+    validate: typeof validatePythonEnvironment;
+    instructions: typeof getPythonSetupInstructions;
+};
 
-export { type JOB_STATUS as EXULU_JOB_STATUS, JOB_STATUS_ENUM as EXULU_JOB_STATUS_ENUM, type STATISTICS_TYPE as EXULU_STATISTICS_TYPE, STATISTICS_TYPE_ENUM as EXULU_STATISTICS_TYPE_ENUM, type ExuluAgent, ExuluApp, ExuluAuthentication, ExuluChunkers, ExuluContext, ExuluDatabase, ExuluDefaultProviders, ExuluDocumentProcessor, ExuluEmbedder, ExuluEval, type Item as ExuluItem, ExuluJobs, ExuluOtel, ExuluProvider, queues as ExuluQueues, ExuluReranker, ExuluTool, ExuluVariables };
+export { type JOB_STATUS as EXULU_JOB_STATUS, JOB_STATUS_ENUM as EXULU_JOB_STATUS_ENUM, type STATISTICS_TYPE as EXULU_STATISTICS_TYPE, STATISTICS_TYPE_ENUM as EXULU_STATISTICS_TYPE_ENUM, type ExuluAgent, ExuluApp, ExuluAuthentication, ExuluChunkers, ExuluContext, ExuluDatabase, ExuluDefaultProviders, ExuluDocumentProcessor, ExuluEmbedder, ExuluEval, type Item as ExuluItem, ExuluJobs, ExuluOtel, ExuluProvider, ExuluPython, queues as ExuluQueues, ExuluReranker, ExuluTool, ExuluVariables };

package/dist/index.d.ts

@@ -1897,6 +1897,95 @@ declare class MarkdownChunker {
     }[]>;
 }
 
+/**
+ * Python Environment Setup Utility
+ *
+ * Provides functions to set up and validate the Python environment for Exulu backend.
+ * This can be called manually by package consumers or run automatically on install.
+ */
+/**
+ * Options for Python environment setup
+ */
+interface PythonSetupOptions {
+    /**
+     * Package root directory (where @exulu/backend is installed)
+     * @default Auto-detected from package location
+     */
+    packageRoot?: string;
+    /**
+     * Whether to force reinstall even if environment exists
+     * @default false
+     */
+    force?: boolean;
+    /**
+     * Whether to show verbose output
+     * @default false
+     */
+    verbose?: boolean;
+    /**
+     * Timeout for setup process in milliseconds
+     * @default 600000 (10 minutes)
+     */
+    timeout?: number;
+}
+/**
+ * Result of Python environment setup
+ */
+interface PythonSetupResult {
+    /** Whether setup was successful */
+    success: boolean;
+    /** Message describing the result */
+    message: string;
+    /** Whether the environment already existed */
+    alreadyExists: boolean;
+    /** Python version installed */
+    pythonVersion?: string;
+    /** Full output from setup script */
+    output?: string;
+}
+/**
+ * Check if Python environment is already set up
+ */
+declare function isPythonEnvironmentSetup(packageRoot?: string): boolean;
+/**
+ * Set up the Python environment by running the setup script
+ *
+ * @param options - Setup configuration options
+ * @returns Result of the setup operation
+ *
+ * @example
+ * ```typescript
+ * import { setupPythonEnvironment } from '@exulu/backend';
+ *
+ * // Basic usage
+ * const result = await setupPythonEnvironment();
+ * if (result.success) {
+ *   console.log('Python environment ready!');
+ * }
+ *
+ * // With options
+ * const result = await setupPythonEnvironment({
+ *   force: true,
+ *   verbose: true
+ * });
+ * ```
+ */
+declare function setupPythonEnvironment(options?: PythonSetupOptions): Promise<PythonSetupResult>;
+/**
+ * Get helpful setup instructions for users
+ */
+declare function getPythonSetupInstructions(): string;
+/**
+ * Validate Python environment and provide helpful error messages
+ *
+ * @param packageRoot - Package root directory
+ * @returns Object with validation status and message
+ */
+declare function validatePythonEnvironment(packageRoot?: string): Promise<{
+    valid: boolean;
+    message: string;
+}>;
+
 type DocumentProcessorConfig = {
     vlm?: {
         model: LanguageModel;
@@ -2011,5 +2100,11 @@ declare const ExuluChunkers: {
         rules: typeof RecursiveRules;
     };
 };
+declare const ExuluPython: {
+    setup: typeof setupPythonEnvironment;
+    check: typeof isPythonEnvironmentSetup;
+    validate: typeof validatePythonEnvironment;
+    instructions: typeof getPythonSetupInstructions;
+};
 
-export { type JOB_STATUS as EXULU_JOB_STATUS, JOB_STATUS_ENUM as EXULU_JOB_STATUS_ENUM, type STATISTICS_TYPE as EXULU_STATISTICS_TYPE, STATISTICS_TYPE_ENUM as EXULU_STATISTICS_TYPE_ENUM, type ExuluAgent, ExuluApp, ExuluAuthentication, ExuluChunkers, ExuluContext, ExuluDatabase, ExuluDefaultProviders, ExuluDocumentProcessor, ExuluEmbedder, ExuluEval, type Item as ExuluItem, ExuluJobs, ExuluOtel, ExuluProvider, queues as ExuluQueues, ExuluReranker, ExuluTool, ExuluVariables };
+export { type JOB_STATUS as EXULU_JOB_STATUS, JOB_STATUS_ENUM as EXULU_JOB_STATUS_ENUM, type STATISTICS_TYPE as EXULU_STATISTICS_TYPE, STATISTICS_TYPE_ENUM as EXULU_STATISTICS_TYPE_ENUM, type ExuluAgent, ExuluApp, ExuluAuthentication, ExuluChunkers, ExuluContext, ExuluDatabase, ExuluDefaultProviders, ExuluDocumentProcessor, ExuluEmbedder, ExuluEval, type Item as ExuluItem, ExuluJobs, ExuluOtel, ExuluProvider, ExuluPython, queues as ExuluQueues, ExuluReranker, ExuluTool, ExuluVariables };