Skip to content

fix(listen): warn when keywords is used with nova-3 model #480

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

Open
peteroyce wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(listen): warn when keywords is used with nova-3 model #480

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
14 changes: 14 additions & 0 deletions src/CustomClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -629,10 +629,24 @@ class WrappedAgentV1Socket extends AgentV1Socket {
* consistent behavior across Fern regenerations and allows us to customize
* connection setup, authentication, and header handling.
*/
const NOVA3_MODELS = ["nova-3", "nova-3-general", "nova-3-medical"] as const;

class WrappedListenV1Client extends ListenV1Client {
public async connect(args: Omit<ListenV1Client.ConnectArgs, "Authorization"> & { Authorization?: string }): Promise<ListenV1Socket> {
const { headers, debug, reconnectAttempts, connectionTimeoutInSeconds, abortSignal } = args;

// Warn when 'keywords' is used with nova-3 — the API rejects this combination.
// 'keywords' is not supported on nova-3; use 'keyterm' instead.
const model = (args as Record<string, unknown>).model as string | undefined;
const keywords = (args as Record<string, unknown>).keywords;
if (keywords != null && model != null && NOVA3_MODELS.some((m) => model === m || model.startsWith(m))) {
console.warn(
"[Deepgram] The 'keywords' parameter is not supported with nova-3 models and will cause " +
"the WebSocket connection to be rejected (HTTP 400). Use 'keyterm' instead. " +
"See: https://developers.deepgram.com/docs/keyterm"
);
}

const socket = await createWebSocketConnection({
options: this._options,
urlPath: "/v1/listen",
Expand Down