@symblai/symbl-ui-components
v0.6.0
Published
You can read the docs for the Symbl UI Components at https://docs.symbl.ai/docs/ui-components
Downloads
209
Readme
symbl-ui-components
You can read the docs for the Symbl UI Components at https://docs.symbl.ai/docs/ui-components
Integrate Symbl UI components with your application in customized way
To view, test and experience the UI components and the customization options available, visit storybook at https://symbl-ui-components-demo.symbl.ai/
Supported Browsers
The following web browsers supported with the Symbl UI Components are given below:
Operating System | Chrome | Edge | Firefox | Safari | ---------- | ------- | ------- | ------ | ------ | macOS | ✅ | - | ✅ | ✅ | Windows | ✅ | ✅ | ✅ | - | Linux| ✅ | - | ✅ | - |
Prerequisites
Before using the Symbl UI Components you must Sign up with Symbl.ai to generate your own App ID and App Secret values, which is used for authentication.
Authentication
To use symbl ui components, you need an access token generated using Symbl’s Authentication method. Alternatively, you can use the App ID and App Secret from the Symbl Platform. Using the App ID and App Secret is not meant for production usage, as those are meant be secret.
Process a conversation
Process a conversation using one of async or streaming API by passing insights
and callScore
in featureList
array. Read more Process a conversation.
features: {
featureList: ["insights", "callScore"]
}
Installation
Using npm
Install the Symbl UI Component Library using npm
with the following command:
npm i @symblai/symbl-ui-components
Importing
You can import the Symbl UI Components in your project, ES5 and ES6 syntax. For eg - For importing CallScore Component, use the following:
ES6
import {CallScore} from '@symblai/symbl-ui-components';
ES5
const {CallScore} = require('@symblai/symbl-ui-components');
Importing
Pass generated conversation id and access token to the UI component
<CallScore conversationId={""} accessToken={""} />