Skip to content

Commit 0767584

Browse files
committed
fix: added web-core spec
1 parent e50aed2 commit 0767584

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

docs/guides/capabilities/ai/meeting-transcription.mdx

+21-6
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ sidebar_position: 1
44

55
# Meeting Transcription
66

7-
:::info alpha
8-
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).
7+
:::info beta
8+
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).
99
:::
1010

1111
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.
@@ -28,15 +28,30 @@ To learn more about how to create and edit presets, see [Presets](https://docs.d
2828

2929
## Consuming transcripts
3030

31-
There are 2 ways in which these transcripts can be consumed.
31+
There are 3 ways in which these transcripts can be consumed.
3232
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.
3333
2. Webhooks: The meeting transcript can be consumed via a [webhook after the meeting ends](#consume-transcript-via-a-post-meeting-webhook).
34+
3. REST API: The meeting transcript can also be fetched via the [rest API](/api#/operations/GetSessionTranscript).
3435

3536
### Consuming transcripts in real-time
3637

3738
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.
3839
Transcripts for all the participants having this flag set will be broadcasted in the meeting.
3940

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

4257
You can configure a webhook with the `meeting.transcript` event enabled to receive the meeting transcript after the meeting has ended.
@@ -52,13 +67,13 @@ You can use this API to get the transcript for a meeting at a later time. Dyte s
5267
The transcript is received in the form of a CSV. Here is the format of the said CSV:
5368

5469
```csv
55-
Timestamp, Peer ID, Participant ID, Custom Participant ID, Participant Name, Transcript
70+
Timestamp, Participant ID, User ID, Custom Participant ID, Participant Name, Transcript
5671
```
5772

5873
The following is a description of all the fields specified in the above CSV.
5974
1. Timestamp: An ISO 8601 format string indicating the time of utterance (or the time of speech).
60-
2. Peer 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 Participant ID but different Peer IDs.
61-
3. Participant 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).
75+
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.
76+
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).
6277
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).
6378
5. Participant Name: The display name of the user.
6479
6. Transcript: The transcribed utterance.

0 commit comments

Comments
 (0)