@pairsystems/goodmem-client 1.0.0-beta.1

package/README.md

@@ -0,0 +1,200 @@
+# 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](https://openapi-generator.tech) 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](https://goodmem.io/support)
+
+## Installation
+
+### For [Node.js](https://nodejs.org/)
+
+#### npm
+
+To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
+
+Then install it via:
+
+```shell
+npm install goodmem-client --save
+```
+
+Finally, you need to build the module:
+
+```shell
+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:
+
+```shell
+npm install
+```
+
+Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
+
+```shell
+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:
+
+```shell
+npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
+```
+
+Finally, you need to build the module:
+
+```shell
+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:
+
+```shell
+    npm install GIT_USER_ID/GIT_REPO_ID --save
+```
+
+### For browser
+
+The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):
+
+```shell
+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:
+
+```javascript
+module: {
+  rules: [
+    {
+      parser: {
+        amd: false
+      }
+    }
+  ]
+}
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) instruction and execute the following JS code:
+
+```javascript
+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*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*GoodmemClient.APIKeysApi* | [**createApiKey**](docs/APIKeysApi.md#createApiKey) | **POST** /v1/apikeys | Create a new API key
+*GoodmemClient.APIKeysApi* | [**deleteApiKey**](docs/APIKeysApi.md#deleteApiKey) | **DELETE** /v1/apikeys/{id} | Delete an API key
+*GoodmemClient.APIKeysApi* | [**listApiKeys**](docs/APIKeysApi.md#listApiKeys) | **GET** /v1/apikeys | List API keys
+*GoodmemClient.APIKeysApi* | [**updateApiKey**](docs/APIKeysApi.md#updateApiKey) | **PUT** /v1/apikeys/{id} | Update an API key
+*GoodmemClient.EmbeddersApi* | [**createEmbedder**](docs/EmbeddersApi.md#createEmbedder) | **POST** /v1/embedders | Create a new embedder
+*GoodmemClient.EmbeddersApi* | [**deleteEmbedder**](docs/EmbeddersApi.md#deleteEmbedder) | **DELETE** /v1/embedders/{id} | Delete an embedder
+*GoodmemClient.EmbeddersApi* | [**getEmbedder**](docs/EmbeddersApi.md#getEmbedder) | **GET** /v1/embedders/{id} | Get an embedder by ID
+*GoodmemClient.EmbeddersApi* | [**listEmbedders**](docs/EmbeddersApi.md#listEmbedders) | **GET** /v1/embedders | List embedders
+*GoodmemClient.EmbeddersApi* | [**updateEmbedder**](docs/EmbeddersApi.md#updateEmbedder) | **PUT** /v1/embedders/{id} | Update an embedder
+*GoodmemClient.MemoriesApi* | [**batchCreateMemory**](docs/MemoriesApi.md#batchCreateMemory) | **POST** /v1/memories/batch | Create multiple memories in a batch
+*GoodmemClient.MemoriesApi* | [**batchDeleteMemory**](docs/MemoriesApi.md#batchDeleteMemory) | **POST** /v1/memories/batch/delete | Delete multiple memories by ID
+*GoodmemClient.MemoriesApi* | [**batchGetMemory**](docs/MemoriesApi.md#batchGetMemory) | **POST** /v1/memories/batch/get | Get multiple memories by ID
+*GoodmemClient.MemoriesApi* | [**createMemory**](docs/MemoriesApi.md#createMemory) | **POST** /v1/memories | Create a new memory
+*GoodmemClient.MemoriesApi* | [**deleteMemory**](docs/MemoriesApi.md#deleteMemory) | **DELETE** /v1/memories/{id} | Delete a memory
+*GoodmemClient.MemoriesApi* | [**getMemory**](docs/MemoriesApi.md#getMemory) | **GET** /v1/memories/{id} | Get a memory by ID
+*GoodmemClient.MemoriesApi* | [**listMemories**](docs/MemoriesApi.md#listMemories) | **GET** /v1/spaces/{spaceId}/memories | List memories in a space
+*GoodmemClient.SpacesApi* | [**createSpace**](docs/SpacesApi.md#createSpace) | **POST** /v1/spaces | Create a new Space
+*GoodmemClient.SpacesApi* | [**deleteSpace**](docs/SpacesApi.md#deleteSpace) | **DELETE** /v1/spaces/{id} | Delete a space
+*GoodmemClient.SpacesApi* | [**getSpace**](docs/SpacesApi.md#getSpace) | **GET** /v1/spaces/{id} | Get a space by ID
+*GoodmemClient.SpacesApi* | [**listSpaces**](docs/SpacesApi.md#listSpaces) | **GET** /v1/spaces | List spaces
+*GoodmemClient.SpacesApi* | [**updateSpace**](docs/SpacesApi.md#updateSpace) | **PUT** /v1/spaces/{id} | Update a space
+*GoodmemClient.SystemApi* | [**initializeSystem**](docs/SystemApi.md#initializeSystem) | **POST** /v1/system/init | Initialize the system
+*GoodmemClient.UsersApi* | [**getUser**](docs/UsersApi.md#getUser) | **GET** /v1/users/{id} | Get a user by ID
+
+
+## Documentation for Models
+
+ - [GoodmemClient.ApiKeyResponse](docs/ApiKeyResponse.md)
+ - [GoodmemClient.BatchMemoryCreationRequest](docs/BatchMemoryCreationRequest.md)
+ - [GoodmemClient.BatchMemoryDeletionRequest](docs/BatchMemoryDeletionRequest.md)
+ - [GoodmemClient.BatchMemoryRetrievalRequest](docs/BatchMemoryRetrievalRequest.md)
+ - [GoodmemClient.CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
+ - [GoodmemClient.CreateApiKeyResponse](docs/CreateApiKeyResponse.md)
+ - [GoodmemClient.EmbedderCreationRequest](docs/EmbedderCreationRequest.md)
+ - [GoodmemClient.EmbedderResponse](docs/EmbedderResponse.md)
+ - [GoodmemClient.ListApiKeysResponse](docs/ListApiKeysResponse.md)
+ - [GoodmemClient.ListEmbeddersResponse](docs/ListEmbeddersResponse.md)
+ - [GoodmemClient.ListSpacesResponse](docs/ListSpacesResponse.md)
+ - [GoodmemClient.Memory](docs/Memory.md)
+ - [GoodmemClient.MemoryCreationRequest](docs/MemoryCreationRequest.md)
+ - [GoodmemClient.MemoryListResponse](docs/MemoryListResponse.md)
+ - [GoodmemClient.Modality](docs/Modality.md)
+ - [GoodmemClient.ProviderType](docs/ProviderType.md)
+ - [GoodmemClient.Space](docs/Space.md)
+ - [GoodmemClient.SpaceCreationRequest](docs/SpaceCreationRequest.md)
+ - [GoodmemClient.SpaceEmbedder](docs/SpaceEmbedder.md)
+ - [GoodmemClient.SpaceEmbedderConfig](docs/SpaceEmbedderConfig.md)
+ - [GoodmemClient.SystemInitResponse](docs/SystemInitResponse.md)
+ - [GoodmemClient.UpdateApiKeyRequest](docs/UpdateApiKeyRequest.md)
+ - [GoodmemClient.UpdateEmbedderRequest](docs/UpdateEmbedderRequest.md)
+ - [GoodmemClient.UpdateSpaceRequest](docs/UpdateSpaceRequest.md)
+ - [GoodmemClient.UserResponse](docs/UserResponse.md)
+
+
+## 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
+