diff --git a/.gitignore b/.gitignore index 5ddc16d5..866918b1 100644 --- a/.gitignore +++ b/.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 diff --git a/Deepgram/Clients/Live/v1/Client.cs b/Deepgram/Clients/Live/v1/Client.cs index 4110d6d3..7d763f5f 100644 --- a/Deepgram/Clients/Live/v1/Client.cs +++ b/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 /// private event EventHandler? _openReceived; - private event EventHandler? _metadataReceived; - private event EventHandler? _resultsReceived; - private event EventHandler? _utteranceEndReceived; + private event EventHandler? _metadataReceived; + private event EventHandler? _resultsReceived; + private event EventHandler? _utteranceEndReceived; private event EventHandler? _speechStartedReceived; private event EventHandler? _closeReceived; private event EventHandler? _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) diff --git a/Deepgram/Clients/Speak/v1/Client.cs b/Deepgram/Clients/Speak/v1/Client.cs index 79933e27..2eaa8ab1 100644 --- a/Deepgram/Clients/Speak/v1/Client.cs +++ b/Deepgram/Clients/Speak/v1/Client.cs @@ -78,7 +78,7 @@ public async Task ToStream(TextSource source, SpeakSchema? speakSc response.Date = DateTime.Parse(item.Value); break; default: - // TODO log this + Log.Error("ToStream", $"Unknown metadata key: {key}"); break; } } diff --git a/Deepgram/Factory/HttpClientFactory.cs b/Deepgram/Factory/HttpClientFactory.cs index 58529793..2a9ba119 100644 --- a/Deepgram/Factory/HttpClientFactory.cs +++ b/Deepgram/Factory/HttpClientFactory.cs @@ -17,7 +17,7 @@ public static HttpClient Create(string? httpId = null) 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(); @@ -46,7 +46,6 @@ internal static HttpClient ConfigureDeepgram(HttpClient client, DeepgramHttpClie client.DefaultRequestHeaders.Add(header.Key, header.Value); } - // TODO: log client.BaseAddress = new Uri(options.BaseAddress); return client; diff --git a/Deepgram/Models/Analyze/v1/AnalyzeSchema.cs b/Deepgram/Models/Analyze/v1/AnalyzeSchema.cs index f2fb3afe..2bf99503 100644 --- a/Deepgram/Models/Analyze/v1/AnalyzeSchema.cs +++ b/Deepgram/Models/Analyze/v1/AnalyzeSchema.cs @@ -7,67 +7,67 @@ namespace Deepgram.Models.Analyze.v1; public class AnalyzeSchema { /// - /// TODO + /// Callback URL to provide if you would like your submitted text to be processed. /// [JsonPropertyName("callback")] public string? CallBack { get; set; } /// - /// TODO + /// Enable a callback method /// [JsonPropertyName("callback_method")] public string? CallbackMethod { get; set; } /// - /// TODO + /// Define custom intents. /// [JsonPropertyName("custom_intent")] public List? CustomIntent { get; set; } /// - /// 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 /// [JsonPropertyName("custom_intent_mode")] public string? CustomIntentMode { get; set; } /// - /// TODO + /// Define custom topics. /// [JsonPropertyName("custom_topic")] public List? CustomTopic { get; set; } /// - /// 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 /// [JsonPropertyName("custom_topic_mode")] public string? CustomTopicMode { get; set; } /// - /// TODO + /// Recognizes speaker intent throughout an entire input text. Returns a list of text segments and the intents found within each segment /// [JsonPropertyName("intents")] public bool? Intents { get; set; } /// - /// TODO + /// Required: en. The language of your input text. (Only English language is supported at this time) /// [JsonPropertyName("language")] public string? Language { get; set; } /// - /// 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. /// [JsonPropertyName("sentiment")] public bool? Sentiment { get; set; } /// - /// TODO + /// Provides a brief summary of the input text. /// [JsonPropertyName("summarize")] public bool? Summarize { get; set; } /// - /// TODO + /// Detects topics throughout an entire input text. Returns a list of text segments and the topics found within each segment. /// [JsonPropertyName("topics")] public bool? Topics { get; set; } diff --git a/Deepgram/Models/Analyze/v1/Average.cs b/Deepgram/Models/Analyze/v1/Average.cs index 74e6f045..87419b78 100644 --- a/Deepgram/Models/Analyze/v1/Average.cs +++ b/Deepgram/Models/Analyze/v1/Average.cs @@ -7,13 +7,13 @@ namespace Deepgram.Models.Analyze.v1; public record Average { /// - /// TODO + /// Sentiment of the text segment. /// [JsonPropertyName("sentiment")] public string? Sentiment { get; set; } /// - /// TODO + /// Sentiment score of the audio segment, ranging from -1 (negative sentiment) to 1 (positive sentiment), with 0 indicating neutral sentiment. /// [JsonPropertyName("sentiment_score")] public double? SentimentScore { get; set; } diff --git a/Deepgram/Models/Analyze/v1/IntentsInfo.cs b/Deepgram/Models/Analyze/v1/IntentsInfo.cs index 0eefedad..3b18d83e 100644 --- a/Deepgram/Models/Analyze/v1/IntentsInfo.cs +++ b/Deepgram/Models/Analyze/v1/IntentsInfo.cs @@ -7,19 +7,19 @@ namespace Deepgram.Models.Analyze.v1; public record IntentsInfo { /// - /// TODO + /// Input tokens used in the model. /// [JsonPropertyName("input_tokens")] public int? InputTokens { get; set; } /// - /// TODO + /// Model UUID. /// [JsonPropertyName("model_uuid")] public string? ModelUuid { get; set; } /// - /// TODO + /// Output tokens used in the model. /// [JsonPropertyName("output_tokens")] public int? OutputTokens { get; set; } diff --git a/Deepgram/Models/Analyze/v1/Metadata.cs b/Deepgram/Models/Analyze/v1/Metadata.cs index 42129dea..558a9b7b 100644 --- a/Deepgram/Models/Analyze/v1/Metadata.cs +++ b/Deepgram/Models/Analyze/v1/Metadata.cs @@ -25,25 +25,25 @@ public record Metadata public string? Language { get; set; } /// - /// TODO + /// Intents information /// [JsonPropertyName("intents_info")] public IntentsInfo? IntentsInfo { get; set; } /// - /// TODO. + /// Sentiment information /// [JsonPropertyName("sentiment_info")] public SentimentInfo? SentimentInfo { get; set; } /// - /// TODO + /// Summary information /// [JsonPropertyName("summary_info")] public SummaryInfo? SummaryInfo { get; set; } /// - /// TODO + /// Topics information /// [JsonPropertyName("topics_info")] public TopicsInfo? TopicsInfo { get; set; } diff --git a/Deepgram/Models/Analyze/v1/Results.cs b/Deepgram/Models/Analyze/v1/Results.cs index 15049564..d5a2c5e0 100644 --- a/Deepgram/Models/Analyze/v1/Results.cs +++ b/Deepgram/Models/Analyze/v1/Results.cs @@ -7,13 +7,13 @@ namespace Deepgram.Models.Analyze.v1; public record Results { /// - /// TODO + /// Intents /// [JsonPropertyName("intents")] public IntentGroup? Intents { get; set; } /// - /// TODO + /// Sentiments /// [JsonPropertyName("sentiments")] public SentimentGroup? Sentiments { get; set; } @@ -25,7 +25,7 @@ public record Results public Summary? Summary { get; set; } /// - /// TODO + /// Summary of the topics /// [JsonPropertyName("topics")] public TopicGroup? Topics { get; set; } diff --git a/Deepgram/Models/Analyze/v1/Segment.cs b/Deepgram/Models/Analyze/v1/Segment.cs index e31d946e..8af512d3 100644 --- a/Deepgram/Models/Analyze/v1/Segment.cs +++ b/Deepgram/Models/Analyze/v1/Segment.cs @@ -7,43 +7,43 @@ namespace Deepgram.Models.Analyze.v1; public record Segment { /// - /// TODO + /// Transcribed text /// [JsonPropertyName("text")] public string? Text { get; set; } /// - /// TODO + /// Timestamp of the start of the segment /// [JsonPropertyName("start_word")] public int? StartWord { get; set; } /// - /// TODO + /// Timestamp of the end of the segment /// [JsonPropertyName("end_word")] public int? EndWord { get; set; } /// - /// TODO + /// Sentiment: positive, negative, neutral /// [JsonPropertyName("sentiment")] public string? Sentiment { get; set; } /// - /// TODO + /// Sentiment score /// [JsonPropertyName("sentiment_score")] public double? SentimentScore { get; set; } /// - /// TODO + /// Topics list /// [JsonPropertyName("topics")] public IReadOnlyList? Topics { get; set; } /// - /// TODO + /// Summary of the text /// [JsonPropertyName("intents")] public IReadOnlyList? Intents { get; set; } diff --git a/Deepgram/Models/Analyze/v1/SentimentGroup.cs b/Deepgram/Models/Analyze/v1/SentimentGroup.cs index b1ddee0d..0da88074 100644 --- a/Deepgram/Models/Analyze/v1/SentimentGroup.cs +++ b/Deepgram/Models/Analyze/v1/SentimentGroup.cs @@ -7,13 +7,13 @@ namespace Deepgram.Models.Analyze.v1; public record SentimentGroup { /// - /// TODO + /// Sentiment of the text segment. /// [JsonPropertyName("segments")] public IReadOnlyList? Segments { get; set; } /// - /// TODO + /// Sentiment of the text segment. /// [JsonPropertyName("average")] public Average? Average { get; set; } diff --git a/Deepgram/Models/Analyze/v1/SentimentInfo.cs b/Deepgram/Models/Analyze/v1/SentimentInfo.cs index 991a9ee2..fe0c536f 100644 --- a/Deepgram/Models/Analyze/v1/SentimentInfo.cs +++ b/Deepgram/Models/Analyze/v1/SentimentInfo.cs @@ -7,19 +7,19 @@ namespace Deepgram.Models.Analyze.v1; public record SentimentInfo { /// - /// TODO + /// Input tokens used in the model. /// [JsonPropertyName("input_tokens")] public int? InputTokens { get; set; } /// - /// TODO + /// Model UUID. /// [JsonPropertyName("model_uuid")] public string? ModelUuid { get; set; } /// - /// TODO + /// Output tokens used in the model. /// [JsonPropertyName("output_tokens")] public int? OutputTokens { get; set; } diff --git a/Deepgram/Models/Analyze/v1/SummaryInfo.cs b/Deepgram/Models/Analyze/v1/SummaryInfo.cs index 881ee448..9e0f9b8e 100644 --- a/Deepgram/Models/Analyze/v1/SummaryInfo.cs +++ b/Deepgram/Models/Analyze/v1/SummaryInfo.cs @@ -7,19 +7,19 @@ namespace Deepgram.Models.Analyze.v1; public record SummaryInfo { /// - /// TODO + /// Input tokens used in the model. /// [JsonPropertyName("input_tokens")] public int? InputTokens { get; set; } /// - /// TODO + /// Model UUID. /// [JsonPropertyName("model_uuid")] public string? ModelUUID { get; set; } /// - /// TODO + /// Output tokens used in the model. /// [JsonPropertyName("output_tokens")] public int? OutputTokens { get; set; } diff --git a/Deepgram/Models/Analyze/v1/Topic.cs b/Deepgram/Models/Analyze/v1/Topic.cs index be96b3f8..4a1c090f 100644 --- a/Deepgram/Models/Analyze/v1/Topic.cs +++ b/Deepgram/Models/Analyze/v1/Topic.cs @@ -13,7 +13,7 @@ public record Topic public double? Confidence { get; set; } /// - /// TODO + /// The discover topic. /// [JsonPropertyName("topic")] public string Text; diff --git a/Deepgram/Models/Analyze/v1/TopicGroup.cs b/Deepgram/Models/Analyze/v1/TopicGroup.cs index 265b154b..c3d6fb4c 100644 --- a/Deepgram/Models/Analyze/v1/TopicGroup.cs +++ b/Deepgram/Models/Analyze/v1/TopicGroup.cs @@ -7,7 +7,7 @@ namespace Deepgram.Models.Analyze.v1; public record TopicGroup { /// - /// TODO + /// Topics of the text segment. /// [JsonPropertyName("segments")] public IReadOnlyList? Segments { get; set; } diff --git a/Deepgram/Models/Analyze/v1/TopicsInfo.cs b/Deepgram/Models/Analyze/v1/TopicsInfo.cs index d49ee495..d65f5abf 100644 --- a/Deepgram/Models/Analyze/v1/TopicsInfo.cs +++ b/Deepgram/Models/Analyze/v1/TopicsInfo.cs @@ -7,19 +7,19 @@ namespace Deepgram.Models.Analyze.v1; public record TopicsInfo { /// - /// TODO + /// Input tokens used in the model. /// [JsonPropertyName("input_tokens")] public int? InputTokens { get; set; } /// - /// TODO + /// Model UUID. /// [JsonPropertyName("model_uuid")] public string? ModelUuid { get; set; } /// - /// TODO + /// Output tokens used in the model. /// [JsonPropertyName("output_tokens")] public int? OutputTokens { get; set; } diff --git a/Deepgram/Models/Live/v1/Average.cs b/Deepgram/Models/Live/v1/Average.cs index e9a264a3..9f93eb18 100644 --- a/Deepgram/Models/Live/v1/Average.cs +++ b/Deepgram/Models/Live/v1/Average.cs @@ -7,13 +7,13 @@ namespace Deepgram.Models.Live.v1; public record Average { /// - /// TODO + /// Sentiment: Positive, Negative, or Neutral. /// [JsonPropertyName("sentiment")] public string? Sentiment { get; set; } /// - /// TODO + /// Sentiment score. /// [JsonPropertyName("sentiment_score")] public double? SentimentScore { get; set; } diff --git a/Deepgram/Models/Live/v1/CloseResponse.cs b/Deepgram/Models/Live/v1/CloseResponse.cs index 50fe8367..789ca9d1 100644 --- a/Deepgram/Models/Live/v1/CloseResponse.cs +++ b/Deepgram/Models/Live/v1/CloseResponse.cs @@ -7,7 +7,7 @@ namespace Deepgram.Models.Live.v1; public record CloseResponse { /// - /// TODO + /// Close event type. /// [JsonPropertyName("type")] [JsonConverter(typeof(JsonStringEnumConverter))] diff --git a/Deepgram/Models/Live/v1/ErrorResponse.cs b/Deepgram/Models/Live/v1/ErrorResponse.cs index ee830d59..423d9a46 100644 --- a/Deepgram/Models/Live/v1/ErrorResponse.cs +++ b/Deepgram/Models/Live/v1/ErrorResponse.cs @@ -25,7 +25,7 @@ public record ErrorResponse public string? Variant { get; set; } = ""; /// - /// TODO + /// Error event type. /// [JsonPropertyName("type")] [JsonConverter(typeof(JsonStringEnumConverter))] diff --git a/Deepgram/Models/Live/v1/LiveSchema.cs b/Deepgram/Models/Live/v1/LiveSchema.cs index 91404f9b..d16d6bff 100644 --- a/Deepgram/Models/Live/v1/LiveSchema.cs +++ b/Deepgram/Models/Live/v1/LiveSchema.cs @@ -190,7 +190,7 @@ public class LiveSchema public string? UtteranceEnd { get; set; } /// - /// TODO + /// Enables voice activity detection (VAD) events /// [JsonPropertyName("vad_events")] public bool? VadEvents { get; set; } diff --git a/Deepgram/Models/Live/v1/Metadata.cs b/Deepgram/Models/Live/v1/Metadata.cs index d7c93753..c140874d 100644 --- a/Deepgram/Models/Live/v1/Metadata.cs +++ b/Deepgram/Models/Live/v1/Metadata.cs @@ -7,13 +7,13 @@ namespace Deepgram.Models.Live.v1; public record MetaData { /// - /// TODO + /// The request ID is a unique identifier for the request. It is useful for troubleshooting and support. /// [JsonPropertyName("request_id")] public string RequestId { get; set; } /// - /// TODO + /// Model UUID /// [JsonPropertyName("model_uuid")] public string ModelUUID { get; set; } diff --git a/Deepgram/Models/Live/v1/MetadataResponse.cs b/Deepgram/Models/Live/v1/MetadataResponse.cs index 774a8573..84345bce 100644 --- a/Deepgram/Models/Live/v1/MetadataResponse.cs +++ b/Deepgram/Models/Live/v1/MetadataResponse.cs @@ -7,55 +7,55 @@ namespace Deepgram.Models.Live.v1; public record MetadataResponse { /// - /// TODO + /// Channel count /// [JsonPropertyName("channels")] public int? Channels { get; set; } /// - /// TODO + /// Created date/time /// [JsonPropertyName("created")] public DateTime? Created { get; set; } /// - /// TODO + /// Duration of the audio /// [JsonPropertyName("duration")] public double? Duration { get; set; } /// - /// TODO + /// Model Information /// [JsonPropertyName("model_info")] public IReadOnlyDictionary? ModelInfo { get; set; } /// - /// TODO + /// Models used containing UUIDs /// [JsonPropertyName("models")] public IReadOnlyList? Models { get; set; } /// - /// TODO + /// Request ID is a unique identifier for the request. It is useful for troubleshooting and support. /// [JsonPropertyName("request_id")] public string? RequestId { get; set; } /// - /// TODO + /// Sha256 information /// [JsonPropertyName("sha256")] public string? Sha256 { get; set; } /// - /// TODO + /// (Obsolete?) his field is only present if the request was made with a transaction key. /// [JsonPropertyName("transaction_key")] public string? TransactionKey { get; set; } /// - /// TODO + /// Metadata event type. /// [JsonPropertyName("type")] [JsonConverter(typeof(JsonStringEnumConverter))] diff --git a/Deepgram/Models/Live/v1/OpenResponse.cs b/Deepgram/Models/Live/v1/OpenResponse.cs index ca171ed4..26a6435c 100644 --- a/Deepgram/Models/Live/v1/OpenResponse.cs +++ b/Deepgram/Models/Live/v1/OpenResponse.cs @@ -7,7 +7,7 @@ namespace Deepgram.Models.Live.v1; public record OpenResponse { /// - /// TODO + /// Open event type. /// [JsonPropertyName("type")] [JsonConverter(typeof(JsonStringEnumConverter))] diff --git a/Deepgram/Models/Live/v1/ResultResponse.cs b/Deepgram/Models/Live/v1/ResultResponse.cs index 6a8757d7..406dd30b 100644 --- a/Deepgram/Models/Live/v1/ResultResponse.cs +++ b/Deepgram/Models/Live/v1/ResultResponse.cs @@ -6,49 +6,49 @@ namespace Deepgram.Models.Live.v1; public record ResultResponse { /// - /// TODO + /// Contains the channel information. /// [JsonPropertyName("channel")] public Channel Channel { get; set; } /// - /// TODO + /// Channel index. /// [JsonPropertyName("channel_index")] public IReadOnlyList ChannelIndex { get; set; } /// - /// TODO + /// Duration of the result. /// [JsonPropertyName("duration")] public double Duration { get; set; } /// - /// TODO + /// Is the result final. /// [JsonPropertyName("is_final")] public bool IsFinal { get; set; } /// - /// TODO + /// Metadata information. /// [JsonPropertyName("metadata")] public MetaData MetaData { get; set; } /// - /// TODO + /// Is the result a partial result. /// [JsonPropertyName("speech_final")] public bool SpeechFinal { get; set; } /// - /// TODO + /// Start time of the result. /// [JsonPropertyName("start")] public decimal Start { get; set; } /// - /// TODO + /// Result event type. /// [JsonPropertyName("type")] [JsonConverter(typeof(JsonStringEnumConverter))] @@ -56,7 +56,7 @@ public record ResultResponse // TODO: DYV is this needed??? /// - /// TODO + /// Error information. /// public Exception? Error { get; set; } } diff --git a/Deepgram/Models/Live/v1/SpeechStartedResponse.cs b/Deepgram/Models/Live/v1/SpeechStartedResponse.cs index a86f75e2..0797c551 100644 --- a/Deepgram/Models/Live/v1/SpeechStartedResponse.cs +++ b/Deepgram/Models/Live/v1/SpeechStartedResponse.cs @@ -7,20 +7,20 @@ namespace Deepgram.Models.Live.v1; public record SpeechStartedResponse { /// - /// TODO + /// SpeechStarted event type. /// [JsonPropertyName("type")] [JsonConverter(typeof(JsonStringEnumConverter))] public LiveType? Type { get; set; } = LiveType.SpeechStarted; /// - /// TODO + /// Channel index information /// [JsonPropertyName("channel_index")] public int[]? Channel { get; set; } /// - /// TODO + /// Timestamp of the event. /// [JsonPropertyName("timestamp")] public decimal? Timestamp { get; set; } diff --git a/Deepgram/Models/Live/v1/UnhandledResponse.cs b/Deepgram/Models/Live/v1/UnhandledResponse.cs index 543cf466..d01a989e 100644 --- a/Deepgram/Models/Live/v1/UnhandledResponse.cs +++ b/Deepgram/Models/Live/v1/UnhandledResponse.cs @@ -13,7 +13,7 @@ public record UnhandledResponse public string? Raw { get; set; } = ""; /// - /// TODO + /// Unhandled event type. /// [JsonPropertyName("type")] [JsonConverter(typeof(JsonStringEnumConverter))] diff --git a/Deepgram/Models/Live/v1/UtteranceEndResponse.cs b/Deepgram/Models/Live/v1/UtteranceEndResponse.cs index 1687dd6b..8b4d1a2a 100644 --- a/Deepgram/Models/Live/v1/UtteranceEndResponse.cs +++ b/Deepgram/Models/Live/v1/UtteranceEndResponse.cs @@ -7,20 +7,20 @@ namespace Deepgram.Models.Live.v1; public record UtteranceEndResponse { /// - /// TODO + /// Utterance end event type. /// [JsonPropertyName("type")] [JsonConverter(typeof(JsonStringEnumConverter))] public LiveType? Type { get; set; } = LiveType.UtteranceEnd; /// - /// TODO + /// Channel index information /// [JsonPropertyName("channel_index")] public int[]? Channel { get; set; } /// - /// TODO + /// Timestamp of the event. /// [JsonPropertyName("last_word_end")] public decimal? LastWordEnd { get; set; } diff --git a/Deepgram/Models/Manage/v1/Callback.cs b/Deepgram/Models/Manage/v1/Callback.cs index 1ca05a15..a9efebbb 100644 --- a/Deepgram/Models/Manage/v1/Callback.cs +++ b/Deepgram/Models/Manage/v1/Callback.cs @@ -7,19 +7,19 @@ namespace Deepgram.Models.Manage.v1; public record Callback { /// - /// TODO + /// Attempt number. /// [JsonPropertyName("attempts")] public int? Attempts { get; set; } /// - /// TODO + /// HTTP status code returned by the callback, indicating the result of the callback execution. /// [JsonPropertyName("code")] public int? Code { get; set; } /// - /// TODO + /// Is Completed /// [JsonPropertyName("completed")] public string? Completed { get; set; } diff --git a/Deepgram/Models/Manage/v1/Config.cs b/Deepgram/Models/Manage/v1/Config.cs index bbafdf3e..70b55fd1 100644 --- a/Deepgram/Models/Manage/v1/Config.cs +++ b/Deepgram/Models/Manage/v1/Config.cs @@ -13,7 +13,7 @@ public record Config public int? Alternatives { get; set; } /// - /// TODO + /// Callback information associated with the request. /// [JsonPropertyName("callback")] public string? Callback { get; set; } diff --git a/Deepgram/Models/Manage/v1/Invite.cs b/Deepgram/Models/Manage/v1/Invite.cs index 0ced6438..055d0b97 100644 --- a/Deepgram/Models/Manage/v1/Invite.cs +++ b/Deepgram/Models/Manage/v1/Invite.cs @@ -7,13 +7,13 @@ namespace Deepgram.Models.Manage.v1; public record Invite { /// - /// TODO + /// Email for invite. /// [JsonPropertyName("email")] public string? Email { get; set; } /// - /// TODO + /// Scope for invite. /// [JsonPropertyName("scope")] public string? Scope { get; set; } diff --git a/Deepgram/Models/Manage/v1/Key.cs b/Deepgram/Models/Manage/v1/Key.cs index cc6c40d6..c9f1f0ba 100644 --- a/Deepgram/Models/Manage/v1/Key.cs +++ b/Deepgram/Models/Manage/v1/Key.cs @@ -19,19 +19,19 @@ public record Key public string? Comment { get; set; } /// - /// TODO + /// Scope of the Deepgram API key /// [JsonPropertyName("scopes")] public IReadOnlyList? Scopes { get; set; } /// - /// TODO + /// Creation date of the Deepgram API key /// [JsonPropertyName("created")] public DateTime? Created { get; set; } /// - /// TODO + /// Tags for the Deepgram API key /// [JsonPropertyName("tags")] public IReadOnlyList? Tags { get; set; } diff --git a/Deepgram/Models/Manage/v1/MembersResponse.cs b/Deepgram/Models/Manage/v1/MembersResponse.cs index 6fdc2dec..191e9078 100644 --- a/Deepgram/Models/Manage/v1/MembersResponse.cs +++ b/Deepgram/Models/Manage/v1/MembersResponse.cs @@ -7,7 +7,7 @@ namespace Deepgram.Models.Manage.v1; public record MembersResponse { /// - /// TODO + /// Members response/result /// [JsonPropertyName("members")] public IReadOnlyList? Members { get; set; } diff --git a/Deepgram/Models/Manage/v1/Model.cs b/Deepgram/Models/Manage/v1/Model.cs index c93684bd..8e9ac15d 100644 --- a/Deepgram/Models/Manage/v1/Model.cs +++ b/Deepgram/Models/Manage/v1/Model.cs @@ -7,25 +7,25 @@ namespace Deepgram.Models.Manage.v1; public record Model { /// - /// TODO + /// Model name /// [JsonPropertyName("name")] public string? Name { get; set; } /// - /// TODO + /// Model language /// [JsonPropertyName("language")] public string? Language { get; set; } /// - /// TODO + /// Model version /// [JsonPropertyName("version")] public string? Version { get; set; } /// - /// TODO + /// Model ID /// [JsonPropertyName("model_id")] public string? ModelId { get; set; } diff --git a/Deepgram/Models/Manage/v1/Response.cs b/Deepgram/Models/Manage/v1/Response.cs index 88307e57..673ddf53 100644 --- a/Deepgram/Models/Manage/v1/Response.cs +++ b/Deepgram/Models/Manage/v1/Response.cs @@ -13,19 +13,19 @@ public record Response public Details? Details { get; set; } /// - /// TODO + /// Return code /// [JsonPropertyName("code")] public int? Code { get; set; } /// - /// TODO + /// Is Completed /// [JsonPropertyName("completed")] public string? Completed { get; set; } /// - /// TODO + /// Token details /// [JsonPropertyName("token_details")] public List? TokenDetails { get; set; } diff --git a/Deepgram/Models/Manage/v1/Token.cs b/Deepgram/Models/Manage/v1/Token.cs index 41b4a644..82f80a24 100644 --- a/Deepgram/Models/Manage/v1/Token.cs +++ b/Deepgram/Models/Manage/v1/Token.cs @@ -7,13 +7,13 @@ namespace Deepgram.Models.Manage.v1; public record Token { /// - /// TODO + /// Input tokens /// [JsonPropertyName("in")] public int? In { get; set; } /// - /// TODO + /// Output tokens /// [JsonPropertyName("out")] public int? Out { get; set; } diff --git a/Deepgram/Models/Manage/v1/TokenDetails.cs b/Deepgram/Models/Manage/v1/TokenDetails.cs index 65dad509..63112a60 100644 --- a/Deepgram/Models/Manage/v1/TokenDetails.cs +++ b/Deepgram/Models/Manage/v1/TokenDetails.cs @@ -7,25 +7,25 @@ namespace Deepgram.Models.Manage.v1; public record TokenDetails { /// - /// TODO + /// Feature name /// [JsonPropertyName("feature")] public string? Feature { get; set; } /// - /// TODO + /// Input tokens /// [JsonPropertyName("input")] public int? Input { get; set; } /// - /// TODO + /// Output tokens /// [JsonPropertyName("output")] public int? Output { get; set; } /// - /// TODO + /// Model name /// [JsonPropertyName("model")] public string? Model { get; set; } diff --git a/Deepgram/Models/Manage/v1/UsageRequest.cs b/Deepgram/Models/Manage/v1/UsageRequest.cs index c3dfe8b5..a9a1f60b 100644 --- a/Deepgram/Models/Manage/v1/UsageRequest.cs +++ b/Deepgram/Models/Manage/v1/UsageRequest.cs @@ -31,7 +31,7 @@ public record UsageRequest public string? Path { get; set; } /// - /// TODO + /// Accessor of the request. /// [JsonPropertyName("accessor")] public string? Accessor { get; set; } diff --git a/Deepgram/Models/Manage/v1/UsageRequestsResponse.cs b/Deepgram/Models/Manage/v1/UsageRequestsResponse.cs index 6716322a..a1cf38b3 100644 --- a/Deepgram/Models/Manage/v1/UsageRequestsResponse.cs +++ b/Deepgram/Models/Manage/v1/UsageRequestsResponse.cs @@ -7,19 +7,19 @@ namespace Deepgram.Models.Manage.v1; public record UsageRequestsResponse { /// - /// TODO + /// Page number /// [JsonPropertyName("page")] public int? Page { get; set; } /// - /// TODO + /// Results per page /// [JsonPropertyName("limit")] public int? Limit { get; set; } /// - /// TODO + /// Requests response/result /// [JsonPropertyName("requests")] public IReadOnlyList? Requests { get; set; } diff --git a/Deepgram/Models/Manage/v1/UsageRequestsSchema.cs b/Deepgram/Models/Manage/v1/UsageRequestsSchema.cs index 68346fed..3ffabe49 100644 --- a/Deepgram/Models/Manage/v1/UsageRequestsSchema.cs +++ b/Deepgram/Models/Manage/v1/UsageRequestsSchema.cs @@ -19,7 +19,7 @@ public class UsageRequestsSchema public DateTime? End { get; set; } /// - /// TODO + /// Page number to return /// [JsonPropertyName("page")] public int? Page { get; set; } diff --git a/Deepgram/Models/Manage/v1/UsageSummarySchema.cs b/Deepgram/Models/Manage/v1/UsageSummarySchema.cs index 309d4afc..f34526c4 100644 --- a/Deepgram/Models/Manage/v1/UsageSummarySchema.cs +++ b/Deepgram/Models/Manage/v1/UsageSummarySchema.cs @@ -88,13 +88,13 @@ public class UsageSummarySchema public bool? Numerals { get; set; } /// - /// TODO + /// Is the Number Feature being used /// [JsonPropertyName("numbers")] public bool? Numbers { get; set; } /// - /// TODO + /// Is the Paragraphs Feature being used /// [JsonPropertyName("paragraphs")] public bool? Paragraphs { get; set; } @@ -130,7 +130,7 @@ public class UsageSummarySchema public bool? Search { get; set; } /// - /// TODO + /// Is the Sentiment Feature being used /// [JsonPropertyName("sentiment")] public bool? Sentiment { get; set; } @@ -143,7 +143,7 @@ public class UsageSummarySchema /// - /// TODO + /// Is the SmartFormat Feature being used /// [JsonPropertyName("smart_format")] public bool? SmartFormat { get; set; } @@ -155,7 +155,7 @@ public class UsageSummarySchema public DateTime? Start { get; set; } /// - /// TODO + /// Is the Summarize Feature being used /// [JsonPropertyName("summarize")] public bool? Summarize { get; set; } @@ -167,7 +167,7 @@ public class UsageSummarySchema public List? Tag { get; set; } /// - /// TODO + /// Is the Translate Feature being used /// [JsonPropertyName("translate")] public bool? translate { get; set; } @@ -179,7 +179,7 @@ public class UsageSummarySchema public bool? Utterances { get; set; } /// - /// TODO + /// Is the Utterance Split Feature being used /// [JsonPropertyName("utt_split")] public bool? UttSplit { get; set; } diff --git a/Deepgram/Models/OnPrem/v1/CredentialResponse.cs b/Deepgram/Models/OnPrem/v1/CredentialResponse.cs index fa032ddf..ccd7c77d 100644 --- a/Deepgram/Models/OnPrem/v1/CredentialResponse.cs +++ b/Deepgram/Models/OnPrem/v1/CredentialResponse.cs @@ -7,13 +7,13 @@ namespace Deepgram.Models.OnPrem.v1; public record CredentialResponse { /// - /// TODO + /// Member information /// [JsonPropertyName("member")] public Member? Member { get; set; } /// - /// TODO + /// Distribution credentials /// [JsonPropertyName("distribution_credentials")] public DistributionCredentials? DistributionCredentials { get; set; } diff --git a/Deepgram/Models/OnPrem/v1/CredentialsResponse.cs b/Deepgram/Models/OnPrem/v1/CredentialsResponse.cs index 1e65b3e7..1421e9e3 100644 --- a/Deepgram/Models/OnPrem/v1/CredentialsResponse.cs +++ b/Deepgram/Models/OnPrem/v1/CredentialsResponse.cs @@ -7,7 +7,7 @@ namespace Deepgram.Models.OnPrem.v1; public record CredentialsResponse { /// - /// TODO + /// Distribution credentials /// [JsonPropertyName("distribution_credentials")] public IReadOnlyList? DistributionCredentials { get; set; } diff --git a/Deepgram/Models/OnPrem/v1/DistributionCredentials.cs b/Deepgram/Models/OnPrem/v1/DistributionCredentials.cs index 447e3f39..0f96b15f 100644 --- a/Deepgram/Models/OnPrem/v1/DistributionCredentials.cs +++ b/Deepgram/Models/OnPrem/v1/DistributionCredentials.cs @@ -7,31 +7,31 @@ namespace Deepgram.Models.OnPrem.v1; public record DistributionCredentials { /// - /// TODO + /// Distribution credentials ID /// [JsonPropertyName("distribution_credentials_id")] public string? DistributionCredentialsId { get; set; } /// - /// TODO + /// Provider name /// [JsonPropertyName("provider")] public string? Provider { get; set; } /// - /// TODO + /// Comment /// [JsonPropertyName("comment")] public string? Comment { get; set; } /// - /// TODO + /// Scopes of the credentials /// [JsonPropertyName("scopes")] public IReadOnlyList? Scopes { get; set; } /// - /// TODO + /// Created date/time /// [JsonPropertyName("created")] public DateTime? Created { get; set; } diff --git a/Deepgram/Models/OnPrem/v1/Member.cs b/Deepgram/Models/OnPrem/v1/Member.cs index 140a4f5d..e32c3dbe 100644 --- a/Deepgram/Models/OnPrem/v1/Member.cs +++ b/Deepgram/Models/OnPrem/v1/Member.cs @@ -7,13 +7,13 @@ namespace Deepgram.Models.OnPrem.v1; public record Member { /// - /// TODO + /// Member ID /// [JsonPropertyName("member_id")] public string? MemberId { get; set; } /// - /// TODO + /// Email of the member /// [JsonPropertyName("email")] public string? Email { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/Average.cs b/Deepgram/Models/PreRecorded/v1/Average.cs index 559aa711..7ff62f5c 100644 --- a/Deepgram/Models/PreRecorded/v1/Average.cs +++ b/Deepgram/Models/PreRecorded/v1/Average.cs @@ -7,13 +7,13 @@ namespace Deepgram.Models.PreRecorded.v1; public record Average { /// - /// TODO + /// Sentiment: positive, negative, neutral /// [JsonPropertyName("sentiment")] public string? Sentiment { get; set; } /// - /// TODO + /// Sentiment score of the audio segment, ranging from -1 (negative sentiment) to 1 (positive sentiment), with 0 indicating neutral sentiment. /// [JsonPropertyName("sentiment_score")] public double? SentimentScore { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/Channel.cs b/Deepgram/Models/PreRecorded/v1/Channel.cs index ea83c9c8..3acf5c69 100644 --- a/Deepgram/Models/PreRecorded/v1/Channel.cs +++ b/Deepgram/Models/PreRecorded/v1/Channel.cs @@ -20,7 +20,7 @@ public record Channel public string? DetectedLanguage { get; set; } /// - /// TODO + /// Language confidence score for the dominant language identified in the channel. /// [JsonPropertyName("language_confidence")] public double? LanguageConfidence { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/IntentsInfo.cs b/Deepgram/Models/PreRecorded/v1/IntentsInfo.cs index af4e5990..cb2d791a 100644 --- a/Deepgram/Models/PreRecorded/v1/IntentsInfo.cs +++ b/Deepgram/Models/PreRecorded/v1/IntentsInfo.cs @@ -7,19 +7,19 @@ namespace Deepgram.Models.PreRecorded.v1; public record IntentsInfo { /// - /// TODO + /// Input tokens for the intent /// [JsonPropertyName("input_tokens")] public int? InputTokens { get; set; } /// - /// TODO + /// Model UUID /// [JsonPropertyName("model_uuid")] public string? ModelUuid { get; set; } /// - /// TODO + /// Output tokens for the intent /// [JsonPropertyName("output_tokens")] public int? OutputTokens { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/Metadata.cs b/Deepgram/Models/PreRecorded/v1/Metadata.cs index 4b7c9b78..12e5b659 100644 --- a/Deepgram/Models/PreRecorded/v1/Metadata.cs +++ b/Deepgram/Models/PreRecorded/v1/Metadata.cs @@ -33,7 +33,7 @@ public record Metadata public Dictionary? Extra { get; set; } /// - /// TODO + /// Intents information. /// [JsonPropertyName("intents_info")] public IntentsInfo? IntentsInfo { get; set; } @@ -45,7 +45,7 @@ public record Metadata public Dictionary? ModelInfo { get; set; } /// - /// TODO + /// Models used to process the submitted audio. /// [JsonPropertyName("models")] public List? Models { get; set; } @@ -57,7 +57,7 @@ public record Metadata public string? RequestId { get; set; } /// - /// TODO. + /// Sentiment information. /// [JsonPropertyName("sentiment_info")] public SentimentInfo? SentimentInfo { get; set; } @@ -69,13 +69,13 @@ public record Metadata public string? Sha256 { get; set; } /// - /// TODO + /// Summary information. /// [JsonPropertyName("summary_info")] public SummaryInfo? SummaryInfo { get; set; } /// - /// TODO + /// Topics information. /// [JsonPropertyName("topics_info")] public TopicsInfo? TopicsInfo { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/ModelInfo.cs b/Deepgram/Models/PreRecorded/v1/ModelInfo.cs index 29a50c98..3cfcd8da 100644 --- a/Deepgram/Models/PreRecorded/v1/ModelInfo.cs +++ b/Deepgram/Models/PreRecorded/v1/ModelInfo.cs @@ -7,19 +7,19 @@ namespace Deepgram.Models.PreRecorded.v1; public record ModelInfo { /// - /// TODO + /// Architecture of the model, indicating the underlying technology or framework used. /// [JsonPropertyName("arch")] public string? Arch { get; set; } /// - /// TODO + /// Model name /// [JsonPropertyName("name")] public string? Name { get; set; } /// - /// TODO + /// Model version /// [JsonPropertyName("version")] public string? Version { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/Paragraph.cs b/Deepgram/Models/PreRecorded/v1/Paragraph.cs index 7f61425a..9224476e 100644 --- a/Deepgram/Models/PreRecorded/v1/Paragraph.cs +++ b/Deepgram/Models/PreRecorded/v1/Paragraph.cs @@ -31,13 +31,13 @@ public record Paragraph public decimal? End { get; set; } /// - /// TODO + /// Sentiment of the paragraph /// [JsonPropertyName("sentiment")] public string? Sentiment { get; set; } /// - /// TODO + /// Sentiment score of the paragraph /// [JsonPropertyName("sentiment_score")] public double? SentimentScore { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/PrerecordedSchema.cs b/Deepgram/Models/PreRecorded/v1/PrerecordedSchema.cs index eac904f3..b7ea2826 100644 --- a/Deepgram/Models/PreRecorded/v1/PrerecordedSchema.cs +++ b/Deepgram/Models/PreRecorded/v1/PrerecordedSchema.cs @@ -41,13 +41,13 @@ public class PrerecordedSchema public string? CustomIntentMode { get; set; } /// - /// TODO + /// Custom Topic allows you to specify a custom topic for your submitted audio. /// [JsonPropertyName("custom_topic")] public List? CustomTopic { get; set; } /// - /// 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 /// [JsonPropertyName("custom_topic_mode")] public string? CustomTopicMode { get; set; } @@ -67,7 +67,7 @@ public class PrerecordedSchema public bool? DetectLanguage { get; set; } /// - /// TODO + /// Identify and extract key topics. /// [JsonPropertyName("detect_topics")] public bool? DetectTopics { get; set; } @@ -118,7 +118,7 @@ public class PrerecordedSchema public bool? FillerWords { get; set; } /// - /// TODO + /// Enables intent detection /// [JsonPropertyName("intents")] public bool? Intents { get; set; } @@ -139,7 +139,7 @@ public class PrerecordedSchema public string? Language { get; set; } /// - /// TODO + /// Spoken measurements will be converted to their corresponding abbreviations. e.g., milligram to mg. /// [JsonPropertyName("measurements")] public bool? Measurements { get; set; } @@ -159,7 +159,7 @@ public class PrerecordedSchema public bool? MultiChannel { get; set; } /// - /// TODO + /// Enable paragraph detection /// [JsonPropertyName("paragraphs")] public bool? Paragraphs { get; set; } @@ -212,7 +212,7 @@ public class PrerecordedSchema public List? Search { get; set; } /// - /// TODO + /// Enables sentiment analysis /// [JsonPropertyName("sentiment")] public bool? Sentiment { get; set; } @@ -225,7 +225,7 @@ public class PrerecordedSchema public bool? SmartFormat { get; set; } ///// - ///// TODO + ///// Enables summarization ///// [JsonPropertyName("summarize")] public string? Summarize { get; set; } @@ -240,19 +240,19 @@ public class PrerecordedSchema public List? Tag { get; set; } ///// - ///// TODO + ///// Enables topic detection ///// [JsonPropertyName("topics")] public bool? Topics { get; set; } /// - /// TODO + /// Length of time in seconds used to split utterances. /// [JsonPropertyName("utt_split")] public double? UttSplit { get; set; } /// - /// TODO + /// Enable utterance segmentation /// [JsonPropertyName("utterances")] public bool? Utterances { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/Results.cs b/Deepgram/Models/PreRecorded/v1/Results.cs index c63a3724..a3f0fecd 100644 --- a/Deepgram/Models/PreRecorded/v1/Results.cs +++ b/Deepgram/Models/PreRecorded/v1/Results.cs @@ -13,13 +13,13 @@ public record Results public IReadOnlyList? Channels { get; set; } /// - /// TODO + /// Intent Group /// [JsonPropertyName("intents")] public IntentGroup? Intents { get; set; } /// - /// TODO + /// Sentiment Group /// [JsonPropertyName("sentiments")] public SentimentGroup? Sentiments { get; set; } @@ -31,7 +31,7 @@ public record Results public Summary? Summary { get; set; } /// - /// TODO + /// Topic Group /// [JsonPropertyName("topics")] public TopicGroup? Topics { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/Segment.cs b/Deepgram/Models/PreRecorded/v1/Segment.cs index 6f39b285..06c9b2ad 100644 --- a/Deepgram/Models/PreRecorded/v1/Segment.cs +++ b/Deepgram/Models/PreRecorded/v1/Segment.cs @@ -7,43 +7,43 @@ namespace Deepgram.Models.PreRecorded.v1; public record Segment { /// - /// TODO + /// The translated text /// [JsonPropertyName("text")] public string? Text { get; set; } /// - /// TODO + /// Start time of the segment in seconds /// [JsonPropertyName("start_word")] public int? StartWord { get; set; } /// - /// TODO + /// End time of the segment in seconds /// [JsonPropertyName("end_word")] public int? EndWord { get; set; } /// - /// TODO + /// Sentiment: positive, negative, neutral /// [JsonPropertyName("sentiment")] public string? Sentiment { get; set; } /// - /// TODO + /// Sentiment score /// [JsonPropertyName("sentiment_score")] public double? SentimentScore { get; set; } /// - /// TODO + /// Topics discovered in the segment /// [JsonPropertyName("topics")] public IReadOnlyList? Topics { get; set; } /// - /// TODO + /// Intents discovered in the segment /// [JsonPropertyName("intents")] public IReadOnlyList? Intents { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/Sentence.cs b/Deepgram/Models/PreRecorded/v1/Sentence.cs index 4b35ab60..9a28c5cb 100644 --- a/Deepgram/Models/PreRecorded/v1/Sentence.cs +++ b/Deepgram/Models/PreRecorded/v1/Sentence.cs @@ -25,13 +25,13 @@ public record Sentence public decimal? End { get; set; } /// - /// TODO + /// Sentiment of the sentence: positive, negative, neutral. /// [JsonPropertyName("sentiment")] public string? Sentiment { get; set; } /// - /// TODO + /// Sentiment score of the sentence. /// [JsonPropertyName("sentiment_score")] public double? SentimentScore { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/SentimentGroup.cs b/Deepgram/Models/PreRecorded/v1/SentimentGroup.cs index 67f11f8a..40cf12d2 100644 --- a/Deepgram/Models/PreRecorded/v1/SentimentGroup.cs +++ b/Deepgram/Models/PreRecorded/v1/SentimentGroup.cs @@ -7,13 +7,13 @@ namespace Deepgram.Models.PreRecorded.v1; public record SentimentGroup { /// - /// TODO + /// Segments of the audio /// [JsonPropertyName("segments")] public IReadOnlyList? Segments { get; set; } /// - /// TODO + /// Sentiment of the segment /// [JsonPropertyName("average")] public Average? Average { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/SentimentInfo.cs b/Deepgram/Models/PreRecorded/v1/SentimentInfo.cs index 26a3f6f0..f7f0fd8c 100644 --- a/Deepgram/Models/PreRecorded/v1/SentimentInfo.cs +++ b/Deepgram/Models/PreRecorded/v1/SentimentInfo.cs @@ -7,19 +7,19 @@ namespace Deepgram.Models.PreRecorded.v1; public record SentimentInfo { /// - /// TODO + /// Input tokens used /// [JsonPropertyName("input_tokens")] public int? InputTokens { get; set; } /// - /// TODO + /// Model UUID /// [JsonPropertyName("model_uuid")] public string? ModelUuid { get; set; } /// - /// TODO + /// Output tokens used /// [JsonPropertyName("output_tokens")] public int? OutputTokens { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/SummaryInfo.cs b/Deepgram/Models/PreRecorded/v1/SummaryInfo.cs index e4c90010..785148e2 100644 --- a/Deepgram/Models/PreRecorded/v1/SummaryInfo.cs +++ b/Deepgram/Models/PreRecorded/v1/SummaryInfo.cs @@ -7,19 +7,19 @@ namespace Deepgram.Models.PreRecorded.v1; public record SummaryInfo { /// - /// TODO + /// Input tokens used /// [JsonPropertyName("input_tokens")] public int? InputTokens { get; set; } /// - /// TODO + /// Model UUID /// [JsonPropertyName("model_uuid")] public string? ModelUUID { get; set; } /// - /// TODO + /// Output tokens used /// [JsonPropertyName("output_tokens")] public int? OutputTokens { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/Topic.cs b/Deepgram/Models/PreRecorded/v1/Topic.cs index 418d553b..e5a443bb 100644 --- a/Deepgram/Models/PreRecorded/v1/Topic.cs +++ b/Deepgram/Models/PreRecorded/v1/Topic.cs @@ -13,7 +13,7 @@ public record Topic public double? Confidence { get; set; } /// - /// TODO + /// Discovered topic. /// [JsonPropertyName("topic")] public string Text; diff --git a/Deepgram/Models/PreRecorded/v1/TopicGroup.cs b/Deepgram/Models/PreRecorded/v1/TopicGroup.cs index 7eb30be2..e479e5f7 100644 --- a/Deepgram/Models/PreRecorded/v1/TopicGroup.cs +++ b/Deepgram/Models/PreRecorded/v1/TopicGroup.cs @@ -7,7 +7,7 @@ namespace Deepgram.Models.PreRecorded.v1; public record TopicGroup { /// - /// TODO + /// Topic segments /// [JsonPropertyName("segments")] public IReadOnlyList? Segments { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/TopicsInfo.cs b/Deepgram/Models/PreRecorded/v1/TopicsInfo.cs index 4418cbf1..427d3a07 100644 --- a/Deepgram/Models/PreRecorded/v1/TopicsInfo.cs +++ b/Deepgram/Models/PreRecorded/v1/TopicsInfo.cs @@ -7,19 +7,19 @@ namespace Deepgram.Models.PreRecorded.v1; public record TopicsInfo { /// - /// TODO + /// Input tokens used /// [JsonPropertyName("input_tokens")] public int? InputTokens { get; set; } /// - /// TODO + /// Model UUID /// [JsonPropertyName("model_uuid")] public string? ModelUuid { get; set; } /// - /// TODO + /// Output tokens used /// [JsonPropertyName("output_tokens")] public int? OutputTokens { get; set; } diff --git a/Deepgram/Models/PreRecorded/v1/Utterance.cs b/Deepgram/Models/PreRecorded/v1/Utterance.cs index 5835e7fb..6f0e8a25 100644 --- a/Deepgram/Models/PreRecorded/v1/Utterance.cs +++ b/Deepgram/Models/PreRecorded/v1/Utterance.cs @@ -31,13 +31,13 @@ public record Utterance public string? Id { get; set; } /// - /// TODO + /// Sentiment of the word: positive, negative, neutral. /// [JsonPropertyName("sentiment")] public string? Sentiment { get; set; } /// - /// TODO + /// Sentiment score of the word. /// [JsonPropertyName("sentiment_score")] public double? SentimentScore { get; set; } diff --git a/Deepgram/Models/Speak/v1/SpeakSchema.cs b/Deepgram/Models/Speak/v1/SpeakSchema.cs index 242fbda5..03af4ca6 100644 --- a/Deepgram/Models/Speak/v1/SpeakSchema.cs +++ b/Deepgram/Models/Speak/v1/SpeakSchema.cs @@ -14,7 +14,7 @@ public class SpeakSchema public string? Model { get; set; } /// - /// TODO + /// Bit Rate allows you to specify the bit rate of your desired audio. /// [JsonPropertyName("bit_rate")] public string? BitRate { get; set; } @@ -28,7 +28,7 @@ public class SpeakSchema public string? CallBack { get; set; } /// - /// TODO + /// Audio container format /// [JsonPropertyName("container")] public string? Container { get; set; } diff --git a/Deepgram/Models/Speak/v1/SyncResponse.cs b/Deepgram/Models/Speak/v1/SyncResponse.cs index fb7dd5e8..4edcaaf4 100644 --- a/Deepgram/Models/Speak/v1/SyncResponse.cs +++ b/Deepgram/Models/Speak/v1/SyncResponse.cs @@ -7,43 +7,43 @@ namespace Deepgram.Models.Speak.v1; public record SyncResponse { /// - /// TODO + /// Content type of the audio file /// [JsonPropertyName("content_type")] public string? ContentType { get; set; } /// - /// TODO + /// Request ID for support purposes /// [JsonPropertyName("request_id")] public string? RequestId { get; set; } /// - /// TODO + /// Model UUID /// [JsonPropertyName("model_uuid")] public string? ModelUUID { get; set; } /// - /// TODO + /// Model name /// [JsonPropertyName("model_name")] public string? ModelName { get; set; } /// - /// TODO + /// Character count /// [JsonPropertyName("characters")] public int? Characters { get; set; } /// - /// TODO + /// Encoding of the audio file /// [JsonPropertyName("transfer_encoding")] public string? TransferEncoding { get; set; } /// - /// TODO + /// Date/time of the audio file /// [JsonPropertyName("date")] public DateTime? Date { get; set; } diff --git a/Deepgram/TodoAndChanges.md b/Deepgram/TodoAndChanges.md deleted file mode 100644 index 693a7861..00000000 --- a/Deepgram/TodoAndChanges.md +++ /dev/null @@ -1,41 +0,0 @@ -# TODO -- remove before general release - -## Deepgram -- Live client change event args to callback -- Live client - when receiving data type of data needs to be check currently the - recieve method only expects to recieve TranscriptionResponse but the method - can recieve either TranscriptionResponse or MetadataResponse - - - -## DeepgramTests -- Test for live client -- Test for Manage client -- Test for OnPrem client -- Test for Prerecorded client - -AbstractClient tests-- -- need to test all endpoints to ensure the returned type match the defined c# types. - - TopicGroup causing deserializer to throw json error when topice detection used. - -- implemented read client - -- Intergration Test need to be written -- Either Intergration soultion needs to be exclude from git action tests - or - Live key added and hidden from the repo - Not sure which is the best approach - -- Test to catch Exception, HttpRequestExceptions already being caught -- Tests for the post method that handle streams -- test for the get QueryParametesUtil class to catch exceptions -- ServiceCollectionExtension test -- ClientWebSocketExtensions test - now way yo get the headers or mock clientwebsocket - - -# Changes -added redundencies in for people not wanting to/ or dont have access to servicecollection(in pre exisiting apps upgrading to this version of the sdk) use Dependency Injection such as if they just want to create a simple -console app demo and new up a client - -added checks to see if there is a predefined client passed in - if there is then the sdk will assume the base address -is in the correct format - the reason being that if it is a onPrem there is no way to knwo what there server address is \ No newline at end of file diff --git a/Deepgram/Utilities/QueryParameterUtil.cs b/Deepgram/Utilities/QueryParameterUtil.cs index cee89707..a186e981 100644 --- a/Deepgram/Utilities/QueryParameterUtil.cs +++ b/Deepgram/Utilities/QueryParameterUtil.cs @@ -19,8 +19,7 @@ public static string FormatURL(string uriSegment, S? parameter, Dictionary