Add nullable annotations #98 (#99)

marcominerva · Aug 3, 2023 · 8db82f4 · 8db82f4
2 parents ec31833 + 67bc6b4
commit 8db82f4
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/src/ChatGptNet/Models/ChatGptChoice.cs b/src/ChatGptNet/Models/ChatGptChoice.cs
@@ -1,4 +1,5 @@
-using System.Text.Json.Serialization;
+using System.Diagnostics.CodeAnalysis;
+using System.Text.Json.Serialization;
 
 namespace ChatGptNet.Models;
 
@@ -29,6 +30,7 @@ public class ChatGptChoice
     /// Gets or sets a value indicating whether the this <see cref="ChatGptChoice"/> has been filtered by content filtering system.
     /// </summary>
     /// <seealso cref="ChatGptChoice"/>
+    [MemberNotNullWhen(true, nameof(ContentFilterResults))]
     public bool IsChoiceFiltered => ContentFilterResults is not null
         && (ContentFilterResults.Hate.Filtered || ContentFilterResults.SelfHarm.Filtered || ContentFilterResults.Violence.Filtered
             || ContentFilterResults.Sexual.Filtered);

diff --git a/src/ChatGptNet/Models/ChatGptResponse.cs b/src/ChatGptNet/Models/ChatGptResponse.cs
@@ -1,4 +1,5 @@
-using System.Text.Json.Serialization;
+using System.Diagnostics.CodeAnalysis;
+using System.Text.Json.Serialization;
 using ChatGptNet.Models.Converters;
 
 namespace ChatGptNet.Models;
@@ -59,13 +60,15 @@ public class ChatGptResponse
     /// <summary>
     /// Gets or sets a value indicating whether any prompt has been filtered by content filtering system.
     /// </summary>
+    [MemberNotNullWhen(true, nameof(PromptAnnotations))]
     public bool IsPromptFiltered => PromptAnnotations?.Any(
         p => p.ContentFilterResults.Hate.Filtered || p.ContentFilterResults.SelfHarm.Filtered || p.ContentFilterResults.Violence.Filtered
             || p.ContentFilterResults.Sexual.Filtered) ?? false;
 
     /// <summary>
     /// Gets a value that determines if the response was successful.
     /// </summary>
+    [MemberNotNullWhen(false, nameof(Error))]
     public bool IsSuccessful => Error is null;
 
     /// <summary>