@vectorize-io/hindsight-client 0.4.10 → 0.4.12

package/generated/types.gen.ts

@@ -59,6 +59,52 @@ export type BackgroundResponse = {
   disposition?: DispositionTraits | null;
 };
 
+/**
+ * BankConfigResponse
+ *
+ * Response model for bank configuration.
+ */
+export type BankConfigResponse = {
+  /**
+   * Bank Id
+   *
+   * Bank identifier
+   */
+  bank_id: string;
+  /**
+   * Config
+   *
+   * Fully resolved configuration with all hierarchical overrides applied (Python field names)
+   */
+  config: {
+    [key: string]: unknown;
+  };
+  /**
+   * Overrides
+   *
+   * Bank-specific configuration overrides only (Python field names)
+   */
+  overrides: {
+    [key: string]: unknown;
+  };
+};
+
+/**
+ * BankConfigUpdate
+ *
+ * Request model for updating bank configuration.
+ */
+export type BankConfigUpdate = {
+  /**
+   * Updates
+   *
+   * Configuration overrides. Keys can be in Python field format (llm_provider) or environment variable format (HINDSIGHT_API_LLM_PROVIDER). Only hierarchical fields can be overridden per-bank.
+   */
+  updates: {
+    [key: string]: unknown;
+  };
+};
+
 /**
  * BankListItem
  *
@@ -205,6 +251,24 @@ export type BankStatsResponse = {
   total_observations?: number;
 };
 
+/**
+ * Body_file_retain
+ */
+export type BodyFileRetain = {
+  /**
+   * Files
+   *
+   * Files to upload and convert
+   */
+  files: Array<Blob | File>;
+  /**
+   * Request
+   *
+   * JSON string with FileRetainRequest model
+   */
+  request: string;
+};
+
 /**
  * Budget
  *
@@ -232,6 +296,34 @@ export type CancelOperationResponse = {
   operation_id: string;
 };
 
+/**
+ * ChildOperationStatus
+ *
+ * Status of a child operation (for batch operations).
+ */
+export type ChildOperationStatus = {
+  /**
+   * Operation Id
+   */
+  operation_id: string;
+  /**
+   * Status
+   */
+  status: string;
+  /**
+   * Sub Batch Index
+   */
+  sub_batch_index?: number | null;
+  /**
+   * Items Count
+   */
+  items_count?: number | null;
+  /**
+   * Error Message
+   */
+  error_message?: string | null;
+};
+
 /**
  * ChunkData
  *
@@ -816,6 +908,32 @@ export type FeaturesInfo = {
    * Whether the background worker is enabled
    */
   worker: boolean;
+  /**
+   * Bank Config Api
+   *
+   * Whether per-bank configuration API is enabled
+   */
+  bank_config_api: boolean;
+  /**
+   * File Upload Api
+   *
+   * Whether file upload/conversion API is enabled
+   */
+  file_upload_api: boolean;
+};
+
+/**
+ * FileRetainResponse
+ *
+ * Response model for file upload endpoint.
+ */
+export type FileRetainResponse = {
+  /**
+   * Operation Ids
+   *
+   * Operation IDs for tracking file conversion operations. Use GET /v1/default/banks/{bank_id}/operations to list operations.
+   */
+  operation_ids: Array<string>;
 };
 
 /**
@@ -1149,6 +1267,20 @@ export type OperationStatusResponse = {
    * Error Message
    */
   error_message?: string | null;
+  /**
+   * Result Metadata
+   *
+   * Internal metadata for debugging. Structure may change without notice. Not for production use.
+   */
+  result_metadata?: {
+    [key: string]: unknown;
+  } | null;
+  /**
+   * Child Operations
+   *
+   * Child operations for batch operations (if applicable)
+   */
+  child_operations?: Array<ChildOperationStatus> | null;
 };
 
 /**
@@ -1666,7 +1798,7 @@ export type RetainResponse = {
   /**
    * Operation Id
    *
-   * Operation ID for tracking async operations. Use GET /v1/default/banks/{bank_id}/operations to list operations and find this ID. Only present when async=true.
+   * Operation ID for tracking async operations. Use GET /v1/default/banks/{bank_id}/operations to list operations. Only present when async=true.
    */
   operation_id?: string | null;
   /**
@@ -3426,6 +3558,119 @@ export type ClearObservationsResponses = {
 export type ClearObservationsResponse =
   ClearObservationsResponses[keyof ClearObservationsResponses];
 
+export type ResetBankConfigData = {
+  body?: never;
+  headers?: {
+    /**
+     * Authorization
+     */
+    authorization?: string | null;
+  };
+  path: {
+    /**
+     * Bank Id
+     */
+    bank_id: string;
+  };
+  query?: never;
+  url: "/v1/default/banks/{bank_id}/config";
+};
+
+export type ResetBankConfigErrors = {
+  /**
+   * Validation Error
+   */
+  422: HttpValidationError;
+};
+
+export type ResetBankConfigError =
+  ResetBankConfigErrors[keyof ResetBankConfigErrors];
+
+export type ResetBankConfigResponses = {
+  /**
+   * Successful Response
+   */
+  200: BankConfigResponse;
+};
+
+export type ResetBankConfigResponse =
+  ResetBankConfigResponses[keyof ResetBankConfigResponses];
+
+export type GetBankConfigData = {
+  body?: never;
+  headers?: {
+    /**
+     * Authorization
+     */
+    authorization?: string | null;
+  };
+  path: {
+    /**
+     * Bank Id
+     */
+    bank_id: string;
+  };
+  query?: never;
+  url: "/v1/default/banks/{bank_id}/config";
+};
+
+export type GetBankConfigErrors = {
+  /**
+   * Validation Error
+   */
+  422: HttpValidationError;
+};
+
+export type GetBankConfigError = GetBankConfigErrors[keyof GetBankConfigErrors];
+
+export type GetBankConfigResponses = {
+  /**
+   * Successful Response
+   */
+  200: BankConfigResponse;
+};
+
+export type GetBankConfigResponse =
+  GetBankConfigResponses[keyof GetBankConfigResponses];
+
+export type UpdateBankConfigData = {
+  body: BankConfigUpdate;
+  headers?: {
+    /**
+     * Authorization
+     */
+    authorization?: string | null;
+  };
+  path: {
+    /**
+     * Bank Id
+     */
+    bank_id: string;
+  };
+  query?: never;
+  url: "/v1/default/banks/{bank_id}/config";
+};
+
+export type UpdateBankConfigErrors = {
+  /**
+   * Validation Error
+   */
+  422: HttpValidationError;
+};
+
+export type UpdateBankConfigError =
+  UpdateBankConfigErrors[keyof UpdateBankConfigErrors];
+
+export type UpdateBankConfigResponses = {
+  /**
+   * Successful Response
+   */
+  200: BankConfigResponse;
+};
+
+export type UpdateBankConfigResponse =
+  UpdateBankConfigResponses[keyof UpdateBankConfigResponses];
+
 export type TriggerConsolidationData = {
   body?: never;
   headers?: {
@@ -3546,3 +3791,40 @@ export type RetainMemoriesResponses = {
 
 export type RetainMemoriesResponse =
   RetainMemoriesResponses[keyof RetainMemoriesResponses];
+
+export type FileRetainData = {
+  body: BodyFileRetain;
+  headers?: {
+    /**
+     * Authorization
+     */
+    authorization?: string | null;
+  };
+  path: {
+    /**
+     * Bank Id
+     */
+    bank_id: string;
+  };
+  query?: never;
+  url: "/v1/default/banks/{bank_id}/files/retain";
+};
+
+export type FileRetainErrors = {
+  /**
+   * Validation Error
+   */
+  422: HttpValidationError;
+};
+
+export type FileRetainError = FileRetainErrors[keyof FileRetainErrors];
+
+export type FileRetainResponses = {
+  /**
+   * Successful Response
+   */
+  200: FileRetainResponse;
+};
+
+export type FileRetainResponse2 =
+  FileRetainResponses[keyof FileRetainResponses];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vectorize-io/hindsight-client",
-  "version": "0.4.10",
+  "version": "0.4.12",
   "description": "TypeScript client for Hindsight - Semantic memory system with personality-driven thinking",
   "main": "./dist/src/index.js",
   "types": "./dist/src/index.d.ts",

package/src/index.ts

@@ -36,6 +36,7 @@ import type {
     RecallResult,
     ReflectRequest,
     ReflectResponse,
+    FileRetainResponse,
     ListMemoryUnitsResponse,
     BankProfileResponse,
     CreateBankRequest,
@@ -50,6 +51,22 @@ export interface HindsightClientOptions {
     apiKey?: string;
 }
 
+/**
+ * Error thrown by the Hindsight client when an API request fails.
+ * Includes the HTTP status code and error details from the API.
+ */
+export class HindsightError extends Error {
+    public statusCode?: number;
+    public details?: unknown;
+
+    constructor(message: string, statusCode?: number, details?: unknown) {
+        super(message);
+        this.name = 'HindsightError';
+        this.statusCode = statusCode;
+        this.details = details;
+    }
+}
+
 export interface EntityInput {
     text: string;
     type?: string;
@@ -82,9 +99,22 @@ export class HindsightClient {
     /**
      * Validates the API response and throws an error if the request failed.
      */
-    private validateResponse<T>(response: { data?: T; error?: unknown }, operation: string): T {
+    private validateResponse<T>(response: { data?: T; error?: unknown; response?: Response }, operation: string): T {
         if (!response.data) {
-            throw new Error(`${operation} failed: ${JSON.stringify(response.error || 'Unknown error')}`);
+            // The generated client returns { error, response, request }
+            // Status code is in response.status, not in the error object
+            const error = response.error as any;
+            const httpResponse = (response as any).response as Response | undefined;
+
+            // Extract status code from the HTTP response object
+            const statusCode = httpResponse?.status;
+            const details = error?.detail || error?.message || error;
+
+            throw new HindsightError(
+                `${operation} failed: ${JSON.stringify(details)}`,
+                statusCode,
+                details
+            );
         }
         return response.data;
     }
@@ -182,6 +212,40 @@ export class HindsightClient {
         return this.validateResponse(response, 'retainBatch');
     }
 
+    /**
+     * Upload files and retain their contents as memories.
+     *
+     * Files are automatically converted to text (PDF, DOCX, images via OCR, audio via
+     * transcription, and more) and ingested as memories. Processing is always asynchronous —
+     * use the returned operation IDs to track progress via the operations endpoint.
+     *
+     * @param bankId - The memory bank ID
+     * @param files - Array of File or Blob objects to upload
+     * @param options - Optional settings: context, documentTags, filesMetadata
+     */
+    async retainFiles(
+        bankId: string,
+        files: Array<File | Blob>,
+        options?: {
+            context?: string;
+            filesMetadata?: Array<{ context?: string; document_id?: string; tags?: string[]; metadata?: Record<string, string> }>;
+        }
+    ): Promise<FileRetainResponse> {
+        const meta = options?.filesMetadata ?? files.map(() => options?.context ? { context: options.context } : {});
+
+        const requestBody = JSON.stringify({
+            files_metadata: meta,
+        });
+
+        const response = await sdk.fileRetain({
+            client: this.client,
+            path: { bank_id: bankId },
+            body: { files, request: requestBody },
+        });
+
+        return this.validateResponse(response, 'retainFiles');
+    }
+
     /**
      * Recall memories with a natural language query.
      */
@@ -551,6 +615,7 @@ export type {
     RecallResult,
     ReflectRequest,
     ReflectResponse,
+    FileRetainResponse,
     ListMemoryUnitsResponse,
     BankProfileResponse,
     CreateBankRequest,