Topic Detection

Prev Next

A node that accumulates Text based events and detects the topic of accumulated text at the end of operation.

Parameters

name
description
default
IgnoreSslErrors Ignore any SSL certificate errors for the Http calls false
Credential API Key Credential for the OpenAI service empty
Model Model code of the OpenAI Version gpt-3.5-turbo

Inputs

Audio

 none

Events

name description known nodes that generate this event
Every Event that has Data.Text field. i.e SR Milestone events. Translation events, Custom events etc. SR Http, SR WebSocket, Translate

Outputs

Audio

 none

Events

name
description
Topic Detected Contains the top three topics of all the inputted text containing events received in the Data.Topics 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.

You can also see which models are available through the OpenAI Models page.

Project Structure

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

Since the Topic Detection node only needs events from the SR nodes, it can be placed wherever an SR node is utilized. A more complicated project that utilizes Topic Detection can be built as such:
image.png

Detailed Workflow

Topic Detection 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 Topic Detection node receives a Flush, it detects the topic of text it had received so far with the help of OpenAI and raises a Topic Detected event.

Supported flow types

Stream, Batch

v4.2.0
  • Deprecated the Key field in node config;
  • Added encrypted Credential dropdown for safer credential management.
v3.4.0
  • Model Parameter Added.
v3.3.0
  • Now accepts all events that have text field instead of just SR Milestone.
  • Node config now prevents saving the project if it doesn't have a proper api key.
v1.0.0
  • Introduced node.