@hydradb/sdk 0.0.3 → 2.0.0

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

@@ -0,0 +1,7 @@
+import type * as HydraDB from "../index.js";
+export interface DeliveryListResponse {
+    deliveries: HydraDB.DeliveryItem[];
+    count: number;
+    /** Opaque cursor to pass as `cursor` on the next request to get the next page. */
+    nextCursor?: string | null;
+}

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

@@ -4,9 +4,9 @@ export interface Entity {
     /** PERSON, ORGANIZATION, PROJECT, PRODUCT, ERROR_CODE, etc. */
     type: string;
     /** Context category like 'employees', 'projects' */
-    namespace?: string | undefined;
+    namespace?: string;
     /** Internal unique entity ID from graph database */
-    entity_id: string;
+    entityId: string;
     /** Unique ID like email, employee_id, URL */
-    identifier?: (string | null) | undefined;
+    identifier?: string | null;
 }

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

@@ -0,0 +1,4 @@
+export interface ErrorDetail {
+    code: string;
+    message: string;
+}

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

@@ -3,9 +3,9 @@ import type * as HydraDB from "../index.js";
  * Graph context containing query-based paths and chunk-based relation paths.
  */
 export interface GraphContext {
-    query_paths?: HydraDB.ScoredPathResponse[] | undefined;
-    chunk_relations?: HydraDB.ScoredPathResponse[] | undefined;
-    chunk_id_to_group_ids?: Record<string, string[]> | undefined;
+    queryPaths?: HydraDB.ScoredPathResponse[];
+    chunkRelations?: HydraDB.ScoredPathResponse[];
+    chunkIdToGroupIds?: Record<string, string[]>;
     /** LLM-generated summary of how sub-query results connect, present only for multi-step queries with requires_synthesis=True. */
-    synthesis_context?: (string | null) | undefined;
+    synthesisContext?: string | null;
 }

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

@@ -0,0 +1,17 @@
+import type * as HydraDB from "../index.js";
+/**
+ * V2 response for deployed infrastructure status checks.
+ *
+ * Identical to :class:`InfraStatusResponse` except ``infra.vectorstore_status``
+ * is a typed :class:`VectorstoreStatus` object rather than a 2-tuple.
+ */
+export interface InfraStatusResponseV2 {
+    /** Tenant identifier when status is queried for a specific tenant */
+    tenantId?: string | null;
+    /** Organization identifier */
+    orgId: string;
+    /** Deployed infrastructure status */
+    infra: HydraDB.InfraV2;
+    /** Summary message */
+    message?: string;
+}

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

@@ -0,0 +1,11 @@
+import type * as HydraDB from "../index.js";
+/**
+ * V2 infra shape with ``vectorstore_status`` as a typed object.
+ */
+export interface InfraV2 {
+    schedulerStatus: boolean;
+    graphStatus: boolean;
+    vectorstoreStatus: HydraDB.VectorstoreStatus;
+    /** True when the tenant is ready for ingestion and search. Derived from vectorstore_status.knowledge and vectorstore_status.memories. */
+    readyForIngestion?: boolean;
+}

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

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

package/dist/api/types/{ListContentKind.js → IngestType.js}

@@ -1,8 +1,8 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ListContentKind = void 0;
-exports.ListContentKind = {
+exports.IngestType = void 0;
+exports.IngestType = {
     Knowledge: "knowledge",
-    Memories: "memories",
+    Memory: "memory",
 };

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

@@ -4,11 +4,11 @@ import type * as HydraDB from "../index.js";
  */
 export interface ListUserMemoriesResponse {
     /** Indicates whether the memory listing operation was successful */
-    success?: boolean | undefined;
+    success?: boolean;
     /** Array of user memories for the current page */
-    user_memories?: HydraDB.UserMemory[] | undefined;
+    userMemories?: HydraDB.UserMemory[];
     /** Total number of user memories matching the query */
-    total?: number | undefined;
+    total?: number;
     /** Pagination metadata for navigating through results. */
     pagination: HydraDB.PaginationMeta;
 }

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

@@ -5,13 +5,13 @@ export interface PaginationMeta {
     /** Current page number (1-indexed). */
     page: number;
     /** Number of items returned per page. */
-    page_size: number;
+    pageSize: number;
     /** Total number of items matching the query. */
     total: number;
     /** Total number of pages available. */
-    total_pages: number;
+    totalPages: number;
     /** Whether a next page exists. */
-    has_next: boolean;
+    hasNext: boolean;
     /** Whether a previous page exists. */
-    has_previous: boolean;
+    hasPrevious: boolean;
 }

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

@@ -0,0 +1,7 @@
+import type * as HydraDB from "../index.js";
+export interface QueryApiResponse {
+    success?: boolean;
+    data?: HydraDB.V2RetrievalResult | null;
+    error?: HydraDB.ErrorDetail | null;
+    meta?: HydraDB.ResponseMeta;
+}

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

@@ -0,0 +1,6 @@
+/** Query method to use for retrieval. */
+export declare const QueryBy: {
+    readonly Hybrid: "hybrid";
+    readonly Text: "text";
+};
+export type QueryBy = (typeof QueryBy)[keyof typeof QueryBy];

package/dist/api/types/QueryBy.js

@@ -0,0 +1,9 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryBy = void 0;
+/** Query method to use for retrieval. */
+exports.QueryBy = {
+    Hybrid: "hybrid",
+    Text: "text",
+};

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

@@ -0,0 +1,4 @@
+/**
+ * Search ranking algorithm parameter (0.0-1.0 or 'auto')
+ */
+export type QueryRequestAlpha = string | number;

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

@@ -3,23 +3,23 @@
  */
 export interface RelationEvidence {
     /** Relationship phrase like 'works for', 'reports to' */
-    canonical_predicate: string;
+    canonicalPredicate: string;
     /** Original predicate from text */
-    raw_predicate: string;
+    rawPredicate: string;
     /** Rich contextual description of the relationship with surrounding information, details about how/why/when, and any relevant background. Should be comprehensive enough to understand the relationship without referring back to source. */
     context: string;
     /** Confidence score */
-    confidence?: number | undefined;
+    confidence?: number;
     /** Temporal timing information extracted from text (e.g., 'last week', 'in 2023', 'yesterday') */
-    temporal_details?: (string | null) | undefined;
+    temporalDetails?: string | null;
     /** Timestamp when this relation was introduced */
-    timestamp?: string | undefined;
+    timestamp?: Date;
     /** Unique ID for this relationship from graph database */
-    relationship_id: string;
+    relationshipId: string;
     /** ID of the chunk this relation was extracted from */
-    chunk_id?: (string | null) | undefined;
+    chunkId?: string | null;
     /** The entity ID of source node */
-    source_entity_id?: (string | null) | undefined;
+    sourceEntityId?: string | null;
     /** The entity ID of target node */
-    target_entity_id?: (string | null) | undefined;
+    targetEntityId?: string | null;
 }

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

@@ -0,0 +1,4 @@
+export interface ResponseMeta {
+    requestId?: string;
+    latencyMs?: number | null;
+}

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

@@ -0,0 +1,5 @@
+export interface RetryResponse {
+    deliveryId: string;
+    queued: boolean;
+    message?: string;
+}

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

@@ -1,10 +1,10 @@
 import type * as HydraDB from "../index.js";
 export interface ScoredPathResponse {
     triplets: HydraDB.PathTriplet[];
-    relevancy_score: number;
-    combined_context?: (string | null) | undefined;
+    relevancyScore: number;
+    combinedContext?: string | null;
     /** Path group identifier (e.g., 'p_0') for chunk mapping */
-    group_id?: (string | null) | undefined;
+    groupId?: string | null;
     /** Input chunk IDs whose graph traversal produced this path */
-    source_chunk_ids?: (string[] | null) | undefined;
+    sourceChunkIds?: string[] | null;
 }

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

@@ -0,0 +1,7 @@
+import type * as HydraDB from "../index.js";
+export interface SourceDeleteApiResponse {
+    success?: boolean;
+    data?: HydraDB.SourceDeleteApiResponseData | null;
+    error?: HydraDB.ErrorDetail | null;
+    meta?: HydraDB.ResponseMeta;
+}

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

@@ -0,0 +1,2 @@
+import type * as HydraDB from "../index.js";
+export type SourceDeleteApiResponseData = HydraDB.SourceDeleteResponse | HydraDB.DeleteUserMemoryResponse;

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

@@ -3,9 +3,9 @@ import type * as HydraDB from "../index.js";
  * Response for delete request.
  */
 export interface SourceDeleteResponse {
-    success?: boolean | undefined;
-    message?: string | undefined;
-    results?: HydraDB.SourceDeleteResultItem[] | undefined;
+    success?: boolean;
+    message?: string;
+    results?: HydraDB.SourceDeleteResultItem[];
     /** Number of sources deleted. */
-    deleted_count?: number | undefined;
+    deletedCount?: number;
 }

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

@@ -5,7 +5,7 @@ export interface SourceDeleteResultItem {
     /** ID of the source. */
     id: string;
     /** Whether deletion succeeded. */
-    deleted?: boolean | undefined;
+    deleted?: boolean;
     /** Error message if deletion failed. */
-    error?: (string | null) | undefined;
+    error?: string | null;
 }

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

@@ -0,0 +1,7 @@
+import type * as HydraDB from "../index.js";
+export interface SourceFetchApiResponse {
+    success?: boolean;
+    data?: HydraDB.V2SourceFetchResponse | null;
+    error?: HydraDB.ErrorDetail | null;
+    meta?: HydraDB.ResponseMeta;
+}

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

@@ -3,11 +3,11 @@ export interface SourceGraphRelationsResponse {
     /** List of relations retrieved */
     relations: (HydraDB.TripletWithEvidence | null)[];
     /** Whether the result was truncated due to the limit */
-    is_truncated?: boolean | undefined;
+    isTruncated?: boolean;
     /** Opaque cursor for fetching the next page. Pass this value as the 'cursor' query parameter to continue pagination. None when there are no more results. */
-    next_cursor?: (number | null) | undefined;
+    nextCursor?: number | null;
     /** Indicates whether the request was successful */
-    success?: boolean | undefined;
+    success?: boolean;
     /** Response message describing the operation result */
-    message?: string | undefined;
+    message?: string;
 }

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

@@ -2,17 +2,23 @@ export interface SourceInfo {
     /** Unique identifier for the source */
     id: string;
     /** Short human-readable title for the source */
-    title?: string | undefined;
+    title?: string;
     /** Category of the source (e.g., document, email, ticket) */
-    type?: string | undefined;
+    type?: string;
     /** Long-form description providing additional context */
-    description?: string | undefined;
+    description?: string;
     /** Canonical URL or reference link associated with the source */
-    url?: string | undefined;
+    url?: string;
     /** Creation or last-updated timestamp in ISO-8601 format */
-    timestamp?: string | undefined;
+    timestamp?: string;
     /** Tenant-level metadata set at ingestion time */
-    metadata?: Record<string, unknown> | undefined;
+    metadata?: Record<string, unknown>;
     /** Document-level metadata set at ingestion time */
-    additional_metadata?: Record<string, unknown> | undefined;
+    additionalMetadata?: Record<string, unknown>;
+    /** App-source kind discriminator (email, message, ticket, knowledge_base, comment, custom) */
+    appKind?: string | null;
+    /** App provider name (e.g. gmail, slack, jira, notion) */
+    appProvider?: string | null;
+    /** Provider-scoped stable identifier for the source item */
+    appExternalId?: string | null;
 }

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

@@ -0,0 +1,7 @@
+import type * as HydraDB from "../index.js";
+export interface SourceIngestApiResponse {
+    success?: boolean;
+    data?: HydraDB.SourceIngestApiResponseData | null;
+    error?: HydraDB.ErrorDetail | null;
+    meta?: HydraDB.ResponseMeta;
+}

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

@@ -0,0 +1,2 @@
+import type * as HydraDB from "../index.js";
+export type SourceIngestApiResponseData = HydraDB.V2SourceUploadResponse | HydraDB.V2AddMemoryResponse;

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

@@ -0,0 +1,7 @@
+import type * as HydraDB from "../index.js";
+export interface SourceListApiResponse {
+    success?: boolean;
+    data?: HydraDB.SourceListApiResponseData | null;
+    error?: HydraDB.ErrorDetail | null;
+    meta?: HydraDB.ResponseMeta;
+}

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

@@ -0,0 +1,2 @@
+import type * as HydraDB from "../index.js";
+export type SourceListApiResponseData = HydraDB.V2SourceListResponse | undefined | HydraDB.ListUserMemoriesResponse;

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

@@ -0,0 +1,7 @@
+import type * as HydraDB from "../index.js";
+export interface SourceRelationsApiResponse {
+    success?: boolean;
+    data?: HydraDB.SourceGraphRelationsResponse | null;
+    error?: HydraDB.ErrorDetail | null;
+    meta?: HydraDB.ResponseMeta;
+}

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

@@ -0,0 +1,7 @@
+import type * as HydraDB from "../index.js";
+export interface SourceStatusApiResponse {
+    success?: boolean;
+    data?: HydraDB.V2BatchProcessingStatus | null;
+    error?: HydraDB.ErrorDetail | null;
+    meta?: HydraDB.ResponseMeta;
+}

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

@@ -0,0 +1,7 @@
+/** What to query over. */
+export declare const SourceType: {
+    readonly Knowledge: "knowledge";
+    readonly Memory: "memory";
+    readonly All: "all";
+};
+export type SourceType = (typeof SourceType)[keyof typeof SourceType];

package/dist/api/types/SourceType.js

@@ -0,0 +1,10 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SourceType = void 0;
+/** What to query over. */
+exports.SourceType = {
+    Knowledge: "knowledge",
+    Memory: "memory",
+    All: "all",
+};

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

@@ -3,7 +3,7 @@
  */
 export interface SubTenantIdsResponse {
     /** Unique sub-tenant IDs that have indexed data in the tenant's collections */
-    sub_tenant_ids?: string[] | undefined;
+    subTenantIds?: string[];
     /** Summary message */
-    message?: string | undefined;
+    message?: string;
 }

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

@@ -3,9 +3,9 @@
  */
 export interface TenantCreateAcceptedResponse {
     /** Status of the request */
-    status?: string | undefined;
+    status?: string;
     /** Tenant identifier that is being created */
-    tenant_id: string;
+    tenantId: string;
     /** Response message */
-    message?: string | undefined;
+    message?: string;
 }

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

@@ -0,0 +1,7 @@
+import type * as HydraDB from "../index.js";
+export interface TenantCreateApiResponse {
+    success?: boolean;
+    data?: HydraDB.TenantCreateAcceptedResponse | null;
+    error?: HydraDB.ErrorDetail | null;
+    meta?: HydraDB.ResponseMeta;
+}

package/dist/api/{resources/tenant/client/requests → types}/TenantCreateRequest.d.ts

@@ -1,17 +1,17 @@
-import type * as HydraDB from "../../../../index.js";
+import type * as HydraDB from "../index.js";
 /**
- * @example
- *     {
- *         tenant_id: "tenant_1234"
- *     }
+ * Request model for creating a tenant with optional metadata schema.
+ *
+ * The tenant_metadata_schema allows you to define custom fields that will be indexed
+ * in Milvus with configurable search capabilities:
  */
 export interface TenantCreateRequest {
     /** Unique tenant identifier */
-    tenant_id: string;
+    tenantId: string;
     /** True to create embeddings tenant */
-    is_embeddings_tenant?: boolean;
+    isEmbeddingsTenant?: boolean;
     /** Embedding dimensions for embeddings tenant. Not required for non-embeddings (is_embeddings_tenant=False) tenants */
-    embeddings_dimension?: number | null;
+    embeddingsDimension?: number | null;
     /** Schema definition for tenant metadata fields. Each field can be configured for: filtering (enable_match), semantic search (enable_dense_embedding), and/or keyword search (enable_sparse_embedding). Fields with embeddings enabled must be VARCHAR type. */
-    tenant_metadata_schema?: HydraDB.CustomPropertyDefinition[] | null;
+    tenantMetadataSchema?: HydraDB.CustomPropertyDefinition[] | null;
 }

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

@@ -0,0 +1,7 @@
+import type * as HydraDB from "../index.js";
+export interface TenantDeleteApiResponse {
+    success?: boolean;
+    data?: HydraDB.TenantDeleteResponse | null;
+    error?: HydraDB.ErrorDetail | null;
+    meta?: HydraDB.ResponseMeta;
+}

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

@@ -1,6 +1,6 @@
 export interface TenantDeleteResponse {
     /** Identifier provided by user */
-    tenant_id: string;
-    status?: string | undefined;
-    message?: string | undefined;
+    tenantId: string;
+    status?: string;
+    message?: string;
 }

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

@@ -1,8 +1,8 @@
 export interface TenantIdsResponse {
     /** Tenant identifiers (active/provisioning tenants only) */
-    tenant_ids?: string[] | undefined;
+    tenantIds?: string[];
     /** Tenants whose creation failed. Each entry has 'tenant_id' and 'error'. Re-create the tenant to retry provisioning. */
-    failed_tenant_ids?: (Record<string, string>[] | null) | undefined;
+    failedTenantIds?: Record<string, string>[] | null;
     /** Summary message */
-    message?: string | undefined;
+    message?: string;
 }

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

@@ -0,0 +1,7 @@
+import type * as HydraDB from "../index.js";
+export interface TenantInfraStatusApiResponse {
+    success?: boolean;
+    data?: HydraDB.InfraStatusResponseV2 | null;
+    error?: HydraDB.ErrorDetail | null;
+    meta?: HydraDB.ResponseMeta;
+}

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

@@ -0,0 +1,7 @@
+import type * as HydraDB from "../index.js";
+export interface TenantListApiResponse {
+    success?: boolean;
+    data?: HydraDB.TenantIdsResponse | null;
+    error?: HydraDB.ErrorDetail | null;
+    meta?: HydraDB.ResponseMeta;
+}

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

@@ -0,0 +1,7 @@
+import type * as HydraDB from "../index.js";
+export interface TenantStatsApiResponse {
+    success?: boolean;
+    data?: HydraDB.TenantStatsResponse | null;
+    error?: HydraDB.ErrorDetail | null;
+    meta?: HydraDB.ResponseMeta;
+}

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

@@ -1,11 +1,11 @@
 import type * as HydraDB from "../index.js";
 export interface TenantStatsResponse {
     /** Tenant identifier */
-    tenant_id: string;
-    /** Statistics for the normal (context) collection */
-    normal_collection: HydraDB.CollectionStats;
+    tenantId: string;
+    /** Statistics for the knowledge collection */
+    knowledgeCollection: HydraDB.CollectionStats;
     /** Statistics for the memory collection */
-    memory_collection: HydraDB.CollectionStats;
+    memoryCollection: HydraDB.CollectionStats;
     /** Summary message */
-    message?: string | undefined;
+    message?: string;
 }

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

@@ -0,0 +1,7 @@
+import type * as HydraDB from "../index.js";
+export interface TenantSubTenantsApiResponse {
+    success?: boolean;
+    data?: HydraDB.SubTenantIdsResponse | null;
+    error?: HydraDB.ErrorDetail | null;
+    meta?: HydraDB.ResponseMeta;
+}

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

@@ -8,5 +8,5 @@ export interface TripletWithEvidence {
     /** Array of relation evidences */
     relations: HydraDB.RelationEvidence[];
     /** The chunk_id these relations are associated with */
-    chunk_id: string;
+    chunkId: string;
 }

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

@@ -3,7 +3,9 @@
  */
 export interface UserMemory {
     /** Unique identifier for the user memory */
-    memory_id: string;
+    memoryId: string;
     /** The actual memory content text that was stored */
-    memory_content: string;
+    memoryContent: string;
+    /** The inferred memory content generated by the inference stage, when available */
+    inferredContent?: string;
 }

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

@@ -0,0 +1,11 @@
+import type * as HydraDB from "../index.js";
+export interface V2AddMemoryResponse {
+    success?: boolean;
+    message?: string;
+    /** List of results for each ingested memory item. */
+    results?: HydraDB.V2MemoryResultItem[];
+    /** Number of items successfully queued for ingestion. */
+    successCount?: number;
+    /** Number of items that failed to queue. */
+    failedCount?: number;
+}

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

@@ -0,0 +1,5 @@
+import type * as HydraDB from "../index.js";
+export interface V2BatchProcessingStatus {
+    /** List of processing statuses, one per requested ID. */
+    statuses: HydraDB.V2ProcessingStatus[];
+}

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

@@ -0,0 +1,29 @@
+/**
+ * A retrieved content chunk. Mirrors ``VectorStoreChunk`` with ``id``.
+ */
+export interface V2Chunk {
+    /** Unique identifier for this content chunk */
+    chunkUuid: string;
+    /** Unique identifier for the source document */
+    id: string;
+    /** The actual text content of this chunk */
+    chunkContent: string;
+    /** Type of the source document (file, webpage, etc.) */
+    sourceType?: string;
+    /** When the source document was originally uploaded */
+    sourceUploadTime?: string;
+    /** Title or name of the source document */
+    sourceTitle?: string;
+    /** When the source document was last modified */
+    sourceLastUpdatedTime?: string;
+    /** Layout of the chunk in original document. */
+    layout?: string | null;
+    /** Score indicating how relevant this chunk is to your query. */
+    relevancyScore?: number | null;
+    /** Document-level metadata set at ingestion time */
+    additionalMetadata?: Record<string, unknown> | null;
+    /** Tenant-level metadata set at ingestion time */
+    metadata?: Record<string, unknown> | null;
+    /** IDs of related chunks providing extra context. */
+    extraContextIds?: string[] | null;
+}