include public api docs in nugets (#4)

Author: veerashayyagari

src/LLMSharp.Google.Palm/Common/PalmClientException.cs

@@ -9,8 +9,16 @@ namespace LLMSharp.Google.Palm.Common
     /// </summary>
     public class PalmClientException : Exception
     {
+        /// <summary>
+        /// Grpc response status
+        /// </summary>
         public Status Status { get; private set; }
 
+        /// <summary>
+        /// Palm Client Exception constructor
+        /// </summary>
+        /// <param name="status">Grpc response status</param>
+        /// <param name="innerException">Any inner exception included</param>
         public PalmClientException(
             Status status, Exception? innerException = null)
             : base(string.Format(CultureInfo.CurrentCulture, Constants.RpcExceptionMessage, status.StatusCode, status.Detail), innerException)

src/LLMSharp.Google.Palm/Common/PalmContentFilter.cs

@@ -4,14 +4,17 @@
 namespace LLMSharp.Google.Palm.Common
 {
     /// <summary>
-    /// Content filtering metadata associated with processing a single request.
-    ///
+    /// Content filtering metadata associated with processing a single request.    
     /// ContentFilter contains a reason and an optional supporting string. The reason
     /// may be unspecified.
     /// </summary>
     public class PalmContentFilter
     {
-        public PalmContentFilter(gav::ContentFilter f)
+        /// <summary>
+        /// Palm Content Filter constructor
+        /// </summary>
+        /// <param name="f">proto generated content filter type</param>
+        internal PalmContentFilter(gav::ContentFilter f)
         {
             this.Reason = f.Reason;
             this.Message = f.Message;

src/LLMSharp.Google.Palm/Common/PalmSafetyRating.cs

@@ -18,7 +18,12 @@ public class PalmSafetyRating
         /// </summary>
         public HarmProbability Probability { get; private set; }
 
-        public PalmSafetyRating(gav::HarmCategory category, HarmProbability probability)
+        /// <summary>
+        /// Palm Safety Rating constructor
+        /// </summary>
+        /// <param name="category"> HarmCategory for the rating </param>
+        /// <param name="probability"> HarmProbability for the rating </param>
+        internal PalmSafetyRating(gav::HarmCategory category, HarmProbability probability)
         {
             Category = category;
             Probability = probability;

src/LLMSharp.Google.Palm/Common/PalmSafetySetting.cs

@@ -18,6 +18,11 @@ public class PalmSafetySetting
         /// </summary>
         public HarmBlockThreshold Threshold { get; private set; }
 
+        /// <summary>
+        /// Safety Setting constructor
+        /// </summary>
+        /// <param name="category">HarmCategory</param>
+        /// <param name="threshold">BlockThreshold</param>
         public PalmSafetySetting(gav::HarmCategory category, HarmBlockThreshold threshold)
         {
             Category = category;

src/LLMSharp.Google.Palm/DiscussService/IPalmDiscussService.cs

@@ -30,15 +30,15 @@ public interface IPalmDiscussService
         /// <param name="examples">Optional examples included as part of the message</param>
         /// <param name="context">Optional context included in the message</param>
         /// <param name="model">Model used for counting tokens. Default: models/chat-bison-001</param>
-        /// <param name="options">Options for customizing the request</param>
+        /// <param name="reqOptions">Options for customizing the request</param>
         /// <param name="cancellationToken">token used for cancelling the async request</param>
         /// <returns>message token count</returns>
         public Task<int> CountMessageTokensAsync(
             IEnumerable<PalmChatMessage> messages,
             IEnumerable<PalmChatExample>? examples,
             string? context,
             string model,
-            RequestOptions? options,
+            RequestOptions? reqOptions,
             CancellationToken cancellationToken);
     }
 }

src/LLMSharp.Google.Palm/DiscussService/PalmChatCompletionRequest.cs

@@ -3,6 +3,9 @@
 
 namespace LLMSharp.Google.Palm.DiscussService
 {
+    /// <summary>
+    /// Class representation of the Chat Completion Request input
+    /// </summary>
     public class PalmChatCompletionRequest
     {
         /// <summary>
@@ -14,7 +17,7 @@ public class PalmChatCompletionRequest
         /// <summary>
         /// Text that should be provided to the model first, to ground the response.
         /// If not empty, this context will be given to the model first before the examples and messages.
-        //// This field can be a description of your prompt to the model to help provide context and guide the responses.
+        /// This field can be a description of your prompt to the model to help provide context and guide the responses.
         /// </summary>
         public string Context { get; set; } = string.Empty;
 

src/LLMSharp.Google.Palm/DiscussService/PalmChatCompletionResponse.cs

@@ -5,6 +5,9 @@
 
 namespace LLMSharp.Google.Palm.DiscussService
 {
+    /// <summary>
+    /// Class representing the response from a Palm Chat Completion Request
+    /// </summary>
     public class PalmChatCompletionResponse
     {
         internal PalmChatCompletionResponse(gav::GenerateMessageResponse response)

src/LLMSharp.Google.Palm/DiscussService/PalmChatExample.cs

@@ -4,6 +4,9 @@
 
 namespace LLMSharp.Google.Palm
 {
+    /// <summary>
+    /// Class to represent examples to include in the Palm Completion Request
+    /// </summary>
     public class PalmChatExample
     {
         /// <summary>

src/LLMSharp.Google.Palm/DiscussService/PalmChatMessage.cs

@@ -3,6 +3,9 @@
 
 namespace LLMSharp.Google.Palm
 {
+    /// <summary>
+    /// Class representing a chat message to be used in the Palm Completion Request
+    /// </summary>
     public class PalmChatMessage
     {
         internal PalmChatMessage(gav::Message c)
@@ -12,6 +15,11 @@ internal PalmChatMessage(gav::Message c)
             this.CitationMetadata = new PalmCitationMetadata(c.CitationMetadata);
         }
 
+        /// <summary>
+        /// ChatMessage constructor
+        /// </summary>
+        /// <param name="content">content of the chat message</param>
+        /// <param name="author">author of the chat message generally "0" for the user and "1" for the AI</param>
         public PalmChatMessage(string content, string? author) 
         { 
             this.Author = author;

src/LLMSharp.Google.Palm/DiscussService/PalmDiscussService.cs

@@ -50,7 +50,7 @@ internal sealed class PalmDiscussService : IPalmDiscussService
         /// <param name="examples">Optional examples included as part of the message</param>
         /// <param name="context">Optional context included in the message</param>
         /// <param name="model">Model used for counting tokens. Default: models/chat-bison-001</param>
-        /// <param name="options">Options for customizing the request</param>
+        /// <param name="reqOptions">Options for customizing the request</param>
         /// <param name="cancellationToken">token used for cancelling the async request</param>
         /// <returns>message token count</returns>
         public async Task<int> CountMessageTokensAsync(

src/LLMSharp.Google.Palm/GooglePalmClient.cs

@@ -12,9 +12,9 @@ namespace LLMSharp.Google.Palm
     /// </summary>
     public class GooglePalmClient : IGooglePalmClient
     {
-        private readonly IPalmModelService _palmModelService;
-        private readonly IPalmTextService _palmTextService;
-        private readonly IPalmDiscussService _palmDiscussService;
+        private readonly PalmModelService _palmModelService;
+        private readonly PalmTextService _palmTextService;
+        private readonly PalmDiscussService _palmDiscussService;
 
         /// <summary>
         /// Constructor for GooglePalmClient with ApiKey        
@@ -85,23 +85,23 @@ public GooglePalmClient(ClientOptions options)
         /// <param name="examples">Optional examples included as part of the message</param>
         /// <param name="context">Optional context included in the message</param>
         /// <param name="model">Model used for counting tokens. Default: models/chat-bison-001</param>
-        /// <param name="options">Options for customizing the request</param>
+        /// <param name="reqOptions">Options for customizing the request</param>
         /// <param name="cancellationToken">token used for cancelling the async request</param>
         /// <returns>message token count</returns>
         public async Task<int> CountMessageTokensAsync(
             IEnumerable<PalmChatMessage> messages,
             IEnumerable<PalmChatExample>? examples = null,
             string? context = null,
             string model = Constants.DefaultPalmChatCompletionModel,
-            RequestOptions? options = null,
+            RequestOptions? reqOptions = null,
             CancellationToken cancellationToken = default)
         {
             return await this._palmDiscussService.CountMessageTokensAsync(
                 messages,
                 examples ?? Enumerable.Empty<PalmChatExample>(),
                 context,
                 model,
-                options,
+                reqOptions,
                 cancellationToken
             ).ConfigureAwait(false);
         }

src/LLMSharp.Google.Palm/LLMSharp.Google.Palm.csproj

@@ -19,6 +19,7 @@
 		<SignAssembly>True</SignAssembly>
 		<AssemblyOriginatorKeyFile>..\..\google-palm-sdk.snk</AssemblyOriginatorKeyFile>
 		<DelaySign>True</DelaySign>
+		<GenerateDocumentationFile>True</GenerateDocumentationFile>
 	</PropertyGroup>
 
 	<ItemGroup>

src/LLMSharp.Google.Palm/ModelService/IPalmModelService.cs

@@ -4,6 +4,9 @@
 
 namespace LLMSharp.Google.Palm
 {
+    /// <summary>
+    /// Palm2 Model Info, Model list and Model fetch service contract
+    /// </summary>
     public interface IPalmModelService
     {
         /// <summary>

src/LLMSharp.Google.Palm/TextService/IPalmTextService.cs

@@ -4,6 +4,9 @@
 
 namespace LLMSharp.Google.Palm
 {
+    /// <summary>
+    /// Palm2 Text Completion Service contract
+    /// </summary>
     public interface IPalmTextService
     {
         /// <summary>

src/LLMSharp.Google.Palm/TextService/PalmCompletionCandidate.cs

@@ -5,6 +5,9 @@
 
 namespace LLMSharp.Google.Palm
 {
+    /// <summary>
+    /// Class representing one of the candidate response from the TextCompletion model.
+    /// </summary>
     public class PalmCompletionCandidate
     {
         internal PalmCompletionCandidate(gav::TextCompletion c)

src/LLMSharp.Google.Palm/TextService/PalmTextCompletionRequest.cs

@@ -3,6 +3,9 @@
 
 namespace LLMSharp.Google.Palm
 {
+    /// <summary>
+    /// Class representing a request to the Palm Text Completion API
+    /// </summary>
     public class PalmTextCompletionRequest
     {
         /// <summary>

src/LLMSharp.Google.Palm/TextService/PalmTextService.cs

@@ -19,7 +19,8 @@ internal sealed class PalmTextService : IPalmTextService
         /// <summary>
         /// Calls the text completion model and returns the response
         /// </summary>
-        /// <param name="request">Request parameters like 'prompt', 'model' and other model response customization options</param>
+        /// <param name="text">text to embed</param>
+        /// <param name="model">embedding model to use</param>
         /// <param name="options">Options for the specific Grpc call</param>
         /// <param name="token">token for cancelling the request</param>
         /// <returns>TextCompletion response from the Palm Model</returns>
@@ -39,10 +40,9 @@ public async Task<IEnumerable<float>> GenerateEmbeddingsAsync(
         }
 
         /// <summary>
-        /// Calls the Palm Embedding Model to create an embedding for the text passed in.
-        /// </summary>
-        /// <param name="text">text to embed</param>
-        /// <param name="model">embedding model to use</param>
+        /// Calls the Palm Text Generation Model to create text completions for the prompt.
+        /// </summary>                
+        /// <param name="request">Request parameters like 'prompt', 'model' and other model response customization options</param>
         /// <param name="options">Options for the specific Grpc call</param>
         /// <param name="token">token for cancelling the request</param>
         /// <returns>list of float values (embeddings) for the text.</returns>