/symbl-python

Primary LanguagePythonApache License 2.0Apache-2.0

Symbl Python SDK

The Symbl Python SDK provides convenient access to the Symbl API from applications written in the Python language. It includes a pre-defined set of classes for a simple and clear utilization of APIs.

Documentation

See the Python API docs.

Installation

You don't need this source code unless you want to modify the package. If you just want to use the package, just run:

pip install --upgrade symbl

Install from source with:

python setup.py install

Configuration

To initialize the SDK, you need to provide app_id and app_token which you can get by signing up on Symbl Platform.

You can either provide the api_keys by saving a file named symbl.conf in your home directory in the following format.

Home directory will be C:/Users/<Your Username> on your windows system, or ~ in your Linux or Mac system.

[credentials]
app_id=<app_id>
app_secret=<app_secret>

Requirements

  • Python 2.7+ or Python 3.4+ (PyPy supported)

Usages

The library needs to be configured with your account's credentials (appId & appSecret) which is available in your Symbl Platform.

A speech to text converter under 5 lines of code

To know more about Async Audio Api, click here. To know more about the Python SDK Audio Package, click here

import symbl

# Process audio file
conversation = symbl.Audio.process_file(
  # credentials={app_id: <app_id>, app_secret: <app_secret>}, #Optional, Don't add this parameter if you have symbl.conf file in your home directory
  file_path=<file_path>)

# Printing transcription messages
print(conversation.get_messages())

To know more about conversation object and it's functions, click here

Extracting insights from Textual conversation

To know more about Async Text Api, click here. To know more about the Python SDK Text Package, click here

import symbl

payload = {
"messages": [
  {
    "payload": {"content": "Hi Anthony. I saw your complaints about bad call reception on your mobile phone. Can I know what issues you are currently facing?"},
    "from": {"userId": "surbhi@example.com","name": "Surbhi Rathore"}
  },
  {
    "payload": {"content": "Hey Surbhi, thanks for reaching out. Whenever I am picking up the call there is a lot of white noise and I literally can’t hear anything."},
    "from": {"userId": "anthony@example.com","name": "Anthony Claudia"}
  },
  {
    "payload": {"content": "Okay. I can schedule a visit from one of our technicians for tomorrow afternoon at 1:00 PM. He can look at your mobile and handle any issue right away"},
    "from": {"userId": "surbhi@example.com","name": "Surbhi Rathore"}
  },
  {
    "payload": {"content": "That will be really helpful. I'll follow up with the technician about some other issues too, tomorrow"},
    "from": {"userId": "anthony@example.com","name": "Anthony Claudia"}
  },
  {
    "payload": {"content": "Sure. We are happy to help. I am scheduling the visit for tomorrow. Thanks for using Abccorp networks. Have a good day."},
    "from": {"userId": "surbhi@example.com","name": "Surbhi Rathore"}
  }
]
}

conversation = symbl.Text.process(payload=payload)

print(conversation.get_action_items())
print(conversation.get_topics())
print(conversation.get_follow_ups())

Analysis of your Zoom Call on your email (Symbl will join your zoom call and send you analysis on provided email)

To know more about telephony api, click here. To know more about the Python SDK Telephony Package, click here

import symbl

phoneNumber = "" # Zoom phone number to be called, check here https://us02web.zoom.us/zoomconference
meetingId = "" # Your zoom meetingId
password = "" # Your zoom meeting passcode
emailId = ""

connection = symbl.Telephony.start_pstn(
      # credentials={app_id: <app_id>, app_secret: <app_secret>}, #Optional, Don't add this parameter if you have symbl.conf file in your home directory
      phone_number=phoneNumber,
      dtmf = ",,{}#,,{}#".format(meetingId, password),
      actions = [
        {
          "invokeOn": "stop",
          "name": "sendSummaryEmail",
          "parameters": {
            "emails": [
              emailId
            ],
          },
        },
      ]
    )

print(connection)

Live audio transcript using your system's microphone

To know more about streaming api, click here. To know more about the Python SDK Streaming Package, click here

import symbl

connection = symbl.Streaming.start_connection()

connection.subscribe({'message_response': lambda response: print('got this response from callback', response)})

connection.send_audio_from_mic()

Extended Readme

You can see all the functions provided by SDK in the extended readme.md file.

Possible Errros

  1. PortAudio Errors on Mac Systems:-

    If you're getting PortAudio Error which looks like this

    sounddevice.PortAudioError: Error opening InputStream: Internal PortAudio error [PaErrorCode -9986]

    Please consider updating the PortAudio library in your system. Running the following command can help.

    brew install portaudio

Need support

If you are looking for some specific use cases do check our examples folder.

If you can't find your answers, do let us know at support@symbl.ai or join our slack channel here.