Skip to content

Commit d641c10

Browse files
committed
fix: update audio/transcription
1 parent 0767584 commit d641c10

File tree

1 file changed

+36
-7
lines changed

1 file changed

+36
-7
lines changed

docs/guides/capabilities/audio/transcriptions.mdx

+36-7
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ sidebar_slug: transcriptions-inbuilt
66

77
# Meeting Transcription
88

9-
:::info alpha
10-
The meeting transcription feature is currently in alpha, which means it is still being tested and evaluated, and may undergo some change. This feature is not accessible to the public at the moment and will be activated solely upon request, subject to our team's assessment of your usage and needs. If you wish to have this feature enabled for your organization, please [get in touch with us](https://dyte.io/contact).
9+
:::info beta
10+
The meeting transcription feature is currently in beta, which means it is still being tested and evaluated, and may undergo some change. This feature is not accessible to the public at the moment and will be activated solely upon request, subject to our team's assessment of your usage and needs. If you wish to have this feature enabled for your organization, please [get in touch with us](https://dyte.io/contact).
1111
:::
1212

1313
Dyte's meeting transcription allows you to transcribe your Dyte meetings in real-time, making it easy to capture important discussions and refer back to them later.
@@ -22,36 +22,64 @@ Dyte's AI meeting transcription currently only supports English.
2222
You can control whether or not a participant's audio will be transcribe with the help of the `transcription_enabled` flag in the participant's preset.
2323
All participants with the `transcription_enabled` turned on in their preset will be able to generate transcripts in real-time in a Dyte meeting.
2424

25-
You can create a new preset on our [Developer Portal](https://dev.dyte.io/presets), or using our [REST API](https://docs.dyte.io/api#/operations/post-presets)
25+
You can create a new preset on our [Developer Portal](https://dev.dyte.io/presets), or using our [REST API](https://docs.dyte.io/api#/operations/post-presets).
2626

27-
## Consuming transcripts
27+
:::info NOTE
28+
To learn more about how to create and edit presets, see [Presets](https://docs.dyte.io/guides/capabilities/presets).
29+
:::
2830

29-
There are 2 ways in which these transcripts can be consumed.
31+
## Consuming transcripts
3032

33+
There are 3 ways in which these transcripts can be consumed.
3134
1. Client core SDK: The transcripts can be consumed on the client-side using the Dyte SDK that's suitable for your platform. These transcripts are generated on the server in real-time.
3235
2. Webhooks: The meeting transcript can be consumed via a [webhook after the meeting ends](#consume-transcript-via-a-post-meeting-webhook).
36+
3. REST API: The meeting transcript can also be fetched via the [rest API](/api#/operations/GetSessionTranscript).
3337

3438
### Consuming transcripts in real-time
3539

3640
For consuming transcripts in real-time on the client SDK of your choice, you just need to ensure that the `transcription_enabled` flag is enabled in the preset.
3741
Transcripts for all the participants having this flag set will be broadcasted in the meeting.
3842

43+
You can use the `meeting.ai` object to access the transcripts.
44+
45+
```ts
46+
console.log(meeting.ai.transcripts);
47+
```
48+
49+
The transcripts are also emitted by the `meeting.ai` object, so a listener can be attached to it.
50+
51+
```ts
52+
meeting.ai.on('transcript', (transcriptData) => {
53+
console.log('Transcript:', transcriptData);
54+
});
55+
```
56+
3957
### Consume transcript via a post-meeting webhook
4058

4159
You can configure a webhook with the `meeting.transcript` event enabled to receive the meeting transcript after the meeting has ended.
4260
You can do this either on our [Developer Portal](https://dev.dyte.io/webhooks), or using a [REST API](https://docs.dyte.io/api#/operations/addWebhook).
4361

62+
You can see the webhook format [here](/guides/capabilities/webhooks/webhook-events#meetingtranscript).
63+
4464
## Fetch the meeting transcript
4565

46-
You do not need to rely on the webhook to get the transcript for a meeting. Dyte provides a [REST API](https://docs.dyte.io/api#/operations/GetSessionTranscript) using which you can obtain the transcripts for a particular session.
66+
You do not need to rely on the webhook to get the transcript for a meeting. Dyte provides a [REST API](/api#/operations/GetSessionTranscript) using which you can obtain the transcripts for a particular session.
4767
You can use this API to get the transcript for a meeting at a later time. Dyte stores the transcript of a meeting for 7 days since the start of the meeting.
4868

4969
The transcript is received in the form of a CSV. Here is the format of the said CSV:
5070

5171
```csv
52-
Timestamp, Participant ID, Participant Name, Transcript
72+
Timestamp, Participant ID, User ID, Custom Participant ID, Participant Name, Transcript
5373
```
5474

75+
The following is a description of all the fields specified in the above CSV.
76+
1. Timestamp: An ISO 8601 format string indicating the time of utterance (or the time of speech).
77+
2. Participant ID: An identifier for individual peers in the meeting. For instance, if the participant joins the meeting twice, both the "peers" will have the same User ID but different Participant IDs.
78+
3. User ID: An identifier for a participant in the meeting, as returned by the [add participant API call](https://docs.dyte.io/api#/operations/add_participant#response-body).
79+
4. Custom Participant ID: An identifier that you can specify to identify a user. This can be sent in the request body of the [add participant API call](https://docs.dyte.io/api#/operations/add_participant#request-body).
80+
5. Participant Name: The display name of the user.
81+
6. Transcript: The transcribed utterance.
82+
5583
## Testing transcription
5684

5785
Once you have configured a preset and a webhook according to the instructions above, you can proceed to test whether meeting transcription is working for your organization.
@@ -61,3 +89,4 @@ To test if meeting transcription has been configured for your organization, perf
6189
2. [Add a participant](https://docs.dyte.io/api#/operations/add_participant) to the meeting. Make sure that the preset you use was configured according to this guide.
6290
3. Join the meeting with the `authToken` you just obtained. As you unmute and speak, your speech should be getting transcribed in real-time for all the participants in the meeting.
6391
4. Once the meeting ends, you will be getting a webhook with the event `meeting.transcript`. The body of this webhook will consist of the entire meeting transcript.
92+

0 commit comments

Comments
 (0)