GuidesAPI ReferenceSDKsIntegrationsWhat's New?
Guides

Async API - Text

Suggest Edits

The Python SDK allow you to asynchronously send text conversation and generate the following insights:

  • Speech-to-Text (messages)
  • Action Items
  • Questions
  • Topics
  • Follow-ups
  • Members (a list of participants in a conversation).

You can also utilize the parameters function to send additional parameters supported in the Async Text API. You can pass any query parameter using parameters.

Sample Code

import symbl
request_body ={
   "name": "Business Meeting",
   "confidenceThreshold": 0.6,
   "detectPhrases": True,
   "messages": [
     {
       "duration": {
         "startTime": "2020-07-21T16:04:19.99Z",
         "endTime": "2020-07-21T16:04:20.99Z"
       },
       "payload": {
         "content": "Hello.  So this is a live demo that we are trying to give very we are going to show how the platform detects various insights can do transcription in real-time and also the different topics of discussions, which would be generated after the call is over, and they will be an email that will be sent to the inbox.  So that is the idea.  So I am going to do a quick conversation.  I would say where I will demonstrate all of this great catching up.  Thanks for calling good to hear.  From you.  And I would love to hear more about what you have to offer?  I will set up a time and appointment probably sometime tomorrow evening where we can go over the documents that you are providing.  I love all the plants.  I just need to discuss with my family in terms of which one will we go forward with it?  It very excited to hear from you and the discount and look forward to talking sharply.  I have a quick question though.  Is there basically website?  Where I can go to and look at all these details myself.  It will be very helpful.  Can you also share the quotation to me on email so that I can go ahead and talk about it with my other kind of folks in the family? Thanks a lot.  Thanks for calling good catching up.  Talk soon.",
         "contentType": "text/plain"
       },
       "from": {
         "name": "John",
         "userId": "[email protected]"
       }
     }
   ]
 }
conversation_object = symbl.Text.process(payload=request_body)

print(conversation_object.get_messages()) 
print(conversation_object.get_topics()) 

# You can use the same code to generate other insights such as:
# print(conversation_object.get_action_items()) 
# print(conversation_object.get_follow_ups()) 
# print(conversation_object.get_questions())
# print(conversation_object.get_members())

Using Parameters

Any parameter that is supported for Async text API can be provided in the request_body format.

For the complete list of supported parameters, see Process Text.

Appending Text API

To append text conversation already processed by Symbl, you must use the .append function as shown below: 

conversation_object = symbl.Text.append(payload=request_body, conversation_id='5274326339158016')

A complete sample of the append function is given below: 

import symbl

 request_body ={
   "name": "Business Meeting",
   "confidenceThreshold": 0.6,
   "detectPhrases": True,
   "messages": [
     {
       "duration": {
         "startTime": "2020-07-21T16:04:19.99Z",
         "endTime": "2020-07-21T16:04:20.99Z"
       },
       "payload": {
         "content": "Hello.  So this is a live demo that we are trying to give very we are going to show how the platform detects various insights can do transcription in real-time and also the different topics of discussions, which would be generated after the call is over, and they will be an email that will be sent to the inbox.  So that is the idea.  So I am going to do a quick conversation.  I would say where I will demonstrate all of this great catching up.  Thanks for calling good to hear.  From you.  And I would love to hear more about what you have to offer?  I will set up a time and appointment probably sometime tomorrow evening where we can go over the documents that you are providing.  I love all the plants.  I just need to discuss with my family in terms of which one will we go forward with it?  It very excited to hear from you and the discount and look forward to talking sharply.  I have a quick question though.  Is there basically website?  Where I can go to and look at all these details myself.  It will be very helpful.  Can you also share the quotation to me on email so that I can go ahead and talk about it with my other kind of folks in the family? Thanks a lot.  Thanks for calling good catching up.  Talk soon.",
         "contentType": "text/plain"
       },
       "from": {
         "name": "John",
         "userId": "[email protected]"
       }
     }
   ]
 }
conversation_object = symbl.Text.append(payload=request_body, conversation_id='5274326339158016')

print(conversation_object.get_messages())
print(conversation_object.get_topics()) 

# You can use the same code to generate other insights such as:
# print(conversation_object.get_action_items()) 
# print(conversation_object.get_follow_ups()) 
# print(conversation_object.get_questions())
# print(conversation_object.get_members())

Utilizing the wait Parameter

Use the wait parameter (by default set to True) while making concurrent API calls. Setting the value wait=False will execute an existing function on a separate thread making it a non-blocking API call. It also has the callback support.

Example:

conversation_object = symbl.Text.process(payload=request_body, wait=False)

Python SDK Reference

For a complete list of supported classes and objects in the Python SDK, see the Python SDK Reference page.

You can view more capabilities added to Async text API in the following sections:

Updated almost 2 years ago