How to Pass Keyterm array to Deepgram via @deepgram/sdk?

[johnnydanger]

I'm trying to migrate from Keywords and the Enhanced model to nova-3 and keyterms, but there doesn't appear to be keyterm support in the newest SDK for JS. Am I missing something? Do I need to can the SDK and use cURL to get keyterms working? Thanks.

[naomi-lgbt]

Keyterm support is present.

deepgram-js-sdk/src/lib/types/TranscriptionSchema.ts

Line 100 in 6634e40

keyterm?: string[] | string;

Could you share more information, such as the code you are using?

[johnnydanger]

Prior I was using Keywords as shown below. Keywords were an array of text strings:
var keywordsArray = [ 'AcmeWidgets','Spedoinkle','FarOutAdventures' ];

And I was opening the connection using:
const deepgram = deepgramClient.listen.live({
model: "enhanced",
language: "en-US",
punctuate: true,
interim_results: true,
keywords: keywordsArray,
encoding: "linear16",
sample_rate: 44100,
channels: 1
});

I thought "keyterms will work the same!" and tried just changing the keywords property to 'keyterms'. The Deepgram documentation is nearly nonexistent on this FYI and I couldn't find anything about the proper format for the key terms array, property name, etc., but assumed it would just be the same—an array of text strings. It didn't work though. The keyterms sent didn't affect the transcription received from Deepgram. Eventually I just gave up and replaced the Deepgram JS SDK with a custom home rolled solution using cURL directly.

Now that you pointed out the above though... Ugh. You would think that the keyterms property would be "keyterms" because it's an array of keyterms. Plural! And I assumed it would be like the "keywords" property. Plural!

But now I see the err of my ways. Prior the property for the deepgramClient that expects an array of strings was "keywords" and now with keyterms the property is the not plural: "keyterm". Just tested by passing an array of strings via a "keyterm" property and it of course works fine. My mistake. That said, I was led down the wrong path based on the plural property name of 'keywords', and the new NOT plural property name of 'keyterm'.

Works fine using the code:
const deepgram = deepgramClient.listen.live({
model: "nova-3",
language: "en-US",
punctuate: true,
interim_results: true,
keyterm: keytermsArray,
});

Note to self—triple check the property names expected in the SDK code, and don't assume that what was plural prior is still plural with the new property.