https://github.com/memori-ai/memori-api-client
TypeScript client to integrate with Memori API.
https://github.com/memori-ai/memori-api-client
ai api-client api-wrapper conversational-agents conversational-ai memori memori-ai nlp typescript
Last synced: 6 months ago
JSON representation
TypeScript client to integrate with Memori API.
- Host: GitHub
- URL: https://github.com/memori-ai/memori-api-client
- Owner: memori-ai
- License: other
- Created: 2022-07-04T09:28:18.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-02T08:47:01.000Z (7 months ago)
- Last Synced: 2024-12-02T09:39:33.232Z (7 months ago)
- Topics: ai, api-client, api-wrapper, conversational-agents, conversational-ai, memori, memori-ai, nlp, typescript
- Language: TypeScript
- Homepage: https://memori.ai/en
- Size: 1.12 MB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# memori-api-client
[](https://www.npmjs.com/package/@memori.ai/memori-api-client)
TypeScript client to integrate with [Memori](https://memori.ai) API.
Web Platform: [AIsuru](https://aisuru.com)
## Installation
```bash
yarn add @memori.ai/memori-api-client
```
```bash
npm install @memori.ai/memori-api-client
```
## Usage
Every method has JSDoc annotations with usage and description and typings information.
See examples for [Node (TypeScript)](https://github.com/memori-ai/examples/blob/main/ts-sdk/index.ts) and [React](https://github.com/memori-ai/examples/blob/main/react-ts-with-api-client/src/App.tsx).
```ts
import memoriApiClient from '@memori.ai/memori-api-client';
const memori = memoriApiClient('https://backend.memori.ai', 'https://engine.memori.ai');
// or just memoriApiClient() as defaults to production
(async () => {
const { sessionID, currentState, ...response } = await memori.initSession({
memoriID: '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
birthdate: '1900-01-01T00:00:00.000Z',
});
const { currentState: dialogState, ...resp } =
await memori.postTextEnteredEvent({
sessionId: sessionID,
text: 'Ciao, Memori!',
});
})();
```
For the specification of the APIs, see the typings or the documentation from the dashboard if you are allowed to see it.
### Constants
```ts
memori.constants.allowedMediaTypes; // list of allowed media types in asset upload
memori.constants.anonTag; // tag for anonymous users
```
Endpoints passed during initialization:
```ts
memori.constants.BACKEND_URL;
memori.constants.ENGINE_URL;
```
### Asset
There is a helper method parsing media urls from the DB, handling different cases
```ts
memori.asset.getResourceUrl({
type: 'avatar',
resourceURI: '768b9654-e781-4c3c-81fa-ae1529d1bfbe.png',
sessionID: 'be2e4a44-890b-483b-a26a-f6e122f36e2b',
baseURL: 'https://aisuru.com',
});
```
## See also
- [memori-react](https://github.com/memori-ai/memori-react) - React library for Memori, uses this library
- [memori-webcomponent](https://github.com/memori-ai/memori-webcomponent) - Web component for Memori, uses this library