@hydradb/sdk 0.0.3 → 2.0.0

package/dist/api/types/Infra.d.ts

@@ -1,5 +0,0 @@
-export interface Infra {
-    scheduler_status: boolean;
-    graph_status: boolean;
-    vectorstore_status: unknown[];
-}

package/dist/api/types/InfraStatusResponse.d.ts

@@ -1,14 +0,0 @@
-import type * as HydraDB from "../index.js";
-/**
- * Response for deployed infrastructure status checks.
- */
-export interface InfraStatusResponse {
-    /** Tenant identifier when status is queried for a specific tenant */
-    tenant_id?: (string | null) | undefined;
-    /** Organization identifier */
-    org_id: string;
-    /** Deployed infrastructure status */
-    infra: HydraDB.Infra;
-    /** Summary message */
-    message?: string | undefined;
-}

package/dist/api/types/IngestResponse.d.ts

@@ -1,4 +0,0 @@
-export interface IngestResponse {
-    doc_id: string;
-    status?: string | undefined;
-}

package/dist/api/types/InsertResult.d.ts

@@ -1,13 +0,0 @@
-/**
- * Result of an insert operation.
- */
-export interface InsertResult {
-    /** Number of entities inserted */
-    insert_count: number;
-    /** Inserted entity IDs */
-    ids?: string[] | undefined;
-    /** Whether insert succeeded */
-    success?: boolean | undefined;
-    /** Error message if failed */
-    error?: (string | null) | undefined;
-}

package/dist/api/types/ListContentKind.d.ts

@@ -1,5 +0,0 @@
-export declare const ListContentKind: {
-    readonly Knowledge: "knowledge";
-    readonly Memories: "memories";
-};
-export type ListContentKind = (typeof ListContentKind)[keyof typeof ListContentKind];

package/dist/api/types/MemoryItem.d.ts

@@ -1,44 +0,0 @@
-import type * as HydraDB from "../index.js";
-/**
- * Represents a single memory item for ingestion.
- * Supports raw text, markdown, and user/assistant conversation pairs.
- */
-export interface MemoryItem {
-    /** Optional unique identifier. Auto-generated if not provided. */
-    source_id?: (string | null) | undefined;
-    /** Display title for this memory item. */
-    title?: (string | null) | undefined;
-    /** Raw text or markdown content to be indexed. */
-    text?: (string | null) | undefined;
-    /** Array of user/assistant conversation pairs to store as memory. */
-    user_assistant_pairs?: (HydraDB.UserAssistantPair[] | null) | undefined;
-    /** Whether the text is markdown formatted. */
-    is_markdown?: boolean | undefined;
-    /** If true, process and extract additional insights/inferences from the contentbefore indexingUseful for extracting implicit information from conversations */
-    infer?: boolean | undefined;
-    /** Custom instructions to guide inference processing. */
-    custom_instructions?: (string | null) | undefined;
-    /** User's name for personalization in conversation pairs. */
-    user_name?: string | undefined;
-    /** Optional TTL in seconds for this memory. */
-    expiry_time?: (number | null) | undefined;
-    /** Key-value metadata attached to this memory. */
-    metadata?: Record<string, unknown> | undefined;
-    /** Additional key-value metadata for this memory. */
-    additional_metadata?: Record<string, unknown> | undefined;
-    /**
-     * JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
-     *
-     * Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
-     */
-    tenant_metadata?: (string | null) | undefined;
-    /**
-     * JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
-     *
-     * Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
-     *
-     */
-    document_metadata?: (string | null) | undefined;
-    /** Forcefully connect 2 sources based on cortex source ids or common properties. */
-    relations?: (HydraDB.ForcefulRelationsPayload | null) | undefined;
-}

package/dist/api/types/ProcessingStatus.d.ts

@@ -1,26 +0,0 @@
-export interface ProcessingStatus {
-    /** Identifier for the file whose status is being retrieved */
-    file_id: string;
-    /** Current status of the file. Possible values are 'queued', 'processing', 'completed', 'errored', 'graph_creation', 'success'. 'graph_creation' indicates the file is indexed but the knowledge graph is still being created. 'success' is an alias for 'completed'. */
-    indexing_status: ProcessingStatus.IndexingStatus;
-    /** Error code for the file. You may share this code with us to help us diagnose and resolve the issue. */
-    error_code?: string | undefined;
-    /** User-friendly explanation of what went wrong and suggested next steps. Only populated when indexing_status is 'errored'. */
-    error_message?: string | undefined;
-    /** Whether the file was processed successfully. */
-    success?: boolean | undefined;
-    /** Detailed status message about the processing operation */
-    message?: string | undefined;
-}
-export declare namespace ProcessingStatus {
-    /** Current status of the file. Possible values are 'queued', 'processing', 'completed', 'errored', 'graph_creation', 'success'. 'graph_creation' indicates the file is indexed but the knowledge graph is still being created. 'success' is an alias for 'completed'. */
-    const IndexingStatus: {
-        readonly Queued: "queued";
-        readonly Processing: "processing";
-        readonly Completed: "completed";
-        readonly Errored: "errored";
-        readonly GraphCreation: "graph_creation";
-        readonly Success: "success";
-    };
-    type IndexingStatus = (typeof IndexingStatus)[keyof typeof IndexingStatus];
-}

package/dist/api/types/ProcessingStatus.js

@@ -1,16 +0,0 @@
-"use strict";
-// This file was auto-generated by Fern from our API Definition.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProcessingStatus = void 0;
-var ProcessingStatus;
-(function (ProcessingStatus) {
-    /** Current status of the file. Possible values are 'queued', 'processing', 'completed', 'errored', 'graph_creation', 'success'. 'graph_creation' indicates the file is indexed but the knowledge graph is still being created. 'success' is an alias for 'completed'. */
-    ProcessingStatus.IndexingStatus = {
-        Queued: "queued",
-        Processing: "processing",
-        Completed: "completed",
-        Errored: "errored",
-        GraphCreation: "graph_creation",
-        Success: "success",
-    };
-})(ProcessingStatus || (exports.ProcessingStatus = ProcessingStatus = {}));

package/dist/api/types/QnASearchResponse.d.ts

@@ -1,17 +0,0 @@
-import type * as HydraDB from "../index.js";
-/**
- * Response model for the QnA search API.
- */
-export interface QnASearchResponse {
-    success?: boolean | undefined;
-    /** The AI-generated answer based on retrieved context */
-    answer: string;
-    /** Retrieved context chunks used to generate the answer */
-    chunks?: HydraDB.VectorStoreChunk[] | undefined;
-    /** Knowledge graph context (entity paths and chunk relations) */
-    graph_context?: HydraDB.GraphContext | undefined;
-    /** The LLM model used for answer generation */
-    model_used?: (string | null) | undefined;
-    /** Timing information (total_ms) */
-    timing?: Record<string, number> | undefined;
-}

package/dist/api/types/RawEmbeddingDocument.d.ts

@@ -1,16 +0,0 @@
-import type * as HydraDB from "../index.js";
-/**
- * A raw embedding document for direct insert/upsert operations.
- */
-export interface RawEmbeddingDocument {
-    /** Source identifier for the embedding */
-    source_id: string;
-    /** Tenant ID (set by the server) */
-    tenant_id?: string | undefined;
-    /** Sub-tenant ID (set by the server) */
-    sub_tenant_id?: string | undefined;
-    /** Metadata to store */
-    metadata?: Record<string, unknown> | undefined;
-    /** Embedding payloads containing ids and vectors */
-    embeddings: HydraDB.RawEmbeddingVector[];
-}

package/dist/api/types/RawEmbeddingSearchResult.d.ts

@@ -1,16 +0,0 @@
-import type * as HydraDB from "../index.js";
-/**
- * Search result for raw embedding collections.
- */
-export interface RawEmbeddingSearchResult {
-    /** Source identifier */
-    source_id: string;
-    /** Embedding payload with chunk id and vector (if set) */
-    embedding?: (HydraDB.RawEmbeddingVector | null) | undefined;
-    /** Similarity score */
-    score?: number | undefined;
-    /** Vector distance */
-    distance?: number | undefined;
-    /** Metadata associated with the embedding */
-    metadata?: (Record<string, unknown> | null) | undefined;
-}

package/dist/api/types/RawEmbeddingVector.d.ts

@@ -1,9 +0,0 @@
-/**
- * Embedding payload containing the chunk identifier and vector.
- */
-export interface RawEmbeddingVector {
-    /** Primary key / chunk identifier */
-    chunk_id: string;
-    /** Embedding vector */
-    embedding: number[];
-}

package/dist/api/types/RecallSearchRequest.d.ts

@@ -1,34 +0,0 @@
-import type * as HydraDB from "../index.js";
-/**
- * Request body for full recall (sources) and recall preferences (memories).
- */
-export interface RecallSearchRequest {
-    /** Unique identifier for the tenant/organization */
-    tenant_id: string;
-    /** Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used. */
-    sub_tenant_id?: (string | null) | undefined;
-    /** Search terms to find relevant content */
-    query: string;
-    /** Maximum number of results to return */
-    max_results?: (number | null) | undefined;
-    /** Retrieval mode to use ('fast' or 'thinking') */
-    mode?: HydraDB.RetrieveMode | undefined;
-    /** Search ranking algorithm parameter (0.0-1.0 or 'auto') */
-    alpha?: RecallSearchRequest.Alpha | undefined;
-    /** Preference for newer content (0.0 = no bias, 1.0 =             strong recency preference) */
-    recency_bias?: number | undefined;
-    /** Enable graph context for search results */
-    graph_context?: boolean | undefined;
-    /** Whether to search for forceful relations in thinking mode to augment context */
-    search_forceful_relations?: boolean | undefined;
-    /** Additional context provided by the user to guide retrieval */
-    additional_context?: (string | null) | undefined;
-    /** Optional key-value pairs to filter search results by metadata fields. Top-level keys are matched against tenant_metadata and must correspond to fields defined in tenant_metadata_schema during tenant creation. To filter on document_metadata, nest filters under a 'document_metadata' key: {'document_metadata': {'source': 'account_plan'}}. Both filter types support exact match filtering and can be combined. */
-    metadata_filters?: (Record<string, unknown> | null) | undefined;
-}
-export declare namespace RecallSearchRequest {
-    /**
-     * Search ranking algorithm parameter (0.0-1.0 or 'auto')
-     */
-    type Alpha = string | number;
-}

package/dist/api/types/RetrievalResult.d.ts

@@ -1,12 +0,0 @@
-import type * as HydraDB from "../index.js";
-/**
- * Result of a hybrid search retrieval operation.
- */
-export interface RetrievalResult {
-    chunks?: HydraDB.VectorStoreChunk[] | undefined;
-    /** Deduplicated source documents corresponding to the returned chunks */
-    sources?: HydraDB.SourceInfo[] | undefined;
-    graph_context?: HydraDB.GraphContext | undefined;
-    /** Map of chunk_uuid to VectorStoreChunk for extra context from forcefully related sources. Use chunk.extra_context_ids to look up chunks: extra_context[id] for id in chunk.extra_context_ids. */
-    additional_context?: Record<string, HydraDB.VectorStoreChunk> | undefined;
-}

package/dist/api/types/SearchMode.d.ts

@@ -1,6 +0,0 @@
-/** Search mode to specify what type of content to search. */
-export declare const SearchMode: {
-    readonly Sources: "sources";
-    readonly Memories: "memories";
-};
-export type SearchMode = (typeof SearchMode)[keyof typeof SearchMode];

package/dist/api/types/SearchMode.js

@@ -1,9 +0,0 @@
-"use strict";
-// This file was auto-generated by Fern from our API Definition.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SearchMode = void 0;
-/** Search mode to specify what type of content to search. */
-exports.SearchMode = {
-    Sources: "sources",
-    Memories: "memories",
-};

package/dist/api/types/SourceFetchResponse.d.ts

@@ -1,23 +0,0 @@
-/**
- * Response for file fetch request.
- */
-export interface SourceFetchResponse {
-    /** Whether the fetch was successful */
-    success?: boolean | undefined;
-    /** Source ID of the fetched file */
-    source_id: string;
-    /** File content as string (if mode includes 'content') */
-    content?: (string | null) | undefined;
-    /** File content as base64 encoded string (for binary files, if mode includes 'content') */
-    content_base64?: (string | null) | undefined;
-    /** Presigned URL to access the file (if mode includes 'url') */
-    presigned_url?: (string | null) | undefined;
-    /** Content type of the file */
-    content_type?: (string | null) | undefined;
-    /** Size of the file in bytes */
-    size_bytes?: (number | null) | undefined;
-    /** Response message */
-    message?: string | undefined;
-    /** Error message if fetch failed */
-    error?: (string | null) | undefined;
-}

package/dist/api/types/SourceListResponse.d.ts

@@ -1 +0,0 @@
-export type SourceListResponse = unknown;

package/dist/api/types/SourceModel.d.ts

@@ -1,42 +0,0 @@
-import type * as HydraDB from "../index.js";
-export interface SourceModel {
-    /** Stable, unique identifier for the source. If omitted, one may be generated upstream. */
-    id: string;
-    /** Unique identifier for the tenant/organization */
-    tenant_id: string;
-    /** Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used. */
-    sub_tenant_id: string;
-    /** Short human-readable title for the source. */
-    title?: string | undefined;
-    /** High-level category of the source (e.g., document, email, ticket). */
-    type?: string | undefined;
-    /** Optional long-form description providing additional context. */
-    description?: string | undefined;
-    /** Free-form notes for internal use or ingestion hints. */
-    note?: string | undefined;
-    /** Canonical URL or reference link associated with the source. */
-    url?: string | undefined;
-    /** Creation or last-updated timestamp of the source in ISO-8601 format. */
-    timestamp?: string | undefined;
-    /** Primary content payload used for indexing and retrieval. */
-    content?: HydraDB.ContentModel | undefined;
-    /**
-     * JSON string containing tenant-level document metadata (e.g., department, compliance_tag)
-     *
-     * Example: > "{"department":"Finance","compliance_tag":"GDPR"}"
-     */
-    tenant_metadata?: Record<string, unknown> | undefined;
-    /**
-     * JSON string containing document-specific metadata (e.g., title, author, file_id). If file_id is not provided, the system will generate an ID automatically.
-     *
-     * Example: > "{"title":"Q1 Report.pdf","author":"Alice Smith","file_id":"custom_file_123"}"
-     *
-     */
-    document_metadata?: Record<string, unknown> | undefined;
-    /** System-provided attributes (e.g., app_name, local file size) not intended for search filtering. */
-    meta?: Record<string, unknown> | undefined;
-    /** Attachments related to the source such as images, PDFs, or supplemental files. */
-    attachments?: HydraDB.AttachmentModel[] | undefined;
-    /** Forcefully connect 2 sources based on cortex source ids or common properties. */
-    relations?: (HydraDB.ForcefulRelationsPayload | null) | undefined;
-}

package/dist/api/types/SourceUploadResponse.d.ts

@@ -1,11 +0,0 @@
-import type * as HydraDB from "../index.js";
-export interface SourceUploadResponse {
-    success?: boolean | undefined;
-    message?: string | undefined;
-    /** List of upload results for each source. */
-    results?: HydraDB.SourceUploadResultItem[] | undefined;
-    /** Number of sources successfully queued. */
-    success_count?: number | undefined;
-    /** Number of sources that failed to upload. */
-    failed_count?: number | undefined;
-}

package/dist/api/types/SourceUploadResultItem.d.ts

@@ -1,11 +0,0 @@
-import type * as HydraDB from "../index.js";
-export interface SourceUploadResultItem {
-    /** Unique identifier for the uploaded source. */
-    source_id: string;
-    /** Original filename if present. */
-    filename?: (string | null) | undefined;
-    /** Initial processing status. */
-    status?: HydraDB.SourceStatus | undefined;
-    /** Error message if upload failed. */
-    error?: (string | null) | undefined;
-}

package/dist/api/types/SuperNodeItem.d.ts

@@ -1,9 +0,0 @@
-/**
- * A single super node in the response.
- */
-export interface SuperNodeItem {
-    entity_id: string;
-    name: string;
-    type: string;
-    degree: number;
-}

package/dist/api/types/SuperNodeResponse.d.ts

@@ -1,11 +0,0 @@
-import type * as HydraDB from "../index.js";
-/**
- * Response model for the super-node detection endpoint.
- */
-export interface SuperNodeResponse {
-    tenant_id: string;
-    sub_tenant_id: string;
-    degree_threshold: number;
-    super_nodes: HydraDB.SuperNodeItem[];
-    count: number;
-}

package/dist/api/types/SupportedLlmProviders.d.ts

@@ -1,8 +0,0 @@
-export declare const SupportedLlmProviders: {
-    readonly Groq: "groq";
-    readonly Cerebras: "cerebras";
-    readonly Openai: "openai";
-    readonly Anthropic: "anthropic";
-    readonly Gemini: "gemini";
-};
-export type SupportedLlmProviders = (typeof SupportedLlmProviders)[keyof typeof SupportedLlmProviders];

package/dist/api/types/SupportedLlmProviders.js

@@ -1,11 +0,0 @@
-"use strict";
-// This file was auto-generated by Fern from our API Definition.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SupportedLlmProviders = void 0;
-exports.SupportedLlmProviders = {
-    Groq: "groq",
-    Cerebras: "cerebras",
-    Openai: "openai",
-    Anthropic: "anthropic",
-    Gemini: "gemini",
-};

package/dist/api/types/UserAssistantPair.d.ts

@@ -1,9 +0,0 @@
-/**
- * Represents a user-assistant conversation pair.
- */
-export interface UserAssistantPair {
-    /** User's message in the conversation */
-    user: string;
-    /** Assistant's response to the user message */
-    assistant: string;
-}

package/dist/api/types/ValidationError.d.ts

@@ -1,11 +0,0 @@
-export interface ValidationError {
-    loc: ValidationError.Loc.Item[];
-    msg: string;
-    type: string;
-}
-export declare namespace ValidationError {
-    type Loc = Loc.Item[];
-    namespace Loc {
-        type Item = string | number;
-    }
-}

package/dist/api/types/VectorStoreChunk.d.ts

@@ -1,26 +0,0 @@
-export interface VectorStoreChunk {
-    /** Unique identifier for this content chunk */
-    chunk_uuid: string;
-    /** Unique identifier for the source document */
-    source_id: string;
-    /** The actual text content of this chunk */
-    chunk_content: string;
-    /** Type of the source document (file, webpage, etc.) */
-    source_type?: string | undefined;
-    /** When the source document was originally uploaded */
-    source_upload_time?: string | undefined;
-    /** Title or name of the source document */
-    source_title?: string | undefined;
-    /** When the source document was last modified */
-    source_last_updated_time?: string | undefined;
-    /** Layout of the chunk in original document. You will generally receive        a stringified dict with 2 keys, `offsets` and `page`(optional). Offsets will have        `document_level_start_index` and `page_level_start_index`(optional) */
-    layout?: (string | null) | undefined;
-    /** Score indicating how relevant this chunk is to your search query,         with higher values indicating better matches */
-    relevancy_score?: (number | null) | undefined;
-    /** Document-level metadata set at ingestion time */
-    additional_metadata?: (Record<string, unknown> | null) | undefined;
-    /** Tenant-level metadata set at ingestion time */
-    metadata?: (Record<string, unknown> | null) | undefined;
-    /** IDs of related chunks providing extra context (from forceful relations). Only present in thinking mode when sources have forceful relations. */
-    extra_context_ids?: (string[] | null) | undefined;
-}