@getzep/zep-js - npm Package Compare versions

Comparing version 0.4.0 to 0.4.1

dist/esm/index.d.ts

 export { ZepClient } from "./zep-client";
 export { Memory, Message, MessageData, Summary, SummaryData, MemoryData, MemorySearchPayload, MemorySearchPayloadData, MemorySearchResult, MemorySearchResultData, APIError, } from "./models";
-export { UnexpectedResponseError, NotFoundError } from "./exceptions";
+export { UnexpectedResponseError, NotFoundError, AuthenticationError, } from "./exceptions";

dist/esm/index.js

 export { ZepClient } from "./zep-client";
 export { Memory, Message, Summary, MemorySearchPayload, MemorySearchResult, APIError, } from "./models";
-export { UnexpectedResponseError, NotFoundError } from "./exceptions";
+export { UnexpectedResponseError, NotFoundError, AuthenticationError, } from "./exceptions";

dist/index.d.ts

 export { ZepClient } from "./zep-client";
 export { Memory, Message, MessageData, Summary, SummaryData, MemoryData, MemorySearchPayload, MemorySearchPayloadData, MemorySearchResult, MemorySearchResultData, APIError, } from "./models";
-export { UnexpectedResponseError, NotFoundError } from "./exceptions";
+export { UnexpectedResponseError, NotFoundError, AuthenticationError, } from "./exceptions";

dist/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NotFoundError = exports.UnexpectedResponseError = exports.APIError = exports.MemorySearchResult = exports.MemorySearchPayload = exports.Summary = exports.Message = exports.Memory = exports.ZepClient = void 0;
+exports.AuthenticationError = exports.NotFoundError = exports.UnexpectedResponseError = exports.APIError = exports.MemorySearchResult = exports.MemorySearchPayload = exports.Summary = exports.Message = exports.Memory = exports.ZepClient = void 0;
 var zep_client_1 = require("./zep-client");
@@ -16,1 +16,2 @@ Object.defineProperty(exports, "ZepClient", { enumerable: true, get: function () { return zep_client_1.ZepClient; } });
 Object.defineProperty(exports, "NotFoundError", { enumerable: true, get: function () { return exceptions_1.NotFoundError; } });
+Object.defineProperty(exports, "AuthenticationError", { enumerable: true, get: function () { return exceptions_1.AuthenticationError; } });

package.json

 {
    "show-config": "tsc --showConfig",
    "name": "@getzep/zep-js",
-   "version": "0.4.0",
+   "version": "0.4.1",
    "description": "Zep JS Client",
@@ -6,0 +6,0 @@ "private": false,

README.md

@@ -23,3 +23,3 @@ # Zep: A long-term memory store for conversational AI applications
      // Example usage
-     const session_id = "1a1ab1c";
+     const sessionId = "1a1ab1c";
 
@@ -32,3 +32,3 @@ // Add memory
      memory.messages = [message];
-     const result = await client.addMemoryAsync(session_id, memory);
+     const result = await client.addMemoryAsync(sessionId, memory);
 
@@ -39,3 +39,3 @@ // Search memory
     const search_results = await client.searchMemoryAsync(
-      session_id,
+      sessionId,
       search_payload
@@ -51,6 +51,6 @@ );
      // Get Memory
-     const memories = await client.getMemoryAsync(session_id);
+     const memories = await client.getMemoryAsync(sessionId);
 
     // Delete memory
-    const deleteResult = await client.deleteMemoryAsync(session_id);
+    const deleteResult = await client.deleteMemoryAsync(sessionId);
 
@@ -79,10 +79,10 @@ } catch (error) {
 
-- `constructor(base_url: string)`: Constructs a new ZepClient instance with the given base URL of the Zep API.
+- `constructor(baseURL: string)`: Constructs a new ZepClient instance with the given base URL of the Zep API.
 
 ## Methods
 
-### getMemoryAsync
+### getMemory
 
-- `getMemoryAsync(session_id: string, lastn?: number)`: Retrieves memory for a specific session.
-  - `session_id`: The ID of the session to retrieve memory for.
+- `getMemory(sessionId: string, lastn?: number)`: Retrieves memory for a specific session.
+  - `sessionId`: The ID of the session to retrieve memory for.
   - `lastn`: (Optional) The number of most recent memories to retrieve.
@@ -93,6 +93,6 @@ - Returns: A promise that resolves to an array of `Memory` objects.
 
-### addMemoryAsync
+### addMemory
 
-- `addMemoryAsync(session_id: string, memory: Memory)`: Adds a new memory to a specific session.
-  - `session_id`: The ID of the session to add the memory to.
+- `addMemory(sessionId: string, memory: Memory)`: Adds a new memory to a specific session.
+  - `sessionId`: The ID of the session to add the memory to.
   - `memory`: The `Memory` object to add to the session.
@@ -103,14 +103,14 @@ - Returns: A promise that resolves to the added memory.
 
-### deleteMemoryAsync
+### deleteMemory
 
-- `deleteMemoryAsync(session_id: string)`: Deletes the memory of a specific session.
-  - `session_id`: The ID of the session for which the memory should be deleted.
+- `deleteMemory(sessionId: string)`: Deletes the memory of a specific session.
+  - `sessionId`: The ID of the session for which the memory should be deleted.
   - Returns: A promise that resolves to a message indicating the memory has been deleted.
 ---
 
-### searchMemoryAsync
+### searchMemory
 
-- `searchMemoryAsync(session_id: string, search_payload: SearchPayload, limit?: number)`: Searches the memory of a specific session based on the search payload provided.
-  - `session_id`: The ID of the session for which the memory should be searched.
-  - `search_payload`: The `SearchPayload` object containing the search criteria.
+- `searchMemory(sessionId: string, searchPayload: SearchPayload, limit?: number)`: Searches the memory of a specific session based on the search payload provided.
+  - `sessionID`: The ID of the session for which the memory should be searched.
+  - `searchPayload`: The `SearchPayload` object containing the search criteria.
   - `limit`: (Optional) Limit on the number of search results returned.
@@ -129,2 +129,3 @@ - Returns: A promise that resolves to an array of `SearchResult` objects.
 - `token_count`: Optional number for the token count of the message.
+- `metadata?` : Optional metadata
 ---
@@ -169,18 +170,17 @@
 
-### SearchPayloadData
+### MemorySearchPayloadData
 
-- `meta`: Object for the metadata of the search payload.
+- `metadata`: Object for the metadata of the search payload.
 - `text`: String for the text to be searched.
 ---
 
-### SearchPayload
+### MemorySearchPayload
 
-- `constructor(data: SearchPayloadData)`: Constructs a new SearchPayload instance.
+- `constructor(data: MemorySearchPayloadData)`: Constructs a new MemorySearchPayload instance.
 ---
 
-### SearchResultData
+### MemorySearchResultData
 
 - `message`: Optional MessageData for the message in the search result.
-- `meta`: Optional object for metadata associated with the search result.
-- `score`: Optional number for the score of the search result.
+- `metadata`: Metadata associated with the search result.
 - `summary`: Optional string for the summary of the search result.
@@ -190,5 +190,5 @@ - `dist`: Optional number for the distance of the search result.
 
-### SearchResult
+### MemorySearchResult
 
-- `constructor(data: SearchResultData)`: Constructs a new SearchResult instance.
+- `constructor(data: MemorySearchResultData)`: Constructs a new MemorySearchResult instance.
 ---
@@ -213,1 +213,5 @@
 ---
+### AuthenticationError
+- Custom error class for Authentication errors in the ZepClient.
+- `Constructor: (message: string)`: Constructs an AuthenticationError instance
+---

No alert changes

Improved metrics

Total package byte prevSize

89712

increased by0.4%

Lines of code

1727

increased by0.06%

Number of lines in readme file

206

increased by1.48%

No dependency changes