@pairsystems/goodmem-client v1.0.0-beta.1

goodmem-client

GoodmemClient - JavaScript client for goodmem-client API for interacting with the GoodMem service, providing vector-based memory storage and retrieval with multiple embedder support. The service enables creation of memory spaces, storing memories with vector representations, and efficient similarity-based retrieval. This SDK is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: v1
• Generator version: 7.13.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://goodmem.io/support

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install goodmem-client --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your goodmem-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var GoodmemClient = require('goodmem-client');


var api = new GoodmemClient.APIKeysApi()
var createApiKeyRequest = {
  "labels": {
    "environment": "development",
    "service": "chat-ui"
  },
  "expiresAt": 1735689600000
}
; // {CreateApiKeyRequest} API key configuration
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createApiKey(createApiKeyRequest, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/v1/default

Documentation for Models

• GoodmemClient.ApiKeyResponse
• GoodmemClient.BatchMemoryCreationRequest
• GoodmemClient.BatchMemoryDeletionRequest
• GoodmemClient.BatchMemoryRetrievalRequest
• GoodmemClient.CreateApiKeyRequest
• GoodmemClient.CreateApiKeyResponse
• GoodmemClient.EmbedderCreationRequest
• GoodmemClient.EmbedderResponse
• GoodmemClient.ListApiKeysResponse
• GoodmemClient.ListEmbeddersResponse
• GoodmemClient.ListSpacesResponse
• GoodmemClient.Memory
• GoodmemClient.MemoryCreationRequest
• GoodmemClient.MemoryListResponse
• GoodmemClient.Modality
• GoodmemClient.ProviderType
• GoodmemClient.Space
• GoodmemClient.SpaceCreationRequest
• GoodmemClient.SpaceEmbedder
• GoodmemClient.SpaceEmbedderConfig
• GoodmemClient.SystemInitResponse
• GoodmemClient.UpdateApiKeyRequest
• GoodmemClient.UpdateEmbedderRequest
• GoodmemClient.UpdateSpaceRequest
• GoodmemClient.UserResponse

Documentation for Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

ApiKeyAuth

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header