@aiozstorage/super-intelligence-memory is the Node.js/TypeScript client for s3vector_gw's S3 Vector memory API (POST /Record / POST /Recall). Every request is authenticated with AWS SigV4 (service s3vectors) using a static access key ID / secret access key pair -- there is no API key or OAuth flow.

Table of contents

• Getting started
  • Installation
  • Development
  • Code sample
• Documentation
  • API Endpoints - MemoryApi
  • Models
  • Errors
• Contribution

Getting started

Installation

With npm:

npm install @aiozstorage/super-intelligence-memory --save

...or with yarn:

yarn add @aiozstorage/super-intelligence-memory

Development

To build and compile the typescript sources to javascript use:

npm install
npm run build

Code sample

import SuperIntelligenceMemory = require('@aiozstorage/super-intelligence-memory');

(async () => {
    try {
        const client = new SuperIntelligenceMemory({
            baseUri: 'https://vector-api.aiozstorage.network',
            accessKeyId: 'YOUR_ACCESS_KEY_ID',
            secretAccessKey: 'YOUR_SECRET_ACCESS_KEY',
            region: 'us-east-1',
        });

        const out = await client.memory.record({
            vectorBucketName: 'my-bucket',
            statement: 'Paris is the capital of France.',
        });
    } catch (e) {
        if (e instanceof SuperIntelligenceMemory.ApiVideoError) {
            // e.code is the HTTP status code; e.problemDetails carries the
            // {__type, message} envelope every s3vector_gw error response
            // carries.
        }
        console.error(e);
    }
})();

SuperIntelligenceMemory exposes get memory(): MemoryApi, whose record/recall methods take a plain object with optional vectorBucketName/statement (or question/returnDistance/vectorBucketName for recall) properties.

Documentation

API Endpoints

MemoryApi

Method | Description | HTTP request ------------- | ------------- | ------------- recall() | Recall the most relevant stored statement for a question | POST /Recall record() | Store a statement in memory | POST /Record

Models

• APIErrorResponse
• RecallMatch
• RecallRequest
• RecallResponse
• RecordRequest
• RecordResponse

Errors

A non-2xx response rejects with an ApiVideoError (src/ApiVideoError.ts), exposed as a static property so it can be instanceof-checked without an as any cast:

import SuperIntelligenceMemory = require('@aiozstorage/super-intelligence-memory');

try {
  await client.memory.record({ vectorBucketName: 'my-bucket', statement: '' });
} catch (e) {
  if (e instanceof SuperIntelligenceMemory.ApiVideoError) {
    console.error(e.code, e.problemDetails);
  }
}

e.code is the HTTP status code and e.problemDetails carries the same {__type, message} error envelope as the Go client's AgentMemoryAPIError. Both fields are public readonly.

Contribution

Since this API client is generated from an OpenAPI description, we cannot accept pull requests made directly to the repository. If you want to contribute, open a pull request or issue against the generator repository instead.