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

DC-274+DC-224 #323

Merged
merged 2 commits into from
Jan 4, 2022
Merged
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
1 change: 1 addition & 0 deletions async-api/code-snippets/receive-conversation-analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

## Process video file

The first thing you need to do before getting your conversational analytics is to process your video file. This code is taken directly from our [POST Video URL](/docs/async-api/overview/video/post-video-url) page. If you want to use an audio or text file you can use the code from the [POST Audio URL](/docs/async-api/overview/audio/post-audio-url) or [POST Text File](/docs/async-api/overview/text/post-text) pages.
Expand Down
1 change: 1 addition & 0 deletions async-api/code-snippets/receive-entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

## Process video file

The first thing you need to do before getting your entities is to process your video file. This code is taken directly from our [POST Video URL](/docs/async-api/overview/video/post-video-url) page. If you want to use an audio or text file you can use the code from the [POST Audio URL](/docs/async-api/overview/audio/post-audio-url) or [POST Text File](/docs/async-api/overview/text/post-text) pages.
Expand Down
2 changes: 2 additions & 0 deletions async-api/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ sidebar_label: Introduction
slug: /async-api/introduction
---

---

The Async API provides a REST interface that helps you to submit any recorded or saved conversations to Symbl. When you submit a conversation, you'll receive a Conversation ID (`conversationId`), which is unique to your conversation.

![Async API Diagram](/img/asyncDiagram.png)
Expand Down
2 changes: 2 additions & 0 deletions async-api/overview/async-api-supported-languages.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: What languages does Async API Support?
sidebar_label: Languages Supported
---

---

The Async Audio and Async Video APIs can work with languages other than English.

The following list of languages(with their [BCP-47](https://en.wikipedia.org/wiki/IETF_language_tag) language-codes) are currently supported:
Expand Down
2 changes: 2 additions & 0 deletions async-api/overview/async-diarization.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Speaker Separation
sidebar_label: Speaker Separation
---

---

The Async Audio & Async Video APIs can detect and separate unique speakers in a single stream of audio & video without need of separate speaker events.

To enable this capability with either of the APIs the `enableSpeakerDiarization` and `diarizationSpeakerCount` query parameters need to be passed with the request.
Expand Down
2 changes: 2 additions & 0 deletions async-api/overview/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ sidebar_label: Introduction
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

The Async API provides a REST interface which helps you to submit any recorded or saved conversations to Symbl.

When you submit a conversation, you'll receive a Conversation ID (`conversationId`), which is unique to your conversation.
Expand Down
1 change: 1 addition & 0 deletions conversation-api/api-reference/analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ slug: /conversation-api/analytics
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

Analytics API provides you with functionality like finding speaker ratio, talk time, silence, pace and overlap in
a conversation.
Expand Down
2 changes: 2 additions & 0 deletions conversation-api/api-reference/conversation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /conversation-api/conversation-data
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

This API returns the conversation meta-data like meeting name, member name and email, start and end time of the meeting, meeting type and meeting ID.

It returns data for a specific conversation (using `conversationId`). If you wish to get all the conversations, see [GET All Conversations](/docs/conversation-api/all-conversations) page.
Expand Down
2 changes: 2 additions & 0 deletions conversation-api/api-reference/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ slug: /conversation-api/delete-conversation
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

This API permanently deletes conversation and all related entities such as messages, insights, topics etc. associated with the Conversation ID.

:::caution
Expand Down
1 change: 1 addition & 0 deletions conversation-api/api-reference/entities.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ slug: /conversation-api/entities
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

:::info
This is a Beta API - Undergoing further development.
Expand Down
2 changes: 2 additions & 0 deletions conversation-api/api-reference/insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ slug: /conversation-api/insights
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

Returns all the insights in a conversation including Topics, Questions and Action Items

### HTTP Request
Expand Down
2 changes: 2 additions & 0 deletions conversation-api/api-reference/members.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ slug: /conversation-api/members
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

This API returns a list of all the members in a conversation. A Member is referred to a participant in the conversation that is uniquely identified as a speaker. Identifying different participants in the meetings can be done by implementing speaker separation.

For more details on identifying members by [Speaker Events or Active Talker events](/docs/javascript-sdk/tutorials/push-speakerevents-get-summary-url) in Real-time using Voice SDK.
Expand Down
2 changes: 2 additions & 0 deletions conversation-api/api-reference/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ slug: /conversation-api/messages
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

The Messages API returns a list of all the messages in a conversation. You can use this for providing **Speech to Text data (also known as transcription sometimes)** for video conference, meeting or telephone call.

Here message refer to a continuous sentence spoken by a speaker.
Expand Down
2 changes: 2 additions & 0 deletions conversation-api/api-reference/questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ slug: /conversation-api/questions
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

This API help you find explicit question or request for information that comes up during the conversation, whether answered or not, is recognized as a question.

### HTTP Request
Expand Down
2 changes: 2 additions & 0 deletions conversation-api/api-reference/speakers.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ slug: /conversation-api/speaker-events
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

Speaker Events API provides the functionality to update Speakers who spoke in the conversation after it has been processed.

This is achieved by sending the API the list of Speaker Events for that conversation which the API then uses for associating it with the content of the same.
Expand Down
2 changes: 2 additions & 0 deletions conversation-api/api-reference/topics.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ slug: /conversation-api/get-topics
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

The most relevant topics of discussion from the conversation that are generated
based on the combination of the overall scope of the discussion.

Expand Down
2 changes: 2 additions & 0 deletions conversation-api/api-reference/transcript.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ slug: /conversation-api/transcript
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

This API returns a formatted transcript in [Markdown](#create-transcript-in-markdown) and [SRT](#create-transcript-in-srt) format.

## Create Transcript in Markdown
Expand Down
1 change: 1 addition & 0 deletions conversation-api/api-reference/update-members.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ slug: /conversation-api/update-members
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

Update an existing member in an conversation. This API can be used for updating the unique speakers detected as members from diarization as well.

Expand Down
2 changes: 2 additions & 0 deletions conversation-api/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ sidebar_label: Introduction
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

The Conversation API provides a REST API interface for getting your processed Speech to Text data(also known as Transcripts) and Conversational Insights.

To view insights about a conversion, you must provide the API with a Conversation ID.
Expand Down
2 changes: 2 additions & 0 deletions developer-tools/audio-conversion.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ sidebar_label: Audio Conversion
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

### Async Audio Conversion

Async Audio API supports files of either `.wav` or `.mp3` and the file must have `mono-channel audio` only. Any other file formats can be converted using the code snippet from [FFmpeg](https://github.com/fluent-ffmpeg/node-fluent-ffmpeg)
Expand Down
2 changes: 2 additions & 0 deletions getting-started-with-async-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import useBaseUrl from '@docusaurus/useBaseUrl';

---

Use the Async API to get speech-to-text transcription from audio or video and extract follow-ups, topics, action-items, and questions from them.

## 1. Process an audio file using Async API
Expand Down
2 changes: 2 additions & 0 deletions getting-started-with-streaming-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /getting-started-with-streaming-api
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---


The Streaming API provides live speech-to-text transcription and extracts follow-ups, topics, action-items, and questions from conversations as they unfold in real-time.

Expand Down
2 changes: 2 additions & 0 deletions getting-started-with-telephony-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /getting-started-with-telephony-api
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

Telephony API provides a speech-to-text transcription and enables you to extract follow-ups, topics, action-items, and questions from conversations over the Zoom call.

## 1. Get a transcription of your Zoom call.
Expand Down
2 changes: 2 additions & 0 deletions how-tos/build-with-amazon-chime.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ sidebar_label: Build with Amazon Chime
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

The Symbl Conversation AI Adapter for Chime SDK is the simplest way to get started with Symbl in your Amazon Chime video platform.

Currently, the Symbl Conversational AI Adapter has the following features:
Expand Down
2 changes: 2 additions & 0 deletions javascript-sdk/overview/active-speaker-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /javascript-sdk/code-snippets/active-speaker-events
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

:::note
Pushing events is optional. If you don't have audio to process, then you can skip this step.
:::
Expand Down
2 changes: 2 additions & 0 deletions javascript-sdk/overview/connect-to-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /javascript-sdk/code-snippets/connect-to-endpoints
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

The code snippet below dials in using PSTN and hangs up after 60 seconds.

<Tabs
Expand Down
2 changes: 2 additions & 0 deletions javascript-sdk/overview/streaming-audio-real-time.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /javascript-sdk/code-snippets/streaming-audio-real-time
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

This section talks about streaming the audio in real-time using the Javascript SDK. We can use this API to pass in audio via a single stream and multiple isolated streams of audio, each of which can contain one or more speaker's audio data.

:::note
Expand Down
2 changes: 2 additions & 0 deletions javascript-sdk/overview/subscribe-real-time.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /javascript-sdk/code-snippets/subscribe-real-time
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

The Symbl Javascript SDK also lets you subscribe to real-time events when you connect to one of the Endpoints specified in the above sections. These include:

* Real-Time Transcription
Expand Down
1 change: 1 addition & 0 deletions javascript-sdk/reference/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ slug: /javascript-sdk/reference
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

## Public Methods

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /javascript-sdk/code-snippets/use-languages-with-sdk
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

## Getting Started

This snippet shows how to use languages other than English and also how to set the timezone to the timezone in which the conversation is taking place.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /javascript-sdk/code-snippets/use-languages-timezones-with-sdk
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

## Getting Started

This snipet shows how to use languages other than English and also how to set the timezone to the timezone in which the conversation is taking place.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ title: Real-time Output With PSTN Dialing Using Symbl's JavaScript SDK
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

In this example let's walk through how to get the real-time transcription and insights events in a Telephone call.

Expand Down
2 changes: 2 additions & 0 deletions javascript-sdk/tutorials/pass-audio-codecs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ title: How To Pass Different Audio Codecs To Symbl Endpoint
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

Sometimes you need to pass different audio codecs when passing the audio. This
example shows how to pass them. The codecs currently supported are:

Expand Down
1 change: 1 addition & 0 deletions javascript-sdk/tutorials/push-audio-get-realtime-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Live speech to text and AI insights on local server
slug: /javascript-sdk/tutorials/receive-ai-insights-from-your-computer
---

---

In this guide you will be shown how to use Symbl's Javascript SDK to enable your device's microphone for recording audio and processing. This example was built to run on Mac or Windows PCs. You will learn how to use Symbl's API for speech-to-text transcription and real-time AI insights, such as [follow-ups](/docs/concepts/follow-ups), [action items](/docs/concepts/action-items), [topics](/docs/concepts/topics) and [questions](/docs/conversation-api/questions).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ title: Using Symbl Javascript SDK To Push Speaker Events
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

In this example, it establishes a connection using a phone number through PSTN,
to send speaker events, generate insights, and display a summary URL with the
output. You can see how to initialize the Voice SDK, connect to the endpoint,
Expand Down
2 changes: 2 additions & 0 deletions pre-built-ui/summary-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import VideoDemoButton from '@site/src/components/Button';

---

The Summary UI provides users with a translated meeting summary page with transcript, attendees, topics, action items, follows ups, and more.

You can generate the following types of Summary UI:
Expand Down
1 change: 1 addition & 0 deletions python-sdk/async-audio.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ slug: /python-sdk/async-audio
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amritesh-singh Line no. 9, should be a blank. The three lines should start after a blank line. Please change this.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please address this.


The Python SDK allow you to asynchronously send audio conversation data and generate the following:

Expand Down
1 change: 1 addition & 0 deletions python-sdk/async-text.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ slug: /python-sdk/async-api
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

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

Expand Down
2 changes: 2 additions & 0 deletions python-sdk/async-video.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /python-sdk/async-video
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

The Python SDK allow you to asynchronously send video conversation data and generate the following:

- Speech-to-Text (messages)
Expand Down
2 changes: 2 additions & 0 deletions python-sdk/conversation-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /python-sdk/conversation-api
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

The Conversation API provides a REST API interface for getting your processed Speech to Text data(also known as Transcripts) and conversational insights.

You can utilize different functions of Conversation APIs by directly utilizing `symbl.Conversations` if you have already have a `conversationId`.
Expand Down
2 changes: 2 additions & 0 deletions python-sdk/python-sdk-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /python-sdk/python-sdk-reference
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

This page contains detailed descriptions of the class and objects supported by the Symbl Python SDK.

- [Audio Class](#audio-class)
Expand Down
2 changes: 2 additions & 0 deletions python-sdk/streaming-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /python-sdk/streaming-api
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

The Streaming API is based on WebSocket protocol and can be used for real-time use cases where both the audio and its insights need to be available in real-time.

:::note
Expand Down
5 changes: 4 additions & 1 deletion python-sdk/telephony-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ slug: /python-sdk/python-sdk-telephony-api
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

This tutorial provides code snippets and instructions on how to utilize Python SDK to call Symbl's Telephony API using PSTN protocol. To view the source code, go to the [open-source repository](https://github.com/symblai/symbl-python) in GitHub.
---

This tutorial provides code snippets and instructions on how to utilize Python SDK to call Symbl's Telephony API using PSTN protocol. <br/>
To view the source code, go to the [open-source repository](https://github.com/symblai/symbl-python) in GitHub.

The Python SDK provides the following capabilities:

Expand Down
2 changes: 2 additions & 0 deletions python-sdk/telephony-sip.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /python-sdk/python-sdk-telephony-sips
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

This tutorial provides code snippets and instructions on how to utilize Python SDK to call Symbl's Telephony API using SIP. To view the source code, browse the [open-source repository](https://github.com/symblai/symbl-python) in GitHub.

The Python SDK provides the following capabilities:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /streaming-api/code-snippets/consume-trackers-with-streaming-api
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

---

Below is an example that shows how to pass Trackers in the config object for the startRealtimeRequest of the Symbl’s JS SDK. This example also shows how to consume the results of the detected Trackers in real-time.

```js
Expand Down
Loading