Added comments to crate::options module

sdk/openai/inference/src/clients/openai_client.rs

@@ -17,6 +17,7 @@ pub trait OpenAIClientMethods {
     fn chat_completions_client(&self) -> ChatCompletionsClient;
 }
 
+/// A client that can be used to interact with the OpenAI API.
 #[derive(Debug, Clone)]
 pub struct OpenAIClient {
     base_url: Url,

sdk/openai/inference/src/options/azure_openai_client_options.rs

@@ -2,6 +2,7 @@ use azure_core::ClientOptions;
 
 use crate::AzureServiceVersion;
 
+/// Options to be passed to [`AzureOpenAIClient`](crate::clients::AzureOpenAIClient).
 // TODO: I was not  able to  find ClientOptions as a derive macros
 #[derive(Clone, Debug, Default)]
 pub struct AzureOpenAIClientOptions {
@@ -27,11 +28,21 @@ pub mod builders {
         pub(super) fn new() -> Self {
             Self::default()
         }
+
+        /// Configures the [`AzureOpenAIClient`](crate::clients::AzureOpenAIClient) to use the specified API version.
+        /// If no value is supplied, the latest version will be used as default. See [`AzureServiceVersion::get_latest()`](AzureServiceVersion::get_latest).
         pub fn with_api_version(mut self, api_service_version: AzureServiceVersion) -> Self {
             self.options.api_service_version = api_service_version;
             self
         }
 
+        /// Builds the [`AzureOpenAIClientOptions`].
+        ///
+        /// # Examples
+        ///
+        /// ```rust
+        /// let options = azure_openai_inference::OpenAIClientOptions::builder().build();
+        /// ```
         pub fn build(&self) -> AzureOpenAIClientOptions {
             self.options.clone()
         }

sdk/openai/inference/src/options/openai_client_options.rs

@@ -1,16 +1,23 @@
 use azure_core::ClientOptions;
 
+/// Options to be passed to [`OpenAIClient`](crate::clients::OpenAIClient).
+///
+/// Note: There are currently no options to be set.
+/// This struct is a placeholder for future options.
+// TODO: I was not  able to  find ClientOptions as a derive macros
 #[derive(Clone, Debug, Default)]
 pub struct OpenAIClientOptions {
     pub(crate) client_options: ClientOptions,
 }
 
 impl OpenAIClientOptions {
+    /// Creates a new [`builders::OpenAIClientOptionsBuilder`].
     pub fn builder() -> builders::OpenAIClientOptionsBuilder {
         builders::OpenAIClientOptionsBuilder::new()
     }
 }
 
+/// Builder to construct a [`OpenAIClientOptions`].
 pub mod builders {
     use super::*;
 
@@ -24,6 +31,13 @@ pub mod builders {
             Self::default()
         }
 
+        /// Builds the [`OpenAIClientOptions`].
+        ///
+        /// # Examples
+        ///
+        /// ```rust
+        /// let options = azure_openai_inference::OpenAIClientOptions::builder().build();
+        /// ```
         pub fn build(&self) -> OpenAIClientOptions {
             self.options.clone()
         }

sdk/openai/inference/src/options/service_version.rs

@@ -3,6 +3,10 @@ use std::sync::Arc;
 
 use azure_core::{Context, Policy, PolicyResult, Request};
 
+/// The version of the Azure service to use.
+/// This enum is passed to the [`AzureOpenAIClientOptionsBuilder`](crate::builders::AzureOpenAIClientOptionsBuilder) to configure an [`AzureOpenAIClient`](crate::clients::AzureOpenAIClient) to specify the version of the service to use.
+///
+/// If no version is specified, the latest version will be used. See [`AzureServiceVersion::get_latest()`](AzureServiceVersion::get_latest).
 #[derive(Debug, Clone)]
 pub enum AzureServiceVersion {
     V2023_09_01Preview,
@@ -17,6 +21,7 @@ impl Default for AzureServiceVersion {
 }
 
 impl AzureServiceVersion {
+    /// Returns the latest supported version of the Azure OpenAI service.
     pub fn get_latest() -> AzureServiceVersion {
         AzureServiceVersion::V2024_07_01Preview
     }