Mark internal methods with comments

Author: a-maurice

vertexai/src/Candidate.cs

@@ -121,6 +121,9 @@ private static FinishReason ParseFinishReason(string str) {
     };
   }
 
+  /// <summary>
+  /// Intended for internal use only.
+  /// </summary>
   internal static Candidate FromJson(Dictionary<string, object> jsonDict) {
     return new Candidate(
       jsonDict.ParseObject("content", ModelContent.FromJson, defaultValue: new ModelContent("model")),

vertexai/src/Citation.cs

@@ -38,6 +38,9 @@ private CitationMetadata(List<Citation> citations) {
     _citations = new ReadOnlyCollection<Citation>(citations ?? new List<Citation>());
   }
 
+  /// <summary>
+  /// Intended for internal use only.
+  /// </summary>
   internal static CitationMetadata FromJson(Dictionary<string, object> jsonDict) {
     return new CitationMetadata(
       jsonDict.ParseObjectList("citations", Citation.FromJson));
@@ -84,6 +87,9 @@ private Citation(int startIndex, int endIndex, Uri uri, string title,
     PublicationDate = publicationDate;
   }
 
+  /// <summary>
+  /// Intended for internal use only.
+  /// </summary>
   internal static Citation FromJson(Dictionary<string, object> jsonDict) {
     // If there is a Uri, need to convert it.
     Uri uri = null;

vertexai/src/GenerateContentResponse.cs

@@ -74,10 +74,16 @@ private GenerateContentResponse(List<Candidate> candidates, PromptFeedback? prom
     UsageMetadata = usageMetadata;
   }
 
+  /// <summary>
+  /// Intended for internal use only.
+  /// </summary>
   internal static GenerateContentResponse FromJson(string jsonString) {
     return FromJson(Json.Deserialize(jsonString) as Dictionary<string, object>);
   }
 
+  /// <summary>
+  /// Intended for internal use only.
+  /// </summary>
   internal static GenerateContentResponse FromJson(Dictionary<string, object> jsonDict) {
     return new GenerateContentResponse(
       jsonDict.ParseObjectList("candidates", Candidate.FromJson),
@@ -152,6 +158,9 @@ private static BlockReason ParseBlockReason(string str) {
     };
   }
 
+  /// <summary>
+  /// Intended for internal use only.
+  /// </summary>
   internal static PromptFeedback FromJson(Dictionary<string, object> jsonDict) {
     return new PromptFeedback(
       jsonDict.ParseNullableEnum("blockReason", ParseBlockReason),
@@ -186,6 +195,9 @@ private UsageMetadata(int promptTC, int candidatesTC, int totalTC) {
     TotalTokenCount = totalTC;
   }
 
+  /// <summary>
+  /// Intended for internal use only.
+  /// </summary>
   internal static UsageMetadata FromJson(Dictionary<string, object> jsonDict) {
     return new UsageMetadata(
       jsonDict.ParseValue<int>("promptTokenCount"),

vertexai/src/GenerationConfig.cs

@@ -159,6 +159,9 @@ public GenerationConfig(
     _responseSchema = responseSchema;
   }
 
+  /// <summary>
+  /// Intended for internal use only.
+  /// </summary>
   internal Dictionary<string, object> ToJson() {
     Dictionary<string, object> jsonDict = new();
     if (_temperature.HasValue) jsonDict["temperature"] = _temperature.Value;

vertexai/src/GenerativeModel.cs

@@ -46,6 +46,9 @@ public class GenerativeModel {
 
   private readonly HttpClient _httpClient;
 
+  /// <summary>
+  /// Intended for internal use only. Use `VertexAI.GetInstance` instead.
+  /// </summary>
   internal GenerativeModel(FirebaseApp firebaseApp,
                            string location,
                            string modelName,

vertexai/src/ModelContent.cs

@@ -232,6 +232,9 @@ internal Dictionary<string, object> ToJson() {
     };
   }
 
+  /// <summary>
+  /// Intended for internal use only.
+  /// </summary>
   internal static ModelContent FromJson(Dictionary<string, object> jsonDict) {
     // Both role and parts are required keys
     return new ModelContent(

vertexai/src/RequestOptions.cs

@@ -27,9 +27,14 @@ public readonly struct RequestOptions {
   // to determine if it should be 180.
   private readonly TimeSpan? _timeout;
 
+  /// <summary>
+  /// Intended for internal use only.
+  /// </summary>
   internal static TimeSpan DefaultTimeout => TimeSpan.FromSeconds(180);
 
-  // Intentionally not public, as users don't need it.
+  /// <summary>
+  /// Intended for internal use only.
+  /// </summary>
   internal TimeSpan Timeout => _timeout ?? DefaultTimeout;
 
   /// <summary>

vertexai/src/Safety.cs

@@ -140,6 +140,9 @@ private string ConvertMethod(HarmBlockMethod method) {
     };
   }
 
+  /// <summary>
+  /// Intended for internal use only.
+  /// </summary>
   internal Dictionary<string, object> ToJson() {
     Dictionary<string, object> jsonDict = new () {
       ["category"] = ConvertCategory(_category),
@@ -297,6 +300,9 @@ private static HarmSeverity ParseSeverity(string str) {
     };
   }
 
+  /// <summary>
+  /// Intended for internal use only.
+  /// </summary>
   internal static SafetyRating FromJson(Dictionary<string, object> jsonDict) {
     return new SafetyRating(
       jsonDict.ParseEnum("category", ParseCategory),