updated docs

RageAgainstThePixel · StephenHodgson · Mar 22, 2023 · Mar 21, 2023 · Mar 21, 2023 · Mar 21, 2023
commit 23d774b3f6bf3b482383c9323156910f365e0d78
@@ -8,7 +8,8 @@
 namespace OpenAI.Audio
 {
  /// <summary>
- /// Speech to text.
+ /// Transforms audio into text.<br/>
+ /// <see href="https://platform.openai.com/docs/api-reference/audio"/>
  /// </summary>
  public sealed class AudioEndpoint : BaseEndPoint
  {

@@ -10,7 +10,7 @@
 namespace OpenAI.Chat
 {
  /// <summary>
- /// Given a chat conversation, the model will return a chat completion response.
+ /// Given a chat conversation, the model will return a chat completion response.<br/>
  /// <see href="https://platform.openai.com/docs/api-reference/chat"/>
  /// </summary>
  public sealed class ChatEndpoint : BaseEndPoint

@@ -15,7 +15,7 @@ namespace OpenAI.Completions
  /// The way you “program” the API to do a task is by simply describing the task in plain english or providing
  /// a few written examples. This simple approach works for a wide range of use cases, including summarization,
  /// translation, grammar correction, question answering, chatbots, composing emails, and much more
- /// (see the prompt library for inspiration).
+ /// (see the prompt library for inspiration).<br/>
  /// <see href="https://beta.openai.com/docs/api-reference/completions"/>
  /// </summary>
  public sealed class CompletionsEndpoint : BaseEndPoint

@@ -5,7 +5,7 @@
 namespace OpenAI.Edits
 {
  /// <summary>
- /// Given a prompt and an instruction, the model will return an edited version of the prompt.
+ /// Given a prompt and an instruction, the model will return an edited version of the prompt.<br/>
  /// <see href="https://beta.openai.com/docs/api-reference/edits"/>
  /// </summary>
  public sealed class EditsEndpoint : BaseEndPoint

@@ -6,7 +6,7 @@
 namespace OpenAI.Embeddings
 {
  /// <summary>
- /// Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
+ /// Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.<br/>
  /// <see href="https://beta.openai.com/docs/guides/embeddings"/>
  /// </summary>
  public sealed class EmbeddingsEndpoint : BaseEndPoint

@@ -10,7 +10,7 @@
 namespace OpenAI.Files
 {
  /// <summary>
- /// Files are used to upload documents that can be used with features like Fine-tuning.
+ /// Files are used to upload documents that can be used with features like Fine-tuning.<br/>
  /// <see href="https://beta.openai.com/docs/api-reference/fine-tunes"/>
  /// </summary>
  public class FilesEndpoint : BaseEndPoint

@@ -12,7 +12,7 @@
 namespace OpenAI.FineTuning
 {
  /// <summary>
- /// Manage fine-tuning jobs to tailor a model to your specific training data.
+ /// Manage fine-tuning jobs to tailor a model to your specific training data.<br/>
  /// <see href="https://beta.openai.com/docs/guides/fine-tuning"/>
  /// </summary>
  public class FineTuningEndpoint : BaseEndPoint

@@ -9,7 +9,8 @@
 namespace OpenAI.Images
 {
  /// <summary>
- /// Creates an image given a prompt.
+ /// Given a prompt and/or an input image, the model will generate a new image.<br/>
+ /// <see href="https://platform.openai.com/docs/api-reference/images"/>
  /// </summary>
  public sealed class ImagesEndpoint : BaseEndPoint
  {

@@ -8,7 +8,7 @@ namespace OpenAI.Moderations
 {
  /// <summary>
  /// The moderation endpoint is a tool you can use to check whether content complies with OpenAI's content policy.
- /// Developers can thus identify content that our content policy prohibits and take action, for instance by filtering it.
+ /// Developers can thus identify content that our content policy prohibits and take action, for instance by filtering it.<br/>
  /// <see href="https://beta.openai.com/docs/api-reference/moderations"/>
  /// </summary>
  public sealed class ModerationsEndpoint : BaseEndPoint

@@ -134,52 +134,61 @@ private HttpClient SetupClient(HttpClient client = null)
  public ModelsEndpoint ModelsEndpoint { get; }
 
  /// <summary>
- /// Text generation is the core function of the API.
- /// You give the API a prompt, and it generates a completion.
- /// The way you “program” the API to do a task is by simply describing the task in plain english
- /// or providing a few written examples. This simple approach works for a wide range of use cases,
- /// including summarization, translation, grammar correction, question answering, chatbots, composing emails,
- /// and much more (see the prompt library for inspiration).
+ /// Text generation is the core function of the API. You give the API a prompt, and it generates a completion.
+ /// The way you “program” the API to do a task is by simply describing the task in plain english or providing
+ /// a few written examples. This simple approach works for a wide range of use cases, including summarization,
+ /// translation, grammar correction, question answering, chatbots, composing emails, and much more
+ /// (see the prompt library for inspiration).<br/>
+ /// <see href="https://beta.openai.com/docs/api-reference/completions"/>
  /// </summary>
  public CompletionsEndpoint CompletionsEndpoint { get; }
 
  /// <summary>
- /// Given a chat conversation, the model will return a chat completion response.
+ /// Given a chat conversation, the model will return a chat completion response.<br/>
+ /// <see href="https://platform.openai.com/docs/api-reference/chat"/>
  /// </summary>
  public ChatEndpoint ChatEndpoint { get; }
 
  /// <summary>
- /// Given a prompt and an instruction, the model will return an edited version of the prompt.
+ /// Given a prompt and an instruction, the model will return an edited version of the prompt.<br/>
+ /// <see href="https://beta.openai.com/docs/api-reference/edits"/>
  /// </summary>
  public EditsEndpoint EditsEndpoint { get; }
 
  /// <summary>
- /// Given a prompt and/or an input image, the model will generate a new image.
+ /// Given a prompt and/or an input image, the model will generate a new image.<br/>
+ /// <see href="https://platform.openai.com/docs/api-reference/images"/>
  /// </summary>
  public ImagesEndpoint ImagesEndPoint { get; }
 
  /// <summary>
- /// Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
+ /// Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.<br/>
+ /// <see href="https://beta.openai.com/docs/guides/embeddings"/>
  /// </summary>
  public EmbeddingsEndpoint EmbeddingsEndpoint { get; }
 
  /// <summary>
- /// Converts audio into text.
+ /// Transforms audio into text.<br/>
+ /// <see href="https://platform.openai.com/docs/api-reference/audio"/>
  /// </summary>
  public AudioEndpoint AudioEndpoint { get; }
 
  /// <summary>
- /// Files are used to upload documents that can be used with features like Fine-tuning.
+ /// Files are used to upload documents that can be used with features like Fine-tuning.<br/>
+ /// <see href="https://beta.openai.com/docs/api-reference/fine-tunes"/>
  /// </summary>
  public FilesEndpoint FilesEndpoint { get; }
 
  /// <summary>
- /// Manage fine-tuning jobs to tailor a model to your specific training data.
+ /// Manage fine-tuning jobs to tailor a model to your specific training data.<br/>
+ /// <see href="https://beta.openai.com/docs/guides/fine-tuning"/>
  /// </summary>
  public FineTuningEndpoint FineTuningEndpoint { get; }
 
  /// <summary>
- /// The moderation endpoint is a tool you can use to check whether content complies with OpenAI's content policy. Developers can thus identify content that our content policy prohibits and take action, for instance by filtering it.
+ /// The moderation endpoint is a tool you can use to check whether content complies with OpenAI's content policy.
+ /// Developers can thus identify content that our content policy prohibits and take action, for instance by filtering it.<br/>
+ /// <see href="https://beta.openai.com/docs/api-reference/moderations"/>
  /// </summary>
  public ModerationsEndpoint ModerationsEndpoint { get; }
  }