Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Full code sample is missing #389

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions .github/workflows/develop.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ on:
- 'develop'

jobs:
build:
name: Build
trigger-circleci:
runs-on: ubuntu-latest
steps:
- name: Repository Dispatch
uses: peter-evans/repository-dispatch@v1
with:
token: ${{ secrets.REPO_ACCESS_TOKEN }}
repository: ${{ secrets.REPO_NAME }}
event-type: build-staging
- name: Trigger exiting circleci job
uses: zivkaziv/circleci-trigger-github-action@master
with:
token: ${{ secrets.CCI_DOCS_TOKEN }}
branch: develop
org: rammerai
repo: docs-v1
17 changes: 8 additions & 9 deletions .github/workflows/master.yaml
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@

on:
push:
branches:
- 'master'

jobs:
build:
name: Build
trigger-circleci:
runs-on: ubuntu-latest
steps:
- name: Repository Dispatch
uses: peter-evans/repository-dispatch@v1
with:
token: ${{ secrets.REPO_ACCESS_TOKEN }}
repository: ${{ secrets.REPO_NAME }}
event-type: build-production
- name: Trigger exiting circleci job
uses: zivkaziv/circleci-trigger-github-action@master
with:
token: ${{ secrets.CCI_DOCS_TOKEN }}
branch: master
org: rammerai
repo: docs-v1
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

# Dependencies
/node_modules

Expand All @@ -18,5 +19,4 @@ config.json
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
yarn-debug.log*
File renamed without changes.
File renamed without changes.
30 changes: 0 additions & 30 deletions Dockerfile.dev

This file was deleted.

28 changes: 0 additions & 28 deletions Dockerfile.prod

This file was deleted.

28 changes: 0 additions & 28 deletions Dockerfile.stage

This file was deleted.

15 changes: 0 additions & 15 deletions Makefile

This file was deleted.

File renamed without changes.
20 changes: 0 additions & 20 deletions default

This file was deleted.

20 changes: 0 additions & 20 deletions default-dev

This file was deleted.

20 changes: 0 additions & 20 deletions default-prod

This file was deleted.

20 changes: 0 additions & 20 deletions default-stage

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ curl --location --request POST "https://api.symbl.ai/v1/conversations/$CONVERSAT
--header "Authorization: Bearer $AUTH_TOKEN" \
--data-raw '{
"name": "audio-summary",
"audioUrl": "https://storage.googleapis.com/rammer-transcription-bucket/small.mp3",
"audioUrl": "https://symbl-test-conversation.s3.amazonaws.com/4_comcast_customer_service_9min03sec.mp3",
}'
```

Expand All @@ -47,7 +47,7 @@ curl --location --request POST "https://api.symbl.ai/v1/conversations/$CONVERSAT
```javascript
{
"name": "audio-summary",
"url": "https://meetinginsights.symbl.ai/meeting/#/eyJzZXNzaW9uSWQiOiI1ODU5NjczMDg1MzEzMDI0IiwidmlkZW9VcmwiOiJodHRwczovL3N0b3JhZ2UuZ29vZ2xlYXBpcy5jb20vcmFtbWVyLXRyYW5zY3JpcHRpb24tYnVja2V0L3NtYWxsLm1wNCJ9?showVideoSummary=true"
"url": "https://meetinginsights-experience.symbl.ai/#/eyJjb252ZXJzYXRpb25JZCI6IjU5NDg0ODUwNDUwNTk1ODQiLCJhdWRpb1VybCI6Imh0dHBzOi8vc3ltYmwtdGVzdC1jb252ZXJzYXRpb24uczMuYW1hem9uYXdzLmNvbS80X2NvbWNhc3RfY3VzdG9tZXJfc2VydmljZV85bWluMDNzZWMubXAzIn0.?o=fb5a99d192b2821a40639c5c7af86021db2ed6c7e32b3a8fccf6967b7e126c4ed6bd1e4636082ba3fc3a3da3980e5b99272c241e9d44c518715bf5c9772fe3bc405efb43e2cd11ef9c6e106215034ee3ac91c8dda4c09263032103519e56c690980c1c3f07604c183b1a4ddbcfca5df6cee1f7841492017eb2bb28b761cf57f218f05e233a2f34d223d4e0e4d8615fb2fca9c31fa534237c82e276ef4c4ec2c77f4fa320a7c00cded9e897d879b0f77d819475c0383f677214fa366d85bd6b99b10e1b7f56410d1c5813fd71d8f7f441de040f0bddfe2253c6161cb9990ca47f69e052ae5553a33b3cb0fd9dff80c009b466953f671d0ddefcf4534a17b56b2a89b671c07f0bc51daa85939494423b394ada8fabd44b91efc1817e77566ead15ab69e61fe2773a4eb4086d3ae0ca6bceda3274c5361e5ad389"
}
```

Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/getting-conversation-intelligence.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To get Conversation Intelligence,

  [Step 2: Get Conversation Intelligence with Conversation API.](#2-get-conversation-intelligence-with-conversation-api)

### 1. Process conversation with Real-time OR Async API
### Step 1: Process conversation with Real-time OR Async API
---
You can process your text, audio or video conversation with Symbl using:
- [Real-time APIs](#real-time-apis) for connecting Symbl on live audio and video conversations<br/>
Expand Down Expand Up @@ -54,7 +54,7 @@ The Async API provides a REST interface that helps you submit any recorded or sa
- [Audio API](/docs/async-api/overview/audio/post-audio) for processing recorded conversations via VoIP, voice mails, and audio calls.
- [Video API](/docs/async-api/overview/video/post-video) for processing recorded conversations via video calls.

### 2. Get Conversation Intelligence with Conversation API
### Step 2: Get Conversation Intelligence with Conversation API
---

In this step, you will use the **Conversation API** to fetch Transcripts, Topics, Action Items and all the supported insights.
Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ Our REST APIs support all HTTP verbs (or methods, as they are referred to in RES

Symbl provides a suite of APIs for different usecases. Some of them are listed below: <br/>

&nbsp; &nbsp; 👉 &nbsp; [Async APIs](/docs/async-api/reference/reference) allow you to send text, audio or video conversations in recorded format. <br/>
&nbsp; &nbsp; 👉 &nbsp; [Async APIs](/docs/async-api/introduction) allow you to send text, audio or video conversations in recorded format. <br/>
&nbsp; &nbsp; 👉 &nbsp; [Streaming APIs](/docs/streamingapi/introduction) allow you to connect Symbl on a live call via WebSocket protocol.<br/>
&nbsp; &nbsp; 👉 &nbsp; [Telephony APIs](/docs/telephony/introduction) allow you to connect Symbl on an live audio conversation via SIP and PSTN.<br/>
&nbsp; &nbsp; 👉 &nbsp; [Conversation API](/docs/async-api/reference/reference) allows you to get Conversation Intelligence such as Sentiment Analysis, Action Items, Topics, Trackers, Summary and more. <br/>
&nbsp; &nbsp; 👉 &nbsp; [Conversation API](/docs/conversation-api/introduction) allows you to get Conversation Intelligence such as Sentiment Analysis, Action Items, Topics, Trackers, Summary and more. <br/>


[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/13497402-108cafc3-da45-4b00-97fe-4819894f58bb?action=collection%2Ffork&collection-url=entityId%3D13497402-108cafc3-da45-4b00-97fe-4819894f58bb%26entityType%3Dcollection%26workspaceId%3D5f563cfe-42ef-4344-a98a-eae13183fb7c)
Expand Down
2 changes: 1 addition & 1 deletion docs/async-api/overview/audio/post-audio-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ responses = {
500: 'Something went wrong! Please contact [email protected]'
}

response = requests.request("POST", url, headers=headers, data=json.dumps(payload), params=json.dumps(params)))
response = requests.request("POST", url, headers=headers, data=json.dumps(payload), params=json.dumps(params))

if response.status_code == 201:
# Successful API execution
Expand Down
4 changes: 2 additions & 2 deletions docs/async-api/overview/audio/put-audio-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ responses = {
500: 'Something went wrong! Please contact [email protected]'
}

response = requests.request("PUT", url, headers=headers, data=json.dumps(payload), params=json.dumps(params)))
response = requests.request("PUT", url, headers=headers, data=json.dumps(payload), params=json.dumps(params))

if response.status_code == 201:
# Successful API execution
Expand Down Expand Up @@ -442,4 +442,4 @@ Here value of `X` can be found in [FAQ](/docs/faq).

:::caution
You must wait for the job to complete processing before you proceed with getting the Conversation Intelligence. If you immediately make a GET request to Conversation API, it is possible that you'll receive incomplete insights. Therefore, ensure that you wait for the job to complete.
:::
:::
4 changes: 2 additions & 2 deletions docs/async-api/overview/text/post-text.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ curl --location --request POST 'https://api.symbl.ai/v1/process/text' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Business Meeting",
"detectPhrases": "True",
"detectPhrases": "true",
"confidenceThreshold": 0.6,
"messages": [
{
Expand Down Expand Up @@ -199,7 +199,7 @@ payload = {
"confidenceThreshold": 0.6,
# <Optional,double| Minimum required confidence for the insight to be recognized. Value ranges between 0.0 to 1.0. Default value is 0.5.>

"detectPhrases": True,
"detectPhrases": true,
# <Optional,boolean| It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. Default value is false.>

"messages": [
Expand Down
5 changes: 2 additions & 3 deletions docs/async-api/overview/text/put-text.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ curl --location --request PUT "https://api.symbl.ai/v1/process/text/$CONVERSATIO
--header "Authorization: Bearer $AUTH_TOKEN" \
--header 'Content-Type: application/json' \
--data-raw '{
"customEntities": [{"customType": "Hiring Process", "text": "internships"}],
"detectPhrases": "True",
"detectPhrases": "true",
"messages": [
{
"payload": {
Expand Down Expand Up @@ -218,7 +217,7 @@ payload = {

"confidenceThreshold": 0.6, # <Optional,double| Minimum required confidence for the insight to be recognized. Value ranges between 0.0 to 1.0. Default value is 0.5.>

"detectPhrases": True, # <Optional,boolean| It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. Default value is false.>
"detectPhrases": true, # <Optional,boolean| It shows Actionable Phrases in each sentence of conversation. These sentences can be found using the Conversation's Messages API. Default value is false.>
"messages": [
{
"payload": {
Expand Down
2 changes: 1 addition & 1 deletion docs/async-api/overview/video/post-video-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ payload = {
# <Optional, string| your_webhook_url| Webhook url on which job updates to be sent. (This should be post API)>
# 'customVocabulary': ['Platform', 'Discussion', 'Targets'],
# <Optional, list| custom_vocabulary_list> |Contains a list of words and phrases that provide hints to the speech recognition task.
# 'detectPhrases': True,
# 'detectPhrases': true,
# <Optional, boolean| detect_phrases |Accepted values are true & false. It shows Actionable Phrases in each sentence of conversation. These sentences can be found in the Conversation's Messages API.>
# 'languageCode': "en-US"
# <Optional, boolean| language_code> |code of language of recording.>
Expand Down
4 changes: 2 additions & 2 deletions docs/async-api/overview/video/post-video.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ const params = {
// 'customVocabulary': ['Platform', 'Discussion', 'Targets'],
// <Optional, list| custom_vocabulary_list> |Contains a list of words and phrases that provide hints to the speech recognition task.

// 'detectPhrases': True,
// 'detectPhrases': true,
// <Optional, boolean| detect_phrases> |Accepted values are true & false. It shows Actionable Phrases in each sentence of conversation. These sentences can be found in the Conversation's Messages API.

// 'languageCode': "en-US"
Expand Down Expand Up @@ -139,7 +139,7 @@ params = {
# 'customVocabulary': ['Platform', 'Discussion', 'Targets'],
# <Optional, list| custom_vocabulary_list> |Contains a list of words and phrases that provide hints to the speech recognition task.

# 'detectPhrases': True,
# 'detectPhrases': true,
# <Optional, boolean| detect_phrases> |Accepted values are true & false. It shows Actionable Phrases in each sentence of conversation. These sentences can be found in the Conversation's Messages API.

# 'languageCode': "en-US"
Expand Down
2 changes: 1 addition & 1 deletion docs/async-api/overview/video/put-video-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ payload = {
# 'customVocabulary': ['Platform', 'Discussion', 'Targets'],
# <Optional, list| custom_vocabulary_list> |Contains a list of words and phrases that provide hints to the speech recognition task.

# 'detectPhrases': True,
# 'detectPhrases': true,
# <Optional, boolean| detect_phrases> |Accepted values are true & false. It shows Actionable Phrases in each sentence of conversation. These sentences can be found in the Conversation's Messages API.

# 'languageCode': "en-US"
Expand Down
Loading