Provide Text for TODOs in Comments

.gitignore

@@ -161,7 +161,7 @@ publish/
 # Publish Web Output
 *.[Pp]ublish.xml
 *.azurePubxml
-# TODO: Comment the next line if you want to checkin your web deploy settings 
+# Comment the next line if you want to checkin your web deploy settings 
 # but database connection strings (with potential passwords) will be unencrypted
 *.pubxml
 

Deepgram/Clients/Live/v1/Client.cs

@@ -45,9 +45,9 @@ public Client(string? apiKey = null, DeepgramWsClientOptions? options = null)
     /// Fires when an event is received from the Deepgram API
     /// </summary>
     private event EventHandler<OpenResponse>? _openReceived;
-    private event EventHandler<MetadataResponse>? _metadataReceived;
-    private event EventHandler<ResultResponse>? _resultsReceived;
-    private event EventHandler<UtteranceEndResponse>? _utteranceEndReceived;
+    private event EventHandler<MetadataResponse>? _metadataReceived;
+    private event EventHandler<ResultResponse>? _resultsReceived;
+    private event EventHandler<UtteranceEndResponse>? _utteranceEndReceived;
     private event EventHandler<SpeechStartedResponse>? _speechStartedReceived;
     private event EventHandler<CloseResponse>? _closeReceived;
     private event EventHandler<UnhandledResponse>? _unhandledReceived;
@@ -105,10 +105,10 @@ public async Task Connect(LiveSchema options, CancellationTokenSource? cancellat
         }
 
         // cancelation token
-        if (cancellationToken != null)
+        if (cancellationToken != null)
         {
-            Log.Information("Connect", "Using provided cancellation token");
-            _cancellationTokenSource = cancellationToken;
+            Log.Information("Connect", "Using provided cancellation token");
+            _cancellationTokenSource = cancellationToken;
         } else
         {
             Log.Information("Connect", "Using default cancellation token");
@@ -351,7 +351,8 @@ internal async Task ProcessSendQueue()
                 Log.Verbose("ProcessSendQueue", "Reading message of queue...");
                 while (_sendChannel.Reader.TryRead(out var message))
                 {
-                    Log.Verbose("ProcessSendQueue", $"Sending message..."); // TODO: dump this message
+                    // TODO: Add logging for message capturing for possible playback
+                    Log.Verbose("ProcessSendQueue", "Sending message...");
                     lock (_mutexSend)
                     {
                         _clientWebSocket.SendAsync(message.Message, message.MessageType, true, _cancellationTokenSource.Token)

Deepgram/Clients/Speak/v1/Client.cs

@@ -78,7 +78,7 @@ public async Task<SyncResponse> ToStream(TextSource source, SpeakSchema? speakSc
                     response.Date = DateTime.Parse(item.Value);
                     break;
                 default:
-                    // TODO log this
+                    Log.Error("ToStream", $"Unknown metadata key: {key}");  
                     break;
             }
         }

Deepgram/Factory/HttpClientFactory.cs

@@ -17,12 +17,12 @@
             httpId = HTTPCLIENT_NAME;
 
         var services = new ServiceCollection();
-        services.AddHttpClient(httpId)
+        services.AddHttpClient(httpId ?? HTTPCLIENT_NAME)
             .AddTransientHttpErrorPolicy(policyBuilder =>
             policyBuilder.WaitAndRetryAsync(Backoff.DecorrelatedJitterBackoffV2(TimeSpan.FromSeconds(1), 5)));
         var sp = services.BuildServiceProvider();
 
         var client = sp.GetRequiredService<IHttpClientFactory>().CreateClient(httpId);
 
         // this is ok because we are using CancellationTokenSource with a default DefaultRESTTimeout timeout
         client.Timeout = Timeout.InfiniteTimeSpan;
@@ -46,7 +46,6 @@
                 client.DefaultRequestHeaders.Add(header.Key, header.Value);
             }
 
-        // TODO: log
         client.BaseAddress = new Uri(options.BaseAddress);
 
         return client;

Deepgram/Models/Analyze/v1/AnalyzeSchema.cs

@@ -7,67 +7,67 @@ namespace Deepgram.Models.Analyze.v1;
 public class AnalyzeSchema
 {
     /// <summary>
-    /// TODO
+    /// Callback URL to provide if you would like your submitted text to be processed.
     /// </summary>
     [JsonPropertyName("callback")]
     public string? CallBack { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Enable a callback method
     /// </summary>
     [JsonPropertyName("callback_method")]
     public string? CallbackMethod { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Define custom intents.
     /// </summary>
     [JsonPropertyName("custom_intent")]
     public List<string>? CustomIntent { get; set; }
 
     /// <summary>
-    /// TODO
+    /// When strict, the model will only return intents submitted using the custom_intent param. When extended, the model will return its own detected intents in addition to those submitted using the custom_intent param. Default: extended
     /// </summary>
     [JsonPropertyName("custom_intent_mode")]
     public string? CustomIntentMode { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Define custom topics.
     /// </summary>
     [JsonPropertyName("custom_topic")]
     public List<string>? CustomTopic { get; set; }
 
     /// <summary>
-    /// TODO
+    /// When strict, the model will only return topics submitted using the custom_topic param. When extended, the model will return its own detected topics in addition to those submitted using the custom_topic param. Default: extended
     /// </summary>
     [JsonPropertyName("custom_topic_mode")]
     public string? CustomTopicMode { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Recognizes speaker intent throughout an entire input text. Returns a list of text segments and the intents found within each segment
     /// </summary>
     [JsonPropertyName("intents")]
     public bool? Intents { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Required: en. The language of your input text. (Only English language is supported at this time)
     /// </summary>
     [JsonPropertyName("language")]
     public string? Language { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Recognizes the sentiment of the entire input text and detects a shift in sentiment throughout. Returns a list of text segments and the sentiment found within each segment.
     /// </summary>
     [JsonPropertyName("sentiment")]
     public bool? Sentiment { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Provides a brief summary of the input text.
     /// </summary>
     [JsonPropertyName("summarize")]
     public bool? Summarize { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Detects topics throughout an entire input text. Returns a list of text segments and the topics found within each segment.
     /// </summary>
     [JsonPropertyName("topics")]
     public bool? Topics { get; set; }

Deepgram/Models/Analyze/v1/Average.cs

@@ -7,13 +7,13 @@ namespace Deepgram.Models.Analyze.v1;
 public record Average
 {
     /// <summary>
-    /// TODO
+    /// Sentiment of the text segment.
     /// </summary>
     [JsonPropertyName("sentiment")]
     public string? Sentiment { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Sentiment score of the audio segment, ranging from -1 (negative sentiment) to 1 (positive sentiment), with 0 indicating neutral sentiment.
     /// </summary>
     [JsonPropertyName("sentiment_score")]
     public double? SentimentScore { get; set; }

Deepgram/Models/Analyze/v1/IntentsInfo.cs

@@ -7,19 +7,19 @@ namespace Deepgram.Models.Analyze.v1;
 public record IntentsInfo
 {
     /// <summary>
-    /// TODO
+    /// Input tokens used in the model.
     /// </summary>
     [JsonPropertyName("input_tokens")]
     public int? InputTokens { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Model UUID.
     /// </summary>
     [JsonPropertyName("model_uuid")]
     public string? ModelUuid { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Output tokens used in the model.
     /// </summary>
     [JsonPropertyName("output_tokens")]
     public int? OutputTokens { get; set; }

Deepgram/Models/Analyze/v1/Metadata.cs

@@ -25,25 +25,25 @@ public record Metadata
     public string? Language { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Intents information
     /// </summary>
     [JsonPropertyName("intents_info")]
     public IntentsInfo? IntentsInfo { get; set; }
 
     /// <summary>
-    /// TODO.
+    /// Sentiment information
     /// </summary>
     [JsonPropertyName("sentiment_info")]
     public SentimentInfo? SentimentInfo { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Summary information
     /// </summary>
     [JsonPropertyName("summary_info")]
     public SummaryInfo? SummaryInfo { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Topics information
     /// </summary>
     [JsonPropertyName("topics_info")]
     public TopicsInfo? TopicsInfo { get; set; }

Deepgram/Models/Analyze/v1/Results.cs

@@ -7,13 +7,13 @@ namespace Deepgram.Models.Analyze.v1;
 public record Results
 {
     /// <summary>
-    /// TODO
+    /// Intents <see cref="IntentGroup"/>
     /// </summary>
     [JsonPropertyName("intents")]
     public IntentGroup? Intents { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Sentiments <see cref="SentimentGroup"/>
     /// </summary>
     [JsonPropertyName("sentiments")]
     public SentimentGroup? Sentiments { get; set; }
@@ -25,7 +25,7 @@ public record Results
     public Summary? Summary { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Summary of the topics <see cref="TopicGroup"/>
     /// </summary>
     [JsonPropertyName("topics")]
     public TopicGroup? Topics { get; set; }

Deepgram/Models/Analyze/v1/Segment.cs

@@ -7,43 +7,43 @@ namespace Deepgram.Models.Analyze.v1;
 public record Segment
 {
     /// <summary>
-    /// TODO
+    /// Transcribed text
     /// </summary>
     [JsonPropertyName("text")]
     public string? Text { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Timestamp of the start of the segment
     /// </summary>
     [JsonPropertyName("start_word")]
     public int? StartWord { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Timestamp of the end of the segment
     /// </summary>
     [JsonPropertyName("end_word")]
     public int? EndWord { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Sentiment: positive, negative, neutral
     /// </summary>
     [JsonPropertyName("sentiment")]
     public string? Sentiment { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Sentiment score
     /// </summary>
     [JsonPropertyName("sentiment_score")]
     public double? SentimentScore { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Topics list
     /// </summary>
     [JsonPropertyName("topics")]
     public IReadOnlyList<Topic>? Topics { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Summary of the text
     /// </summary>
     [JsonPropertyName("intents")]
     public IReadOnlyList<Intent>? Intents { get; set; }

Deepgram/Models/Analyze/v1/SentimentGroup.cs

@@ -7,13 +7,13 @@ namespace Deepgram.Models.Analyze.v1;
 public record SentimentGroup
 {
     /// <summary>
-    /// TODO
+    /// Sentiment of the text segment.
     /// </summary>
     [JsonPropertyName("segments")]
     public IReadOnlyList<Segment>? Segments { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Sentiment of the text segment.
     /// </summary>
     [JsonPropertyName("average")]
     public Average? Average { get; set; }

Deepgram/Models/Analyze/v1/SentimentInfo.cs

@@ -7,19 +7,19 @@ namespace Deepgram.Models.Analyze.v1;
 public record SentimentInfo
 {
     /// <summary>
-    /// TODO
+    /// Input tokens used in the model.
     /// </summary>
     [JsonPropertyName("input_tokens")]
     public int? InputTokens { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Model UUID.
     /// </summary>
     [JsonPropertyName("model_uuid")]
     public string? ModelUuid { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Output tokens used in the model.
     /// </summary>
     [JsonPropertyName("output_tokens")]
     public int? OutputTokens { get; set; }

Deepgram/Models/Analyze/v1/SummaryInfo.cs

@@ -7,19 +7,19 @@ namespace Deepgram.Models.Analyze.v1;
 public record SummaryInfo
 {
     /// <summary>
-    /// TODO
+    /// Input tokens used in the model.
     /// </summary>
     [JsonPropertyName("input_tokens")]
     public int? InputTokens { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Model UUID.
     /// </summary>
     [JsonPropertyName("model_uuid")]
     public string? ModelUUID { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Output tokens used in the model.
     /// </summary>
     [JsonPropertyName("output_tokens")]
     public int? OutputTokens { get; set; }

Deepgram/Models/Analyze/v1/Topic.cs

@@ -13,7 +13,7 @@ public record Topic
     public double? Confidence { get; set; }
 
     /// <summary>
-    /// TODO
+    /// The discover topic.
     /// </summary>
     [JsonPropertyName("topic")]
     public string Text;

Deepgram/Models/Analyze/v1/TopicGroup.cs

@@ -7,7 +7,7 @@ namespace Deepgram.Models.Analyze.v1;
 public record TopicGroup
 {
     /// <summary>
-    /// TODO
+    /// Topics of the text segment.
     /// </summary>
     [JsonPropertyName("segments")]
     public IReadOnlyList<Segment>? Segments { get; set; }

Deepgram/Models/Analyze/v1/TopicsInfo.cs

@@ -7,19 +7,19 @@ namespace Deepgram.Models.Analyze.v1;
 public record TopicsInfo
 {
     /// <summary>
-    /// TODO
+    /// Input tokens used in the model.
     /// </summary>
     [JsonPropertyName("input_tokens")]
     public int? InputTokens { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Model UUID.
     /// </summary>
     [JsonPropertyName("model_uuid")]
     public string? ModelUuid { get; set; }
 
     /// <summary>
-    /// TODO
+    /// Output tokens used in the model.
     /// </summary>
     [JsonPropertyName("output_tokens")]
     public int? OutputTokens { get; set; }