New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

@memori.ai/memori-react

Package Overview
Dependencies
Maintainers
2
Versions
230
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@memori.ai/memori-react

[![npm version](https://img.shields.io/github/package-json/v/memori-ai/memori-react)](https://www.npmjs.com/package/@memori.ai/memori-react) ![Tests](https://github.com/memori-ai/memori-react/workflows/CI/badge.svg?branch=main) ![TypeScript Support](https

  • 1.0.0-alpha.9
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
237
decreased by-15.36%
Maintainers
2
Weekly downloads
 
Created
Source

Memori React

npm version Tests TypeScript Support

Library to integrate a Memori in a React app.

Platforms:

  • MemoryTwin: consumer / creator platform
  • TwinCreator: developer-oriented platform

Work in progress

This library is still in development and is not ready for production.

Installation

yarn add @memori.ai/memori-react
npm install @memori.ai/memori-react

Usage

import Memori from '@memori.ai/memori-react';

const App = () => (
  <Memori
    memoriName="Memori"
    ownerUserName="nunziofiore"
    tenantID="app.memorytwin.com"
    apiURL="https://backend.memori.ai"
    uiLang="it"
    showShare
    height="100vh"
  />
);

Props

PropRequiredTypeDefaultDescription
memoriName* (see below)stringName of the Memori
ownerUserName* (see below)stringUsername of the Memori owner
memoriID* (see below)stringID of the Memori
ownerUserID* (see below)stringID of the Memori owner
tenantID✔️stringTenant ID, example: "app.twincreator.com" or "app.memorytwin.com"
sessionIDstringInitial Session ID, UUID which refers to the session to the Memori and identifies a conversation and its permissions (giver, receiver, anonymous). A session would be started autonomously with the params set, but if you have an existing and valid sessionID you can pass it as already opened one. Use this at your risk, as session recovery might break or start session as anon user. In most cases, you shoudn't use this prop.
integrationIDstringIntegration ID, UUID which refers to the public page layout
secretTokenstringSecret token, the password of a private or secret Memori
heightstring"100%"Height of the Memori
showSharebooltrueShow the share button
showSettingsboolfalseShow the settings panel button
showInstructboolfalseShow the switch selecting between test mode or instruct mode, needs an administrative session as a giver
baseURLstringBase URL of the Memori, example: "https://app.twincreator.com" or "https://app.memorytwin.com"
apiURLstring"https://backend.memori.ai"URL of the Memori API
tagstringTag of the person opening the session to the Memori, could be the giver or a receiver
pinstringPIN of the person opening the session to the Memori, could be the giver or a receiver
contextstringInitial context of the conversation, dictionary with "key: value" pairs as context variables
initialQuestionstringInitial question to ask to the Memori, starts the conversation as this would be sent to the Memori
uiLang'en' | 'it'"en"Language of the UI, es: "en" or "it"
spokenLangstringLanguage of the spoken text, as defaults to user selection. Example: "en" or "it"
onStateChangefunctionCallback function called when the state of the Memori changes
AZURE_COGNITIVE_SERVICES_TTS_KEYstringAzure Cognitive Services TTS key, used to generate the audio of the Memori and for STT recognition

*: one of these pairs is required: memoriName + ownerUserName, memoriID + ownerUserID

Customization

WIP

See also

Keywords

FAQs

Package last updated on 19 Dec 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc