@memori.ai/memori-api-client
TypeScript icon, indicating that this package has built-in type declarations

4.2.1 • Public • Published

memori-api-client

npm version Tests TypeScript Support

TypeScript client to integrate with Memori API.

Web Platform: AIsuru

Installation

yarn add @memori.ai/memori-api-client
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) and React.

import memoriApiClient from '@memori.ai/memori-api-client';

const memori = memoriApiClient('https://backend.memori.ai');
(async () => {
  const { sessionID, currentState, ...response } = await memori.initSession({
    memoriID: '768b9654-e781-4c3c-81fa-ae1529d1bfbe',
  });

  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

memori.constants.allowedMediaTypes; // list of allowed media types in asset upload
memori.constants.anonTag; // tag for anonymous users

Endpoint passed during initialization:

memori.constants.HOSTNAME; // host name of the API, parameter of the constructor
memori.constants.BACKEND_URL;
memori.constants.ENGINE_URL;

Asset

There is a helper method parsing media urls from the DB, handling different cases

memori.asset.getResourceUrl({
  type: 'avatar',
  resourceURI: '768b9654-e781-4c3c-81fa-ae1529d1bfbe.png',
  sessionID: 'be2e4a44-890b-483b-a26a-f6e122f36e2b',
  baseURL: 'https://aisuru.com',
});

See also

Package Sidebar

Install

npm i @memori.ai/memori-api-client

Weekly Downloads

1,652

Version

4.2.1

License

Apache-2.0

Unpacked Size

805 kB

Total Files

508

Last publish

Collaborators

  • nzambello
  • memori-ai