Giter VIP home page Giter VIP logo

getting-started-samples's Introduction

Getting Started - Examples/Samples

Symbl's APIs empower developers to enable:

  • Real-time analysis of free-flowing discussions to automatically surface highly relevant summary discussion topics, contextual insights, suggestive action items, follow-ups, decisions, and questions.
  • Voice APIs that makes it easy to add AI-powered conversation intelligence to either Telephony, Streaming, or Async interfaces.
  • Conversation APIs that provide a REST interface for managing and processing your conversation data.
  • Summary UI with a fully customizable and editable reference experience that indexes a searchable transcript and shows generated actionable insights, topics, timecodes, and speaker information.

List of Examples as Code

Upload a Conversation using the Async APIs

The Async APIs allow individuals to obtain conversation intelligence on offline, pre-recorded conversations in an audio format (mp3, wav, etc). These examples demonstrate how to upload an audio or video files for processing.

Reference a URL using the Async APIs

  • Action-Items: TODO
  • Analytics: TODO
  • Entities: TODO
  • Follow-Ups: TODO
  • Messages: TODO
  • Questions: TODO
  • Summary: TODO
  • Topics: TODO
  • Trackers: TODO
  • Summary UI for Audio: TODO
  • Summary UI using a Video

Management (Tracker management)

The Management APIs allows individuals to create, list, delete Trackers that can be used to highlight important or significant words, topics, etc in a given conversation.

Real-time

These example applications use WebSockets in order to using the Streaming APIs get real-time analysis on conversation for a variety of intelligence metrics. These examples make use of the Microphone in order to demonstrate the real-time analytics capabilities.

Telephony

These example applications the Telephony APIs to get real-time analysis on conversation for a variety of intelligence metrics.

NOTE: Validation on the Telephony examples are still pending. If you notice an issue, drop us a line!

Install

Clone this repo on your machine and perform npm install.

git clone https://github.com/symblai/getting-started-samples.git
cd getting-started-samples
npm install  # Alternatively, you can also use yarn

Code samples in this repo use dotenv for configurations. Make copy of .env.default file as .env.

cp .env.default .env

Update APP_ID, APP_SECRET, and SUMMARY_EMAIL with valid values. You are going to new a Symbl account. If you don't have one, you can sign up here for a free account which will allow you to process 1,000 minutes of conversation each month. Update any additional configuration such as DEFAULT_PHONE_NUMBER may be required for a particular sample to work properly.

Run

Make sure your .env file is configured correctly.

Once you've configured the above, execute the run-examples.sh script.

Syntax: <SDK_LANG=lang> run-example.sh [API_TYPE] <PROJECT_NAME> <PARAM=VALUE>
 
Required Parameters:
- API_TYPE (required): async-upload, realtime or telephony
 
Optional parameters:
- PROJECT_NAME (optional): if missing, will provide a list of projects
- SDK_LANG (optional): environment variable to select the language
- <PARAM=VALUE> (optional): some action require user input
 
Examples:
To list examples for streaming projects, run:
run-example.sh realitime
 
To the realtime tracker example, run:
run-example.sh realitime tracker

Testing for PSTN

If you're dialing to a regular phone number then you will receive a call. If you've dialed into a meeting platform, you'll see another participant join the meeting. Begin speaking after you see new participant, the call will end and you'll receive an email with the generated insights if you have passed valid email Id in the code.

Community

If you have any questions, feel free to reach out to us at [email protected] or through our Community Slack or our forum.

This guide is actively developed, and we love to hear from you! Please feel free to create an issue or open a pull request with your questions, comments, suggestions and feedback. If you liked our integration guide, please star our repo!

This library is released under the MIT License

getting-started-samples's People

Contributors

arjun-09 avatar charlie-symbl avatar dependabot[bot] avatar dvonthenen avatar eric-giannini avatar ks436 avatar kunalsin avatar toshish avatar vnovick avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

getting-started-samples's Issues

Fix management/trackers example (create, list, delete)

Bug Report

After leaving beta, the interface changes such that the examples in this repo are no longer functional. Need to update to take advantage of the v1 API

Expected Behavior

Steps to Reproduce the Bug

Screenshots or additional information and context

Environment Details

  • Operating System:
  • Node.js version (node --version):

Diagnostics logs

Reference a URL using the Async APIs

Feature Request

There are several additional use cases which have not been implemented yet that are listed below. This would be a good first issue for someone to tackle. They involve referencing a URL of an audio/video file sitting out there on the internet (like a public S3 bucket) to process on the Symbl platform.

Reference a URL using the Async APIs

  • Action-Items
  • Analytics
  • Entities
  • Follow-Ups
  • Messages
  • Questions
  • Summary
  • Topics
  • Trackers
  • Summary UI for Tracker/Analytics
  • Summary UI for Audio

Create Python Examples and Integrate With Current Framework

Feature Request

This issue captures design and implementation for creating Python examples in this repo. The intent is to create a "mirrored" version of the node.js examples, but for Python users, developers, etc. This requires putting code into the folder examples/python, modifying scripts for execution, and ensuring that a parameter-less or "it just runs" option is the default run method.

Here is a list of requirements for this body of work:

  • Creating code in examples/python folder which contains the following API examples in order of importance:
    • async-upload examples
    • async-url examples
    • streaming examples using WebSockets
    • management examples
    • telephony examples
  • Modifying the run-example.sh to include:
    • checks to make sure python is configured properly
    • co-exists with the node.js example using the same "main" entry point script at the root of the repo
    • help to guide via examples individuals to executing either the node.js or python examples
    • Re-factor the script to fork between using a examples/node/run-example.sh and examples/python/run-example.sh
  • Modify the README to include instructions, etc

Describe alternatives you've considered

NA

Additional context

NA

Provide instructions for executing examples directly using `node`

Provide instructions for executing examples directly using node. Examples must be executed from the root of the repo in order for the .env to put up the APP_ID and APP_SECRET values.

Feature Request

Describe alternatives you've considered

Additional context

Error running node ./examples/voice-sdk/realtime-websocket-single-stream/index.js

Hi guys,

I was curious to try out the realtime websocket single stream example of this repo. I followed the steps and added my credentials, but kept running into the following error:

(node:10632) Warning: Setting the NODE_TLS_REJECT_UNAUTHORIZED environment variable to '0' makes TLS connections and HTTPS requests insecure by disabling certificate verification.
(Use `node --trace-warnings ...` to show where the warning was created)

Successfully connected. Conversation ID:  6636XXXXXXXX3040
Started listening to Microphone.
events.js:292
      throw er; // Unhandled 'error' event
      ^

Error: spawn rec ENOENT
    at Process.ChildProcess._handle.onexit (internal/child_process.js:269:19)
    at onErrorNT (internal/child_process.js:465:16)
    at processTicksAndRejections (internal/process/task_queues.js:80:21)
Emitted 'error' event on ChildProcess instance at:
    at Process.ChildProcess._handle.onexit (internal/child_process.js:275:12)
    at onErrorNT (internal/child_process.js:465:16)
    at processTicksAndRejections (internal/process/task_queues.js:80:21) {
  errno: -2,
  code: 'ENOENT',
  syscall: 'spawn rec',
  path: 'rec',
  spawnargs: [
    '-b',       '16',
    '--endian', 'little',
    '-c',       '1',
    '-r',       16000,
    '-e',       'signed-integer',
    '-t',       'raw',
    '-'
  ]
}

Any idea what could be causing this issue and how I could fix it? I am running this on Mac. I tried clearing my npm cache and reinstalling everything, but no success.

Cheers and have a nice evening,

Emelie

Internal Sample Apps

There are multiple internal sample apps. Let's move each of these to separate repos.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.