Summarization
  • 19 Jul 2024
  • 1 Minute to read
  • Contributors
  • PDF

Summarization

  • PDF

Article summary

A node that accumulates Text based events and creates a 2-3 sentence long summary in the given Language at the end of operation.

Parameters:

name
description
default
IgnoreSslErrorsIgnore any SSL certificate errors for the Http callsfalse
KeyApi key for the Summarization service[enter a valid key]
LanguageLanguage of the expected event output.tr-TR

Inputs

Audio:
none

namedescriptionknown nodes that generate this event
Every Event that has Data.Text field.i.e SR Milestone events. Translation events, Custom events.SR Http, SR WebSocket, Translation
Language ChangeLanguage Change event changes the outputted event's language.Language Identifier, Text Language Identifier

:::

Outputs

Audio:
none

Events:

name
description
SummarizeContains a 1-2 sentence summary of all the SR Milestone events receivede in the Data.Summary field.

Remarks :

Requirements
The node needs an OpenAI Api key to perform. To learn more about getting an API Key and finding it, you can refer to the OpenAI Api page.

After getting your API Key, you can learn about finding and securely using your key following the instructions on this page.

Project Structure
The node expects events from the SR Http or SR WebSocket node.
A minimum viable project that utilizes the Summarize node can be built as such:
image.png

Taking this a step further, we can create a project that identifies the spoken language, and summarizes it in the end :
image.png

Language

Note that the Language Identifier output is connected to summarization, changing its outputted language.

Detailed Workflow
Summarize node accumulates all the SR Milestone events it receives and waits for a Flush call. (eg. If the client is a Call Recorder application, Flush is typically sent at the end of a call.) When Summarize node receives a Flush, it summarizes all the text it had received so far with the help of OpenAI and raises a Summarize event.

Supported flow types: Stream, Batch


Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.