diff --git a/async-api/code-snippets/receive-conversation-analytics.md b/async-api/code-snippets/receive-conversation-analytics.md index 9df6006d..b25b9a44 100644 --- a/async-api/code-snippets/receive-conversation-analytics.md +++ b/async-api/code-snippets/receive-conversation-analytics.md @@ -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. diff --git a/async-api/code-snippets/receive-entities.md b/async-api/code-snippets/receive-entities.md index aee00d43..c703c47a 100644 --- a/async-api/code-snippets/receive-entities.md +++ b/async-api/code-snippets/receive-entities.md @@ -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. diff --git a/async-api/introduction.md b/async-api/introduction.md index f8a4b95c..9336d26d 100644 --- a/async-api/introduction.md +++ b/async-api/introduction.md @@ -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) diff --git a/async-api/overview/async-api-supported-languages.md b/async-api/overview/async-api-supported-languages.md index 5811f00c..6bb701af 100644 --- a/async-api/overview/async-api-supported-languages.md +++ b/async-api/overview/async-api-supported-languages.md @@ -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: diff --git a/async-api/overview/async-diarization.md b/async-api/overview/async-diarization.md index 021995ca..586da9ac 100644 --- a/async-api/overview/async-diarization.md +++ b/async-api/overview/async-diarization.md @@ -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. diff --git a/async-api/overview/introduction.md b/async-api/overview/introduction.md index 903b8b7d..0a91718a 100644 --- a/async-api/overview/introduction.md +++ b/async-api/overview/introduction.md @@ -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. diff --git a/conversation-api/api-reference/analytics.md b/conversation-api/api-reference/analytics.md index 62555116..84d44545 100644 --- a/conversation-api/api-reference/analytics.md +++ b/conversation-api/api-reference/analytics.md @@ -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. diff --git a/conversation-api/api-reference/conversation.md b/conversation-api/api-reference/conversation.md index 092d43bc..54824d3a 100644 --- a/conversation-api/api-reference/conversation.md +++ b/conversation-api/api-reference/conversation.md @@ -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. diff --git a/conversation-api/api-reference/delete.md b/conversation-api/api-reference/delete.md index 82f19bd4..4c928ca7 100644 --- a/conversation-api/api-reference/delete.md +++ b/conversation-api/api-reference/delete.md @@ -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 diff --git a/conversation-api/api-reference/entities.md b/conversation-api/api-reference/entities.md index b8a6ec91..53e1a575 100644 --- a/conversation-api/api-reference/entities.md +++ b/conversation-api/api-reference/entities.md @@ -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. diff --git a/conversation-api/api-reference/insights.md b/conversation-api/api-reference/insights.md index f5291ed3..7afdd20a 100644 --- a/conversation-api/api-reference/insights.md +++ b/conversation-api/api-reference/insights.md @@ -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 diff --git a/conversation-api/api-reference/members.md b/conversation-api/api-reference/members.md index 55e35c53..4e3b47c4 100644 --- a/conversation-api/api-reference/members.md +++ b/conversation-api/api-reference/members.md @@ -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. diff --git a/conversation-api/api-reference/messages.md b/conversation-api/api-reference/messages.md index 277028e3..c11de52d 100644 --- a/conversation-api/api-reference/messages.md +++ b/conversation-api/api-reference/messages.md @@ -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. diff --git a/conversation-api/api-reference/questions.md b/conversation-api/api-reference/questions.md index bc0d5ada..eddebb86 100644 --- a/conversation-api/api-reference/questions.md +++ b/conversation-api/api-reference/questions.md @@ -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 diff --git a/conversation-api/api-reference/speakers.md b/conversation-api/api-reference/speakers.md index 645c69fe..8157e3b8 100644 --- a/conversation-api/api-reference/speakers.md +++ b/conversation-api/api-reference/speakers.md @@ -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. diff --git a/conversation-api/api-reference/topics.md b/conversation-api/api-reference/topics.md index 0436e9be..580b063a 100644 --- a/conversation-api/api-reference/topics.md +++ b/conversation-api/api-reference/topics.md @@ -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. diff --git a/conversation-api/api-reference/transcript.md b/conversation-api/api-reference/transcript.md index 2e236588..973576f8 100644 --- a/conversation-api/api-reference/transcript.md +++ b/conversation-api/api-reference/transcript.md @@ -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 diff --git a/conversation-api/api-reference/update-members.md b/conversation-api/api-reference/update-members.md index 6a8fa86c..33bf024f 100644 --- a/conversation-api/api-reference/update-members.md +++ b/conversation-api/api-reference/update-members.md @@ -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. diff --git a/conversation-api/introduction.md b/conversation-api/introduction.md index 3cff2608..869977f9 100644 --- a/conversation-api/introduction.md +++ b/conversation-api/introduction.md @@ -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. diff --git a/developer-tools/audio-conversion.md b/developer-tools/audio-conversion.md index 7a75a5ed..04eafad7 100644 --- a/developer-tools/audio-conversion.md +++ b/developer-tools/audio-conversion.md @@ -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) diff --git a/getting-started-with-async-api.md b/getting-started-with-async-api.md index 72735f80..50eb5013 100644 --- a/getting-started-with-async-api.md +++ b/getting-started-with-async-api.md @@ -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 diff --git a/getting-started-with-streaming-api.md b/getting-started-with-streaming-api.md index 30e862dd..04b8d94c 100644 --- a/getting-started-with-streaming-api.md +++ b/getting-started-with-streaming-api.md @@ -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. diff --git a/getting-started-with-telephony-api.md b/getting-started-with-telephony-api.md index 77fc9217..ed91986d 100644 --- a/getting-started-with-telephony-api.md +++ b/getting-started-with-telephony-api.md @@ -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. diff --git a/how-tos/build-with-amazon-chime.md b/how-tos/build-with-amazon-chime.md index c54bb0bb..a43bc202 100644 --- a/how-tos/build-with-amazon-chime.md +++ b/how-tos/build-with-amazon-chime.md @@ -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: diff --git a/javascript-sdk/overview/active-speaker-events.md b/javascript-sdk/overview/active-speaker-events.md index a1672710..0e723996 100644 --- a/javascript-sdk/overview/active-speaker-events.md +++ b/javascript-sdk/overview/active-speaker-events.md @@ -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. ::: diff --git a/javascript-sdk/overview/connect-to-endpoints.md b/javascript-sdk/overview/connect-to-endpoints.md index 8fde19a4..2a856dba 100644 --- a/javascript-sdk/overview/connect-to-endpoints.md +++ b/javascript-sdk/overview/connect-to-endpoints.md @@ -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. +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: diff --git a/python-sdk/telephony-sip.md b/python-sdk/telephony-sip.md index 75d96992..a5793b81 100644 --- a/python-sdk/telephony-sip.md +++ b/python-sdk/telephony-sip.md @@ -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: diff --git a/streamingapi/code-snippets/consume-trackers-with-streaming-api.md b/streamingapi/code-snippets/consume-trackers-with-streaming-api.md index e9f96e41..7bed471c 100644 --- a/streamingapi/code-snippets/consume-trackers-with-streaming-api.md +++ b/streamingapi/code-snippets/consume-trackers-with-streaming-api.md @@ -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 diff --git a/streamingapi/code-snippets/detect-key-phrases.md b/streamingapi/code-snippets/detect-key-phrases.md index 94dc8084..21727793 100644 --- a/streamingapi/code-snippets/detect-key-phrases.md +++ b/streamingapi/code-snippets/detect-key-phrases.md @@ -6,6 +6,8 @@ title: Detect Key Phrases import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + :::note In Beta Phase This feature is in the Beta phase. If you have any questions, ideas or suggestions please reach us at devrelations@symbl.ai. ::: diff --git a/streamingapi/code-snippets/receive-live-captioning.md b/streamingapi/code-snippets/receive-live-captioning.md index 5ce00a15..3673b01a 100644 --- a/streamingapi/code-snippets/receive-live-captioning.md +++ b/streamingapi/code-snippets/receive-live-captioning.md @@ -6,6 +6,8 @@ title: Receive Live Captioning import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + This example goes over how you can use the Symbl Streaming API to do live captioning. This example uses both the [Symbl's Javascript SDK](/docs/javascript-sdk/overview/introduction), which is meant to be run using Node.js, and native Javascript which can be run in the browser: ## Connect diff --git a/streamingapi/code-snippets/receive-live-insights.md b/streamingapi/code-snippets/receive-live-insights.md index 6a8c9798..0b6ad8c3 100644 --- a/streamingapi/code-snippets/receive-live-insights.md +++ b/streamingapi/code-snippets/receive-live-insights.md @@ -6,6 +6,8 @@ title: Receive Live AI Insights import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + This example goes over how you can use the Symbl Streaming API to receive [Insights](/docs/conversation-api/insights), which are what the Symbl API determines to be the most important keywords or phrases used in a conversation. This example uses both the [Symbl's Javascript SDK](/docs/javascript-sdk/overview/introduction), which is meant to be run using Node.js, and native Javascript which can be run in the browser: ## Connect diff --git a/streamingapi/code-snippets/receive-live-topics.md b/streamingapi/code-snippets/receive-live-topics.md index 7aceff7f..bc9d957c 100644 --- a/streamingapi/code-snippets/receive-live-topics.md +++ b/streamingapi/code-snippets/receive-live-topics.md @@ -6,6 +6,8 @@ title: Receive Live Topics import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + This example goes over how you can use the Symbl Streaming API to receive [Topics](/docs/concepts/topics), which are what the Symbl API determines to be the most important keywords or phrases used in a conversation. This example uses both the [Symbl's Javascript SDK](/docs/javascript-sdk/overview/introduction), which is meant to be run using Node.js, and native Javascript which can be run in the browser: ## Connect diff --git a/streamingapi/code-snippets/receive-speech-to-text-for-different-languages.md b/streamingapi/code-snippets/receive-speech-to-text-for-different-languages.md index 58381296..45d44094 100644 --- a/streamingapi/code-snippets/receive-speech-to-text-for-different-languages.md +++ b/streamingapi/code-snippets/receive-speech-to-text-for-different-languages.md @@ -6,6 +6,8 @@ title: Receive Speech to Text for a different language in a conversation import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + This example goes over how you can use the Symbl Streaming API to receive a speech-to-text transcription of a conversation in many different languages. This example uses both the [Symbl's Javascript SDK](/docs/javascript-sdk/overview/introduction) and native Javascript. :::note diff --git a/streamingapi/code-snippets/start-and-stop-streaming-api-connection.md b/streamingapi/code-snippets/start-and-stop-streaming-api-connection.md index 78127588..19475cae 100644 --- a/streamingapi/code-snippets/start-and-stop-streaming-api-connection.md +++ b/streamingapi/code-snippets/start-and-stop-streaming-api-connection.md @@ -7,6 +7,8 @@ slug: /streamingapi/code-snippets/start-and-stop-connection import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + ## Start Connection Use this code to start a connection to the Streaming API using Javascript WebSockets. This example uses both the [Symbl's Javascript SDK](/docs/javascript-sdk/overview/introduction), which is meant to be run using Node.js, and native Javascript which can be run in the browser: diff --git a/streamingapi/concepts.md b/streamingapi/concepts.md index 33fecb9d..5019f5c1 100644 --- a/streamingapi/concepts.md +++ b/streamingapi/concepts.md @@ -8,6 +8,8 @@ slug: /concepts/websockets import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + Symbl's Streaming API is based on WebSocket protocol. This Web Socket is a general-purpose protocol that suits any application designed for real-time, two-way communication within a browser — like chat apps, collaboration software, and multiplayer games. ## What is a Websocket? diff --git a/streamingapi/introduction.md b/streamingapi/introduction.md index 97747f05..2ac108c0 100644 --- a/streamingapi/introduction.md +++ b/streamingapi/introduction.md @@ -11,7 +11,6 @@ import TabItem from '@theme/TabItem'; --- - Symbl's Streaming API is based on WebSocket protocol and can be used for real-time use-cases where both the audio and its results from Symbl's back-end need to be available in real-time. It can be integrated directly via the browser or server. :::info Identification and Redaction of PII data diff --git a/streamingapi/tutorials/get-real-time-sentiment-analysis.md b/streamingapi/tutorials/get-real-time-sentiment-analysis.md index 9fa6f50a..a3e5027d 100644 --- a/streamingapi/tutorials/get-real-time-sentiment-analysis.md +++ b/streamingapi/tutorials/get-real-time-sentiment-analysis.md @@ -7,6 +7,8 @@ slug: /streamingapi/tutorials/get-real-time-sentiment-analysis-from-your-web-bro import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + In this guide you will learn how to get started with Symbl’s native Streaming API, which is our most accurate API for conversation analysis. Symbl's Streaming API is an API for enabling real-time conversational analysis on voice, video, or chat, or any live streaming directly through your web browser. If you have voice, video, or chat enabled, Symbl's API for streaming enables you to tap the raw conversational data of those streams. In addition to the setting up Symbl.ai's Streaming API, you create a function that logs sentiment analysis in real-time. Sentiment analysis operates through a call to the Message API with a query parameter. You can view the complete code sample for this tutorial on [GitHub](https://github.com/symblai/logging-real-time-sentiments): diff --git a/streamingapi/tutorials/get-realtime-transcription.md b/streamingapi/tutorials/get-realtime-transcription.md index d6cf5dd4..f8206689 100644 --- a/streamingapi/tutorials/get-realtime-transcription.md +++ b/streamingapi/tutorials/get-realtime-transcription.md @@ -7,6 +7,8 @@ slug: /streamingapi/tutorials/receive-ai-insights-from-your-web-browser import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + In this guide you will learn how to get started with Symbl’s native Streaming API, which is our most accurate API for conversation analysis. Symbl's Streaming API is an API for enabling real-time conversational analysis on voice, video, or chat, or any live streaming directly through your web browser. If you have voice, video, or chat enabled, Symbl's API for streaming enables you to tap the raw conversational data of those streams. You can view the complete code sample for this tutorial on [GitHub](https://github.com/symblai/real-time-speech-recognition-with-websockets): diff --git a/telephony/code-snippets/connect-to-pstn.md b/telephony/code-snippets/connect-to-pstn.md index fd144547..2eabee46 100644 --- a/telephony/code-snippets/connect-to-pstn.md +++ b/telephony/code-snippets/connect-to-pstn.md @@ -5,6 +5,8 @@ title: Connect to a PSTN connection to get Speech to Text and AI Insights import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + ## Connect to a call with PSTN The following code example shows how you can connect the Telephony API to your cell phone or any other type of phone number using PSTN (**Currently, only US phone numbers work**). Making a phone call is also the quickest way to test Symbl’s Telephony API. It can make an outbound call to a phone number using a traditional public switched telephony network ([PSTN](https://en.wikipedia.org/wiki/Public_switched_telephone_network)). diff --git a/telephony/code-snippets/connect-to-sip.md b/telephony/code-snippets/connect-to-sip.md index 804a07ce..620fd6ca 100644 --- a/telephony/code-snippets/connect-to-sip.md +++ b/telephony/code-snippets/connect-to-sip.md @@ -5,6 +5,8 @@ title: Connect to a SIP connection to get Speech to Text and AI Insights import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + ## Connect to a call The following code sample shows how you can connect the Telephony API to your cell phone (or any other type of phone number). Making a phone call is also the quickest way to test Symbl’s Telephony API. It can make an outbound call to a phone number using SIP endpoints that can be accessed over the internet using a SIP URI. diff --git a/telephony/code-snippets/receive-prebuilt-ui-email-after-conversation.md b/telephony/code-snippets/receive-prebuilt-ui-email-after-conversation.md index 047ccf2c..4d7c70ff 100644 --- a/telephony/code-snippets/receive-prebuilt-ui-email-after-conversation.md +++ b/telephony/code-snippets/receive-prebuilt-ui-email-after-conversation.md @@ -5,6 +5,8 @@ title: Receive Prebuilt Summary UI email after each conversation import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + This snippet goes into detail about how to receive Symbl's Prebuilt Summary UI email after a conversation is finished. The Prebuilt Summary UI email details the conversation using speech-to-text transcription and shows any AI insights gathered during the conversation. This example uses both the [Symbl's Javascript SDK](/docs/javascript-sdk/overview/introduction) and native Javascript. #### This is an example of the summary page you can expect to receive at the end of your call diff --git a/telephony/code-snippets/receive-speech-to-text-for-a-different-language.md b/telephony/code-snippets/receive-speech-to-text-for-a-different-language.md index e79b9bb0..e3ab4672 100644 --- a/telephony/code-snippets/receive-speech-to-text-for-a-different-language.md +++ b/telephony/code-snippets/receive-speech-to-text-for-a-different-language.md @@ -5,6 +5,8 @@ title: Receive Speech-to-Text for a different language in a Conversation import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + This example goes over how you can use the Symbl Telephony API to receive a speech-to-text transcription Íof a conversation in many different languages. This example uses both the [Symbl's Javascript SDK](/docs/javascript-sdk/overview/introduction) and native Javascript. :::note diff --git a/telephony/concepts/concepts.md b/telephony/concepts/concepts.md index 11648e01..af981354 100644 --- a/telephony/concepts/concepts.md +++ b/telephony/concepts/concepts.md @@ -6,6 +6,8 @@ slug: /concepts/pstn-and-sip import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + This API supports dialing through a simple phone number - `PSTN` or a Voice Over IP system - `SIP` endpoint. If you don't have your own Voice over IP (VoIP) system, use a phone number to make the connection. ### Session Initiation Protocol (SIP) diff --git a/telephony/tutorials/connect-to-zoom-with-telephony-api.md b/telephony/tutorials/connect-to-zoom-with-telephony-api.md index 6ba87ab2..926a2e23 100644 --- a/telephony/tutorials/connect-to-zoom-with-telephony-api.md +++ b/telephony/tutorials/connect-to-zoom-with-telephony-api.md @@ -7,6 +7,8 @@ slug: /telephony/tutorials/connect-to-zoom import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + :::info This guide uses a **PSTN** connection to connect to Zoom. **PSTN** audio quality maxes out to 8KHz. You can also use a **[SIP-based connection](/docs/concepts/pstn-and-sip#sip-session-initiation-protocol)**, which captures audio at 16KHz and above. ::: diff --git a/telephony/tutorials/get-live-transcription-telephony-api.md b/telephony/tutorials/get-live-transcription-telephony-api.md index ca94568a..5f9e42d2 100644 --- a/telephony/tutorials/get-live-transcription-telephony-api.md +++ b/telephony/tutorials/get-live-transcription-telephony-api.md @@ -7,6 +7,8 @@ slug: /telephony/tutorials/connect-to-phone-call import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +--- + Get a live transcription in your Node.js application by making a call to a valid phone number. In this guide, we will walk you through how to get a live 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) of a phone call using a PSTN or SIP connection. This application uses the Symbl Javascript SDK which requires the `symbl-node` node package. diff --git a/tutorials/summarization/adding-speaker-info.md b/tutorials/summarization/adding-speaker-info.md index 9f3b5597..06ba6d54 100644 --- a/tutorials/summarization/adding-speaker-info.md +++ b/tutorials/summarization/adding-speaker-info.md @@ -24,10 +24,6 @@ To send the speaker information, you can use the [POST Async Text API](/docs/asy You can use an email conversation as the input of the transcript content in the Async Text API. You can submit the email content in the request for the Async text API. - -> **Beginner Tip**
-If you are using the Summary API for the first time, the Async Text API is the simplest way to get started and work your way up to creating Summarization for recorded Audio and Video files. - - #### Async Audio/Async Video API You can choose from any of the following ways to provide speaker separation based on your scenario: