Merge pull request #365 from deepgram/revert/keyterms

revert: keyterm -> keyterms
deepgram · Mar 3, 2025 · 86c1716 · 86c1716
2 parents 138ce74 + 4996358
commit 86c1716
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/Deepgram/Clients/Agent/v2/Websocket/Client.cs b/Deepgram/Clients/Agent/v2/Websocket/Client.cs
@@ -52,7 +52,7 @@ public Client(string? apiKey = null, IDeepgramClientOptions? options = null) : b
     public async Task<bool> Connect(SettingsConfigurationSchema options, CancellationTokenSource? cancelToken = null, Dictionary<string, string>? addons = null,
         Dictionary<string, string>? headers = null)
     {
-        if (!options.Agent.Listen.Model.StartsWith("nova-3") && options.Agent.Listen.Keyterm?.Count > 0)
+        if (!options.Agent.Listen.Model.StartsWith("nova-3") && options.Agent.Listen.Keyterms?.Count > 0)
         {
             throw new DeepgramException("Keyterm is only supported in Nova 3 models.");
         }

diff --git a/Deepgram/Models/Agent/v2/WebSocket/Listen.cs b/Deepgram/Models/Agent/v2/WebSocket/Listen.cs
@@ -10,9 +10,13 @@ public record Listen
     [JsonPropertyName("model")]
     public string Model { get; set; }
 
+    /// <summary>
+    /// Keyterm Prompting allows you improve Keyword Recall Rate (KRR) for important keyterms or phrases up to 90%.
+    /// <see href="https://developers.deepgram.com/docs/keyterm">
+    /// </summary>
     [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
-    [JsonPropertyName("keyterm")]
-    public List<string>? Keyterm { get; set; }
+    [JsonPropertyName("keyterms")]
+    public List<string>? Keyterms { get; set; }
 
     /// <summary>
     /// Override ToString method to serialize the object

diff --git a/examples/agent/websocket/simple/Program.cs b/examples/agent/websocket/simple/Program.cs
@@ -196,7 +196,7 @@ await agentClient.Subscribe(new EventHandler<ErrorResponse>((sender, e) =>
                 settingsConfiguration.Context.Messages = new List<object> {};
                 settingsConfiguration.Context.Replay = false;
                 settingsConfiguration.Agent.Listen.Model = "nova-3";
-                settingsConfiguration.Agent.Listen.Keyterm = new List<string> { "Deepgram" };
+                settingsConfiguration.Agent.Listen.Keyterms = new List<string> { "Deepgram" };
 
                 bool bConnected = await agentClient.Connect(settingsConfiguration);
                 if (!bConnected)