Skip to content

Commit

Permalink
DC-296 (#368)
Browse files Browse the repository at this point in the history
  • Loading branch information
amritesh-singh authored Feb 10, 2022
1 parent 33e67e3 commit eb01f3f
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/integrations/agora-sdk-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -791,4 +791,4 @@ The following sample project provides you an Android mobile app using the Agora
## API Reference
---
Find comprehensive information about our REST APIs in the [API Reference](https://docs.symbl.ai/docs/api-reference/getting-started) section.
Find comprehensive information about our REST APIs in the [API Reference](/docs/api-reference/getting-started) section.
16 changes: 8 additions & 8 deletions docs/javascript-sdk/reference/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Connects to the [Telephony API](/docs/telephony/introduction) endpoint using the

Name | Description
-----|------------
`config` | Options specified for the [Telephony API Configuration Object](http://docs.symbl.ai/docs/telephony-api/api-reference#request-parameters).
`config` | Options specified for the [Telephony API Configuration Object](/docs/telephony-api/api-reference#request-parameters).

#### Returns

Expand Down Expand Up @@ -124,21 +124,21 @@ sdk.stopEndpoint({

```startRealtimeRequest (<Streaming API Configuration Object> options)```

Connects to a [Streaming API](/docs/streamingapi/overview/introduction) Web Socket endpoint using the provided configuration options.
Connects to a [Streaming API](/docs/streamingapi/introduction) Web Socket endpoint using the provided configuration options.

#### Parameters

Name | Description
-----|------------
`options` | Options specified for the [Streaming API Configuration Object](https://docs.symbl.ai/docs/streaming-api/api-reference#request-parameters).
`options` | Options specified for the [Streaming API Configuration Object](/docs/streaming-api/api-reference#request-parameters).

#### Returns

A Promise which is resolved once real-time request has been established.

#### Event Handlers

View the [Event Handlers](##event-handlers-1) section below to view which event handlers can be passed to the real-time connection.
View the [Event Handlers](#event-handlers-1) section below to view which event handlers can be passed to the real-time connection.

#### Code Example

Expand Down Expand Up @@ -174,7 +174,7 @@ Subscribes to an existing connection which will fire a callback for every event

Name | Description
-----|------------
`connectionId` | You receive the connection ID after connecting with [startRealtimeRequest](#startRealtimeRequest) or [startEndpoint](#startendpoint).
`connectionId` | You receive the connection ID after connecting with [startRealtimeRequest](#startrealtimerequest) or [startEndpoint](#startendpoint).
`callback` | A callback method which will be called on for every new event.

#### Code Example
Expand Down Expand Up @@ -232,7 +232,7 @@ SpeakerEvent is a type of event Symbl can accept that provides information about

Name | Description
-----|------------
`connectionId` | You receive the connection ID after connecting with [startRealtimeRequest](#startRealtimeRequest) or [startEndpoint](#startendpoint).
`connectionId` | You receive the connection ID after connecting with [startRealtimeRequest](#startrealtimerequest) or [startEndpoint](#startendpoint).
`event` | An event (such as a [SpeakerEvent](/docs/javascript-sdk/code-snippets/active-speaker-events/#speaker-event)) which is the event to be pushed onto the connection.
`callback` | A callback method which will be called on for every new event.

Expand Down Expand Up @@ -262,7 +262,7 @@ sdk.pushEventOnConnection(

## Event Handlers

When connecting using [`startRealtimeRequest`](#startRealtimeRequest), you can pass various handlers in the configuration options which be called if the specific event attached to the handler is fired.
When connecting using [`startRealtimeRequest`](#startrealtimerequest), you can pass various handlers in the configuration options which be called if the specific event attached to the handler is fired.

#### Code Example

Expand Down Expand Up @@ -484,7 +484,7 @@ This callback provides you with any of the detected topics in real-time as they

### onTrackerResponse

This callback provides you with any of the detected trackers in real-time as they are detected. As with the [`onMessageCallback`](#onmessagecallback) this would also return every tracker in case of multiple streams.
This callback provides you with any of the detected trackers in real-time as they are detected. As with the [`onMessageCallback`](#onMessageCallback) this would also return every tracker in case of multiple streams.

#### onTrackerResponse JSON Response Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ sdk.pushEventOnConnection(connectionId, speakerEvent.toJSON(), (err) => {
});
```

This example just touches the surface of what you can do with our Streaming API. If you would like to learn more about it you can visit the [Streaming API documentation](/docs/streamingapi/overview/introduction).
This example just touches the surface of what you can do with our Streaming API. If you would like to learn more about it you can visit the [Streaming API documentation](/docs/streamingapi/introduction).

## Full Code Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ In this guide you will learn the following:
* [Handlers (handlers)](#handlers-handlers)
* [Full Configuration Object](#full-configuration-object)
* [Handle the audio stream](#handle-the-audio-stream)
* [Process speech using device's microphone](#process-speech-using-devices-microphone)
* [Process speech using device's microphone](#process-speech-using-the-devices-microphone)
* [Test](#test)
* [Grabbing the Conversation ID](#grabbing-the-conversation-id)
* [Full Code Sample](#full-code-sample)
Expand Down
2 changes: 1 addition & 1 deletion docs/python-sdk/python-sdk-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ To see an example of the usage of `put_members` functionality, go to out [GitHub

### conversation_object.put_speakers_events(parameters={})

`parameters`:- (mandatory) takes a dictionary which contains `speakerEvents`. For list of parameters accepted, see [Speaker Events Object](https://docs.symbl.ai/docs/conversation-api/speaker-events/#speaker-event-object) page.
`parameters`:- (mandatory) takes a dictionary which contains `speakerEvents`. For list of parameters accepted, see [Speaker Events Object](/docs/conversation-api/speaker-events/#speaker-event-object) page.

This API provides the functionality to update Speakers in a conversation after it has been processed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem';
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.
:::

[Symbl’s Telephony API](https://docs.symbl.ai/?shell#telephony-api) allows you to connect to any conference call system using PSTN or SIP networks. 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 Zoom call using a PSTN connection. This application uses the Symbl Javascript SDK which requires the `@symblai/symbl-js` node package. You must have an active Zoom call (no one has to be in it but yourself) and whatever you speak in the Zoom call will be taken by our API and processed for conversational insights.
[Symbl’s Telephony API](/docs/telephony/introduction) allows you to connect to any conference call system using PSTN or SIP networks. 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 Zoom call using a PSTN connection. This application uses the Symbl Javascript SDK which requires the `@symblai/symbl-js` node package. You must have an active Zoom call (no one has to be in it but yourself) and whatever you speak in the Zoom call will be taken by our API and processed for conversational insights.

:::info
You must make sure your Zoom call allows phone dial-in for this example to work correctly.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Get a live transcription in your Node.js application by making a call to a valid

This application uses the Symbl Javascript SDK which requires the `symbl-node` node package.

Making a phone call is also the quickest way to test [Symbl’s Telephony API](https://docs.symbl.ai/?shell#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), any [SIP trunks](https://en.wikipedia.org/wiki/SIP_trunking), or SIP endpoints that can be accessed over the internet using a SIP URI.
Making a phone call is also the quickest way to test [Symbl’s Telephony API](/docs/telephony/introduction). 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), any [SIP trunks](https://en.wikipedia.org/wiki/SIP_trunking), or SIP endpoints that can be accessed over the internet using a SIP URI.

### Contents

Expand Down Expand Up @@ -182,7 +182,7 @@ setTimeout(async () => {
}, 60000); // Change the 60000 with higher value if you want this to continue for more time.
```

The `stopEndpoint` will return an updated `connection` object which will have the `conversationId` in the response. You can use `conversationId` to fetch the results even after the call using the [Conversation API](https://docs.symbl.ai/#conversation-api).
The `stopEndpoint` will return an updated `connection` object which will have the `conversationId` in the response. You can use `conversationId` to fetch the results even after the call using the [Conversation API](/docs/conversation-api/introduction).


## Code Example
Expand Down

0 comments on commit eb01f3f

Please sign in to comment.