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.

Sign up for GitHub

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-127 #432

Merged
merged 1 commit into from
Mar 21, 2022
Merged

DC-127 #432

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 6 additions & 2 deletions docs/conversation-api/api-reference/summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,15 @@ This API allows you to get a [Summary](/docs/concepts/summarization) of importan
Currently, Summaries cannot be generated in real-time. Support for creating Summary in real-time will be added soon.

:::caution
The Summary API generates high-quality Summaries for longer meetings so it is recommended that you use longer meetings with Summary API. <br/>
If the number of words in a conversation is below 50 or the number of sentences below 3, the Summary will not be created.
The Summary API generates high-quality Summaries for longer meetings so it is recommended that you use longer meetings with Summary API.
:::

:::note recommendations

For generating Summarization, we recommend the following:
- The number of words in the conversation should be above 85 words.
- The speaker information should be passed in generate Summary request. Learn how to provide speaker information in [Provide Speaker Information to generate Summary](/docs/tutorials/summarization/adding-speaker-info/) page.
:::

### API Endpoint
**<font color="orange">GET</font> `https://api.symbl.ai/v1/conversations/{conversationId}/summary`**
Expand Down