aparavi-client 1.0.2

package/dist/types/schema/DocFilter.d.ts

@@ -0,0 +1,101 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Controls how Aparavi searches, processes, and returns documents in your queries.
+ *
+ * Use DocFilter to customize search behavior, pagination, content grouping,
+ * and AI processing options. This gives you fine-grained control over what
+ * documents are returned and how they're processed.
+ */
+export interface DocFilter {
+    /** Combine all chunks from the same table into one result. Useful when you need complete table data rather than individual rows. */
+    fullTables?: boolean;
+    /** Combine all chunks from the same document into one result. Use this when you need complete document content rather than fragments. */
+    fullDocuments?: boolean;
+    /** Skip this many results for pagination. Use with limit to page through large result sets. */
+    offset?: number;
+    /** Maximum number of results to return. Higher numbers give more comprehensive results but slower performance. */
+    limit?: number;
+    /** Only return chunks with ID >= this value. Used for filtering specific document sections. */
+    minChunkId?: number;
+    /** Only return chunks with ID <= this value. Used for filtering specific document sections. */
+    maxChunkId?: number;
+    /** Filter results to documents from a specific Aparavi node/server. Useful in multi-node deployments. */
+    nodeId?: string;
+    /** Filter to documents from a specific parent file or folder path. */
+    parent?: string;
+    /** Filter to documents with names matching this pattern. */
+    name?: string;
+    /** Only return documents the user has these permission levels for. Respects access controls. */
+    permissions?: number[];
+    /** Include (true) or exclude (false) deleted documents. undefined includes both. */
+    isDeleted?: boolean;
+    /** Only return documents with these specific object IDs. Useful for targeted queries. */
+    objectIds?: string[];
+    /** Only return these specific document chunks by ID. */
+    chunkIds?: number[];
+    /** Filter to only table data (true) or exclude tables (false). undefined includes both. */
+    isTable?: boolean;
+    /** Only return data from these specific table IDs. */
+    tableIds?: number[];
+    /** Use AI to rerank results for better relevance. Improves quality but adds processing time. */
+    useQuickRank?: boolean;
+    /** Use AI to rank groups of related documents. Useful for finding the best document among similar ones. */
+    useGroupRank?: boolean;
+    /** Number of follow-up questions to generate for AI chat. Helps users explore topics further. */
+    followUpQuestions?: number;
+    /** Include additional context information with search results. Useful for understanding document relationships. */
+    context?: boolean;
+}
+export declare class DocFilterHelper {
+    /**
+     * Create a default DocFilter with sensible defaults.
+     */
+    static createDefault(): DocFilter;
+    /**
+     * Create a DocFilter for paginated table results.
+     */
+    static forTables(limit?: number, offset?: number): DocFilter;
+    /**
+     * Create a DocFilter for complete documents.
+     */
+    static forFullDocuments(limit?: number): DocFilter;
+    /**
+     * Create a DocFilter with AI enhancements enabled.
+     */
+    static withAIEnhancements(): DocFilter;
+    /**
+     * Validate that a DocFilter has reasonable values.
+     */
+    static validate(filter: DocFilter): string[];
+    /**
+     * Convert DocFilter to dictionary for serialization.
+     */
+    static toDict(filter: DocFilter): Record<string, any>;
+    /**
+     * Create DocFilter from dictionary.
+     */
+    static fromDict(data: Record<string, any>): DocFilter;
+}
+//# sourceMappingURL=DocFilter.d.ts.map

package/dist/types/schema/DocFilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocFilter.d.ts","sourceRoot":"","sources":["../../../aparavi-client/src/schema/DocFilter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;GAMG;AACH,MAAM,WAAW,SAAS;IACzB,oIAAoI;IACpI,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB,yIAAyI;IACzI,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB,+FAA+F;IAC/F,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,kHAAkH;IAClH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,+FAA+F;IAC/F,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,+FAA+F;IAC/F,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,yGAAyG;IACzG,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,4DAA4D;IAC5D,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,gGAAgG;IAChG,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB,oFAAoF;IACpF,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,yFAAyF;IACzF,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB,2FAA2F;IAC3F,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpB,gGAAgG;IAChG,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,2GAA2G;IAC3G,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,iGAAiG;IACjG,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,mHAAmH;IACnH,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,qBAAa,eAAe;IAC3B;;OAEG;IACH,MAAM,CAAC,aAAa,IAAI,SAAS;IAajC;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,SAAS;IAWnD;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,KAAK,SAAK,GAAG,SAAS;IAQ9C;;OAEG;IACH,MAAM,CAAC,kBAAkB,IAAI,SAAS;IAStC;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,EAAE;IAkB5C;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAYrD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS;CAuBrD"}

package/dist/types/schema/DocGroup.d.ts

@@ -0,0 +1,113 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { Doc } from './Doc';
+/**
+ * Groups related document chunks that come from the same source file.
+ *
+ * When you search Aparavi and multiple chunks are found from the same document,
+ * they can be organized into DocGroups for easier processing. This helps you
+ * understand which content comes from which files and work with complete documents
+ * rather than scattered fragments.
+ */
+export interface DocGroup {
+    /** Overall relevance score for this entire document/file. Higher scores indicate the file is more relevant to your query. */
+    score: number;
+    /** Unique identifier for this document object in the Aparavi system. */
+    objectId: string;
+    /** File path or name of the source document. This is typically the filename you would recognize. */
+    parent: string;
+    /** List of all document chunks from this file that matched your query. */
+    documents: Doc[];
+}
+export declare class DocGroupHelper {
+    /**
+     * Create a readable string representation showing the filename and relevance score.
+     */
+    static toString(group: DocGroup): string;
+    /**
+     * Create a new DocGroup.
+     */
+    static create(objectId: string, parent: string, documents?: Doc[], score?: number): DocGroup;
+    /**
+     * Add a document to the group and update the score.
+     */
+    static addDocument(group: DocGroup, doc: Doc): DocGroup;
+    /**
+     * Get the total content from all documents in the group.
+     */
+    static getFullContent(group: DocGroup): string;
+    /**
+     * Get the highest scoring document in the group.
+     */
+    static getBestDocument(group: DocGroup): Doc | undefined;
+    /**
+     * Sort documents in the group by score (highest first) or chunk ID.
+     */
+    static sortDocuments(group: DocGroup, sortBy?: 'score' | 'chunkId'): DocGroup;
+    /**
+     * Filter documents in the group by score threshold.
+     */
+    static filterByScore(group: DocGroup, minScore: number): DocGroup;
+    /**
+     * Get document count in the group.
+     */
+    static getDocumentCount(group: DocGroup): number;
+    /**
+     * Get total tokens count for all documents in the group.
+     */
+    static getTotalTokens(group: DocGroup): number;
+    /**
+     * Get average score of documents in the group.
+     */
+    static getAverageScore(group: DocGroup): number;
+    /**
+     * Check if group contains table data.
+     */
+    static hasTableData(group: DocGroup): boolean;
+    /**
+     * Get only table documents from the group.
+     */
+    static getTableDocuments(group: DocGroup): Doc[];
+    /**
+     * Get only text documents from the group.
+     */
+    static getTextDocuments(group: DocGroup): Doc[];
+    /**
+     * Convert DocGroup to dictionary for serialization.
+     */
+    static toDict(group: DocGroup): Record<string, any>;
+    /**
+     * Create DocGroup from dictionary.
+     */
+    static fromDict(data: Record<string, any>): DocGroup;
+    /**
+     * Merge multiple DocGroups from the same source document.
+     */
+    static merge(groups: DocGroup[]): DocGroup | undefined;
+    /**
+     * Split a DocGroup into smaller groups by chunk ranges.
+     */
+    static splitByChunkRange(group: DocGroup, chunkSize: number): DocGroup[];
+}
+//# sourceMappingURL=DocGroup.d.ts.map

package/dist/types/schema/DocGroup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocGroup.d.ts","sourceRoot":"","sources":["../../../aparavi-client/src/schema/DocGroup.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAE5B;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACxB,6HAA6H;IAC7H,KAAK,EAAE,MAAM,CAAC;IAEd,wEAAwE;IACxE,QAAQ,EAAE,MAAM,CAAC;IAEjB,oGAAoG;IACpG,MAAM,EAAE,MAAM,CAAC;IAEf,0EAA0E;IAC1E,SAAS,EAAE,GAAG,EAAE,CAAC;CACjB;AAED,qBAAa,cAAc;IAC1B;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;IAKxC;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,GAAE,GAAG,EAAO,EAAE,KAAK,SAAI,GAAG,QAAQ;IAS3F;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,GAAG,QAAQ;IAavD;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;IAM9C;;OAEG;IACH,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,QAAQ,GAAG,GAAG,GAAG,SAAS;IAYxD;;OAEG;IACH,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,GAAE,OAAO,GAAG,SAAmB,GAAG,QAAQ;IAmBtF;;OAEG;IACH,MAAM,CAAC,aAAa,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,GAAG,QAAQ;IASjE;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;IAIhD;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;IAI9C;;OAEG;IACH,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM;IAS/C;;OAEG;IACH,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO;IAI7C;;OAEG;IACH,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,QAAQ,GAAG,GAAG,EAAE;IAIhD;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,KAAK,EAAE,QAAQ,GAAG,GAAG,EAAE;IAI/C;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAenD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,QAAQ;IAepD;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,GAAG,QAAQ,GAAG,SAAS;IA+BtD;;OAEG;IACH,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,GAAG,QAAQ,EAAE;CAsBxE"}

package/dist/types/schema/DocMetadata.d.ts

@@ -0,0 +1,61 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Contains information about where a document chunk came from and its properties.
+ *
+ * Every document returned from Aparavi operations includes metadata that tells you
+ * about the source file, the chunk's position within that file, permissions,
+ * and whether it's table data or regular text.
+ */
+export interface DocMetadata {
+    /** Unique identifier for the source document in the Aparavi system. */
+    objectId: string;
+    /** Position of this chunk within the document (0, 1, 2, etc.). */
+    chunkId: number;
+    /** Identifier of the Aparavi node/server where this document is stored. */
+    nodeId?: string;
+    /** File path or name of the source document. This is what you would see in a file browser. */
+    parent?: string;
+    /** Permission level identifier that controls who can access this document. */
+    permissionId?: number;
+    /** True if the source document has been deleted but is still in search results. */
+    isDeleted?: boolean;
+    /** True if this chunk contains structured table data, False for regular text content. */
+    isTable?: boolean;
+    /** If isTable is True, this identifies which table within the document this data came from. */
+    tableId?: number;
+    /** Allow additional fields for extensibility */
+    [key: string]: any;
+}
+export declare class DocMetadataHelper {
+    /**
+     * Convert metadata to a dictionary for serialization or storage.
+     */
+    static toDict(metadata: DocMetadata): Record<string, any>;
+    /**
+     * Create default metadata for a document processing instance.
+     */
+    static defaultMetadata(pInstance: any): DocMetadata;
+}
+//# sourceMappingURL=DocMetadata.d.ts.map

package/dist/types/schema/DocMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocMetadata.d.ts","sourceRoot":"","sources":["../../../aparavi-client/src/schema/DocMetadata.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC3B,uEAAuE;IACvE,QAAQ,EAAE,MAAM,CAAC;IAEjB,kEAAkE;IAClE,OAAO,EAAE,MAAM,CAAC;IAEhB,2EAA2E;IAC3E,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,8FAA8F;IAC9F,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,mFAAmF;IACnF,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,yFAAyF;IACzF,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,+FAA+F;IAC/F,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,gDAAgD;IAChD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACnB;AAED,qBAAa,iBAAiB;IAC7B;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAYzD;;OAEG;IACH,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,GAAG,GAAG,WAAW;CAYnD"}

package/dist/types/schema/Question.d.ts

@@ -0,0 +1,163 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { Doc } from './Doc';
+import { DocFilter } from './DocFilter';
+/**
+ * Defines different types of questions and queries you can ask.
+ */
+export declare enum QuestionType {
+    QUESTION = "question",
+    SEMANTIC = "semantic",
+    KEYWORD = "keyword",
+    GET = "get",
+    PROMPT = "prompt"
+}
+/**
+ * Represents a single message in a chat conversation history.
+ */
+export interface QuestionHistory {
+    /** Who sent this message ('user', 'system', or 'assistant') */
+    role: string;
+    /** The actual message content */
+    content: string;
+}
+/**
+ * Provides specific instructions to guide the AI's response.
+ */
+export interface QuestionInstruction {
+    /** Brief description of what this instruction is about */
+    subtitle: string;
+    /** Detailed guidance for the AI */
+    instructions: string;
+}
+/**
+ * Shows the AI an example of the kind of response you want.
+ */
+export interface QuestionExample {
+    /** Example question or input */
+    given: string;
+    /** Example response you want for that input */
+    result: string;
+}
+/**
+ * Represents a single question with optional AI embeddings.
+ */
+export interface QuestionText {
+    /** The actual question text */
+    text: string;
+    /** AI model used for creating embeddings (if any) */
+    embedding_model?: string;
+    /** Vector representation of the question (if any) */
+    embedding?: number[];
+}
+/**
+ * Handles AI responses from Aparavi chat operations.
+ */
+export declare class Answer {
+    private answer?;
+    private expectJson;
+    constructor(expectJson?: boolean);
+    /**
+     * Parse AI response text into JSON structure.
+     */
+    static parseJson(value: string): any;
+    /**
+     * Extract Python code from AI response.
+     */
+    static parsePython(value: string): string;
+    /**
+     * Set the AI response value (used internally by the system).
+     */
+    setAnswer(value: string | object | any[]): void;
+    /**
+     * Get the response as plain text.
+     */
+    getText(): string;
+    /**
+     * Get the response as structured JSON data.
+     */
+    getJson(): any;
+    /**
+     * Check if this answer contains JSON data.
+     */
+    isJson(): boolean;
+}
+/**
+ * Main class for asking questions to Aparavi's AI system.
+ */
+export declare class Question {
+    type: QuestionType;
+    filter: DocFilter;
+    expectJson: boolean;
+    role: string;
+    instructions: QuestionInstruction[];
+    history: QuestionHistory[];
+    examples: QuestionExample[];
+    context: string[];
+    documents: Doc[];
+    questions: QuestionText[];
+    constructor(options?: {
+        type?: QuestionType;
+        filter?: DocFilter;
+        expectJson?: boolean;
+        role?: string;
+    });
+    /**
+     * Add a custom instruction to guide the AI's response.
+     */
+    addInstruction(title: string, instruction: string): void;
+    /**
+     * Add an example to show the AI the kind of response you want.
+     */
+    addExample(given: string, result: string | object | any[]): void;
+    /**
+     * Add context information to help the AI understand your question better.
+     */
+    addContext(context: string | object | string[] | object[]): void;
+    /**
+     * Add a conversation history item for multi-turn chat.
+     */
+    addHistory(item: QuestionHistory): void;
+    /**
+     * Add a question to ask the AI.
+     */
+    addQuestion(question: string): void;
+    /**
+     * Add specific documents for the AI to reference.
+     */
+    addDocuments(documents: Doc | Doc[]): void;
+    /**
+     * Generate the complete prompt text for the AI (used internally).
+     */
+    getPrompt(hasPreviousJsonFailed?: boolean): string;
+    /**
+     * Convert Question to dictionary for serialization.
+     */
+    toDict(): Record<string, any>;
+    /**
+     * Create Question from dictionary.
+     */
+    static fromDict(data: Record<string, any>): Question;
+}
+//# sourceMappingURL=Question.d.ts.map

package/dist/types/schema/Question.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Question.d.ts","sourceRoot":"","sources":["../../../aparavi-client/src/schema/Question.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;GAEG;AACH,oBAAY,YAAY;IACvB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,GAAG,QAAQ;IACX,MAAM,WAAW;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC;IACb,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,0DAA0D;IAC1D,QAAQ,EAAE,MAAM,CAAC;IACjB,mCAAmC;IACnC,YAAY,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,qDAAqD;IACrD,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED;;GAEG;AACH,qBAAa,MAAM;IAClB,OAAO,CAAC,MAAM,CAAC,CAA0B;IACzC,OAAO,CAAC,UAAU,CAAU;gBAEhB,UAAU,UAAQ;IAI9B;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG;IAmCpC;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAYzC;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,GAAG,EAAE,GAAG,IAAI;IA4B/C;;OAEG;IACH,OAAO,IAAI,MAAM;IAUjB;;OAEG;IACH,OAAO,IAAI,GAAG;IAcd;;OAEG;IACH,MAAM,IAAI,OAAO;CAGjB;AAED;;GAEG;AACH,qBAAa,QAAQ;IACpB,IAAI,EAAE,YAAY,CAAyB;IAC3C,MAAM,EAAE,SAAS,CAAC;IAClB,UAAU,UAAS;IACnB,IAAI,SAAM;IACV,YAAY,EAAE,mBAAmB,EAAE,CAAM;IACzC,OAAO,EAAE,eAAe,EAAE,CAAM;IAChC,QAAQ,EAAE,eAAe,EAAE,CAAM;IACjC,OAAO,EAAE,MAAM,EAAE,CAAM;IACvB,SAAS,EAAE,GAAG,EAAE,CAAM;IACtB,SAAS,EAAE,YAAY,EAAE,CAAM;gBAEnB,OAAO,GAAE;QACpB,IAAI,CAAC,EAAE,YAAY,CAAC;QACpB,MAAM,CAAC,EAAE,SAAS,CAAC;QACnB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;KACT;IAgBN;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI;IAOxD;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,GAAG,EAAE,GAAG,IAAI;IAWhE;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI;IAchE;;OAEG;IACH,UAAU,CAAC,IAAI,EAAE,eAAe,GAAG,IAAI;IAIvC;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAInC;;OAEG;IACH,YAAY,CAAC,SAAS,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,IAAI;IAgB1C;;OAEG;IACH,SAAS,CAAC,qBAAqB,UAAQ,GAAG,MAAM;IAyIhD;;OAEG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAe7B;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,QAAQ;CAiBpD"}

package/dist/types/schema/index.d.ts

@@ -0,0 +1,34 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Schema definitions for Aparavi data structures.
+ *
+ * Re-exports all schema classes and interfaces for convenient imports.
+ */
+export * from './Doc';
+export * from './DocFilter';
+export * from './DocGroup';
+export * from './DocMetadata';
+export * from './Question';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/schema/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../aparavi-client/src/schema/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;GAIG;AAEH,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC"}

package/dist/types/types/client.d.ts

@@ -0,0 +1,140 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2024 Aparavi Development Team
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+/**
+ * Type definitions for Aparavi client configuration and DAP communication.
+ *
+ * This module defines the core types used for client-server communication
+ * including DAP messages, callbacks, configuration options, and transport interfaces.
+ */
+/**
+ * Stack trace information for errors.
+ */
+export interface TraceInfo {
+    /** File path where the error occurred */
+    file: string;
+    /** Line number where the error occurred */
+    lineno: number;
+}
+export interface DAPMessage {
+    /** Message type: request from client, response from server, or event notification */
+    type: 'request' | 'response' | 'event';
+    /** Unique sequence number for message correlation and ordering */
+    seq: number;
+    /** Command name for requests (e.g., 'execute', 'terminate', 'apaext_ping') */
+    command?: string;
+    /** Command arguments and parameters */
+    arguments?: Record<string, any>;
+    /** Response body containing results and data */
+    body?: Record<string, any>;
+    /** Success flag for responses - true if operation succeeded */
+    success?: boolean;
+    /** Error or status message */
+    message?: string;
+    /** Sequence number of the request this response corresponds to */
+    request_seq?: number;
+    /** Event type name for event messages */
+    event?: string;
+    /** Task or pipeline token for operation context */
+    token?: string;
+    /** Binary or text data payload */
+    data?: Uint8Array | string;
+    /** Stack trace information for errors */
+    trace?: TraceInfo;
+}
+/**
+ * Callback functions for transport layer events and debugging.
+ *
+ * These callbacks provide hooks for monitoring transport activity,
+ * debugging protocol messages, and handling connection lifecycle events.
+ */
+export interface TransportCallbacks {
+    /** Called when debug messages are generated */
+    onDebugMessage?: (message: string) => void;
+    /** Called when protocol messages are sent/received for debugging */
+    onDebugProtocol?: (message: string) => void;
+    /** Called when a message is received from the server */
+    onReceive?: (message: DAPMessage) => Promise<void>;
+    /** Called when connection is established */
+    onConnected?: (connectionInfo?: string) => Promise<void>;
+    /** Called when connection is lost or closed */
+    onDisconnected?: (reason?: string, hasError?: boolean) => Promise<void>;
+}
+/**
+ * Connection configuration for establishing server connections.
+ */
+export interface ConnectionInfo {
+    /** Server URI (WebSocket endpoint) */
+    uri: string;
+    /** Authentication token or API key */
+    auth?: string;
+}
+/**
+ * Callback function for handling real-time events from the server.
+ *
+ * Events include pipeline status updates, processing progress,
+ * error notifications, and system alerts.
+ */
+export type EventCallback = (event: DAPMessage) => Promise<void>;
+/**
+ * Callback function for connection establishment events.
+ */
+export type ConnectCallback = (connectionInfo?: string) => Promise<void>;
+/**
+ * Callback function for disconnection events.
+ */
+export type DisconnectCallback = (reason?: string, hasError?: boolean) => Promise<void>;
+/**
+ * Configuration options for creating an AparaviClient instance.
+ *
+ * Provides connection settings, authentication, and event handling
+ * configuration for establishing and managing server connections.
+ */
+export interface AparaviClientConfig {
+    /** API authentication key or token */
+    auth?: string;
+    /** Server URI (will be converted to WebSocket URI automatically) */
+    uri?: string;
+    /**
+     * Environment variables dictionary for configuration and variable substitution.
+     * If not provided, will load from .env file (Node.js only), then fall back to process.env
+     */
+    env?: Record<string, any>;
+    /** Callback for handling real-time events from server */
+    onEvent?: EventCallback;
+    /** Callback for connection establishment */
+    onConnected?: ConnectCallback;
+    /** Callback for disconnection events */
+    onDisconnected?: DisconnectCallback;
+    /** Optional function to output a protocol message */
+    onProtocolMessage?: (message: string) => void;
+    /** Optional function to output a debug message */
+    onDebugMessage?: (message: string) => void;
+    /** Maintain the connection */
+    persist?: boolean;
+    /** Delay before attempting to reconnect */
+    reconnectDelay?: number;
+    /** Client module name for debugging and identification */
+    module?: string;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/types/types/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../aparavi-client/src/types/client.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IAEb,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,UAAU;IAC1B,qFAAqF;IACrF,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC;IAEvC,kEAAkE;IAClE,GAAG,EAAE,MAAM,CAAC;IAEZ,8EAA8E;IAC9E,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,uCAAuC;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEhC,gDAAgD;IAChD,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE3B,+DAA+D;IAC/D,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,kEAAkE;IAClE,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,yCAAyC;IACzC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,mDAAmD;IACnD,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,kCAAkC;IAClC,IAAI,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;IAE3B,yCAAyC;IACzC,KAAK,CAAC,EAAE,SAAS,CAAC;CAClB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IAClC,+CAA+C;IAC/C,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAE3C,oEAAoE;IACpE,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAE5C,wDAAwD;IACxD,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnD,4CAA4C;IAC5C,WAAW,CAAC,EAAE,CAAC,cAAc,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD,+CAA+C;IAC/C,cAAc,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACxE;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,sCAAsC;IACtC,GAAG,EAAE,MAAM,CAAC;IAEZ,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,cAAc,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAExF;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IACnC,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,oEAAoE;IACpE,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE1B,yDAAyD;IACzD,OAAO,CAAC,EAAE,aAAa,CAAC;IAExB,4CAA4C;IAC5C,WAAW,CAAC,EAAE,eAAe,CAAC;IAE9B,wCAAwC;IACxC,cAAc,CAAC,EAAE,kBAAkB,CAAC;IAEpC,qDAAqD;IACrD,iBAAiB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAE9C,kDAAkD;IAClD,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAE3C,8BAA8B;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB,2CAA2C;IAC3C,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB"}