feat: Added ChatModelMetadata.

src/libs/OpenAI/Metadata/ChatModelMetadata.cs

@@ -0,0 +1,42 @@
+namespace OpenAI;
+
+/// <summary>
+/// Metadata for chat models.
+/// </summary>
+public class ChatModelMetadata
+{
+    /// <summary>
+    /// Price per training token in USD.
+    /// </summary>
+    public double? PricePerInputTokenInUsd { get; init; }
+
+    /// <summary>
+    /// Price per input token in USD.
+    /// </summary>
+    public double? PricePerOutputTokenInUsd { get; init; }
+
+    /// <summary>
+    /// Fine-tune price per training token in USD.
+    /// </summary>
+    public double? FineTunePricePerTrainingTokenInUsd { get; init; }
+
+    /// <summary>
+    /// Fine-tune price per input token in USD.
+    /// </summary>
+    public double? FineTunePricePerInputTokenInUsd { get; init; }
+
+    /// <summary>
+    /// Fine-tune price per output token in USD.
+    /// </summary>
+    public double? FineTunePricePerOutputTokenInUsd { get; init; }
+
+    /// <summary>
+    /// Context length in tokens.
+    /// </summary>
+    public int? ContextLength { get; init; }
+
+    /// <summary>
+    /// Output length in tokens.
+    /// </summary>
+    public int? OutputLength { get; init; }
+}

src/libs/OpenAI/Metadata/Metadata.Chat.cs

@@ -0,0 +1,208 @@
+// ReSharper disable once CheckNamespace
+namespace OpenAI;
+
+public static partial class Metadata
+{
+    /// <summary>
+    /// According https://openai.com/pricing/ <br/>
+    /// </summary>
+    /// <param name="model"></param>
+    /// <returns></returns>
+    public static ChatModelMetadata GetChatModelMetadata(
+        this CreateChatCompletionRequestModel model)
+    {
+        return model switch
+        {
+            CreateChatCompletionRequestModel.Gpt4o or
+            CreateChatCompletionRequestModel.Gpt4o20240513 => new ChatModelMetadata
+            {
+                PricePerInputTokenInUsd = 5.0 * UsdPerMillionTokens,
+                PricePerOutputTokenInUsd = 15.0 * UsdPerMillionTokens,
+                ContextLength = 128_000,
+                OutputLength = 16_000,
+            },
+            CreateChatCompletionRequestModel.Gpt4oMini or
+            CreateChatCompletionRequestModel.Gpt4oMini20240718 => new ChatModelMetadata
+            {
+                PricePerInputTokenInUsd = 0.15 * UsdPerMillionTokens,
+                PricePerOutputTokenInUsd = 0.60 * UsdPerMillionTokens,
+                ContextLength = 128_000,
+                OutputLength = 16_000,
+            },
+
+            CreateChatCompletionRequestModel.Gpt4Turbo or
+            CreateChatCompletionRequestModel.Gpt4Turbo20240409 or
+            CreateChatCompletionRequestModel.Gpt40125Preview or
+            CreateChatCompletionRequestModel.Gpt4TurboPreview or
+            CreateChatCompletionRequestModel.Gpt41106Preview or
+            CreateChatCompletionRequestModel.Gpt4VisionPreview => new ChatModelMetadata
+            {
+                PricePerInputTokenInUsd = 10.0 * UsdPerMillionTokens,
+                PricePerOutputTokenInUsd = 30.0 * UsdPerMillionTokens,
+                ContextLength = 128_000,
+                OutputLength = 16_000,
+            },
+
+            CreateChatCompletionRequestModel.Gpt4 or
+            CreateChatCompletionRequestModel.Gpt40314 or
+            CreateChatCompletionRequestModel.Gpt40613 => new ChatModelMetadata
+            {
+                PricePerInputTokenInUsd = 30.0 * UsdPerMillionTokens,
+                PricePerOutputTokenInUsd = 60.0 * UsdPerMillionTokens,
+                ContextLength = 8_192,
+                OutputLength = 16_000,
+            },
+
+            CreateChatCompletionRequestModel.Gpt432k or
+            CreateChatCompletionRequestModel.Gpt432k0314 or
+            CreateChatCompletionRequestModel.Gpt432k0613 => new ChatModelMetadata
+            {
+                PricePerInputTokenInUsd = 60.0 * UsdPerMillionTokens,
+                PricePerOutputTokenInUsd = 120.0 * UsdPerMillionTokens,
+                ContextLength = 32_768,
+                OutputLength = 16_000,
+            },
+
+            CreateChatCompletionRequestModel.Gpt35Turbo or
+            CreateChatCompletionRequestModel.Gpt35Turbo0125 => new ChatModelMetadata
+            {
+                PricePerInputTokenInUsd = 0.5 * UsdPerMillionTokens,
+                PricePerOutputTokenInUsd = 1.5 * UsdPerMillionTokens,
+                ContextLength = 16_385,
+                OutputLength = 16_000,
+
+                FineTunePricePerTrainingTokenInUsd = 8.0 * UsdPerMillionTokens,
+                FineTunePricePerInputTokenInUsd = 3.0 * UsdPerMillionTokens,
+                FineTunePricePerOutputTokenInUsd = 6.0 * UsdPerMillionTokens,
+            },
+            CreateChatCompletionRequestModel.Gpt35Turbo1106 => new ChatModelMetadata
+            {
+                PricePerInputTokenInUsd = 1.0 * UsdPerMillionTokens,
+                PricePerOutputTokenInUsd = 2.0 * UsdPerMillionTokens,
+                ContextLength = 16_385,
+                OutputLength = 16_000,
+            },
+            CreateChatCompletionRequestModel.Gpt35Turbo0613 => new ChatModelMetadata
+            {
+                PricePerInputTokenInUsd = 1.5 * UsdPerMillionTokens,
+                PricePerOutputTokenInUsd = 2.0 * UsdPerMillionTokens,
+                ContextLength = 4_096,
+                OutputLength = 16_000,
+            },
+            CreateChatCompletionRequestModel.Gpt35Turbo0301 => new ChatModelMetadata
+            {
+                PricePerInputTokenInUsd = 2.0 * UsdPerMillionTokens,
+                PricePerOutputTokenInUsd = 2.0 * UsdPerMillionTokens,
+                ContextLength = 4_096,
+                OutputLength = 16_000,
+            },
+            CreateChatCompletionRequestModel.Gpt35Turbo16k or
+            CreateChatCompletionRequestModel.Gpt35Turbo16k0613 => new ChatModelMetadata
+            {
+                PricePerInputTokenInUsd = 3.0 * UsdPerMillionTokens,
+                PricePerOutputTokenInUsd = 4.0 * UsdPerMillionTokens,
+                ContextLength = 16_385,
+                OutputLength = 16_000,
+            },
+
+            _ => new ChatModelMetadata(),
+        };
+    }
+
+    /// <summary>
+    /// According https://openai.com/pricing/ <br/>
+    /// </summary>
+    /// <param name="model"></param>
+    /// <param name="inputTokens"></param>
+    /// <param name="outputTokens"></param>
+    /// <returns></returns>
+    public static double? TryGetPriceInUsd(
+        this CreateChatCompletionRequestModel model,
+        int inputTokens,
+        int outputTokens)
+    {
+        var metadata = model.GetChatModelMetadata();
+        if (metadata.PricePerInputTokenInUsd == null ||
+            metadata.PricePerOutputTokenInUsd == null)
+        {
+            return null;
+        }
+
+        return
+            inputTokens * metadata.PricePerInputTokenInUsd +
+            outputTokens * metadata.PricePerOutputTokenInUsd;
+    }
+
+    /// <inheritdoc cref="TryGetPriceInUsd(CreateChatCompletionRequestModel, int, int)"/>
+    /// <exception cref="InvalidOperationException"></exception>
+    public static double GetPriceInUsd(
+        this CreateChatCompletionRequestModel model,
+        int inputTokens,
+        int outputTokens)
+    {
+        return model.TryGetPriceInUsd(inputTokens, outputTokens) ??
+               throw new InvalidOperationException(
+                   $"Prices are not available for {model.ToValueString()}.");
+    }
+
+    /// <summary>
+    /// According https://openai.com/pricing/ <br/>
+    /// </summary>
+    /// <param name="model"></param>
+    /// <param name="trainingTokens"></param>
+    /// <param name="inputTokens"></param>
+    /// <param name="outputTokens"></param>
+    /// <exception cref="InvalidOperationException"></exception>
+    /// <returns></returns>
+    public static double? TryGetFineTunePriceInUsd(
+        this CreateChatCompletionRequestModel model,
+        int trainingTokens,
+        int inputTokens,
+        int outputTokens)
+    {
+        var metadata = model.GetChatModelMetadata();
+        if (metadata.FineTunePricePerTrainingTokenInUsd == null ||
+            metadata.FineTunePricePerInputTokenInUsd == null ||
+            metadata.FineTunePricePerOutputTokenInUsd == null)
+        {
+            return null;
+        }
+
+        return trainingTokens * metadata.FineTunePricePerTrainingTokenInUsd +
+               inputTokens * metadata.FineTunePricePerInputTokenInUsd +
+               outputTokens * metadata.FineTunePricePerOutputTokenInUsd;
+    }
+
+    /// <inheritdoc cref="TryGetFineTunePriceInUsd"/>
+    /// <exception cref="InvalidOperationException"></exception>
+    public static double GetFineTunePriceInUsd(
+        this CreateChatCompletionRequestModel model,
+        int trainingTokens,
+        int inputTokens,
+        int outputTokens)
+    {
+        return model.TryGetFineTunePriceInUsd(trainingTokens, inputTokens, outputTokens) ??
+               throw new InvalidOperationException(
+                   $"Fine tuning prices are not available for {model.ToValueString()}.");
+    }
+
+    /// <inheritdoc cref="GetOutputLength"/>
+    /// <exception cref="InvalidOperationException"></exception>
+    public static int GetContextLength(
+        this CreateChatCompletionRequestModel model)
+    {
+        return model.GetChatModelMetadata().ContextLength ??
+               throw new InvalidOperationException(
+                   $"Context length is not available for {model.ToValueString()}.");
+    }
+
+    /// <inheritdoc cref="GetChatModelMetadata"/>
+    /// <exception cref="InvalidOperationException"></exception>
+    public static int GetOutputLength(
+        this CreateChatCompletionRequestModel model)
+    {
+        return model.GetChatModelMetadata().OutputLength ??
+               throw new InvalidOperationException(
+                   $"Output length is not available for {model.ToValueString()}.");
+    }
+}

src/libs/OpenAI/Prices/Prices.Embedding.cs → src/libs/OpenAI/Metadata/Metadata.Embedding.cs

@@ -1,7 +1,7 @@
 // ReSharper disable once CheckNamespace
 namespace OpenAI;
 
-public static partial class Prices
+public static partial class Metadata
 {
     /// <summary>
     /// According https://openai.com/pricing/ <br/>

src/libs/OpenAI/Prices/Prices.Images.cs → src/libs/OpenAI/Metadata/Metadata.Images.cs

@@ -1,7 +1,7 @@
 // ReSharper disable once CheckNamespace
 namespace OpenAI;
 
-public static partial class Prices
+public static partial class Metadata
 {
     /// <summary>
     /// All prices in USD. <br/>

src/libs/OpenAI/Prices/Prices.STT.cs → src/libs/OpenAI/Metadata/Metadata.STT.cs

@@ -1,7 +1,7 @@
 // ReSharper disable once CheckNamespace
 namespace OpenAI;
 
-public static partial class Prices
+public static partial class Metadata
 {
     /// <summary>
     /// According https://openai.com/pricing/ <br/>

src/libs/OpenAI/Prices/Prices.TTS.cs → src/libs/OpenAI/Metadata/Metadata.TTS.cs

@@ -1,7 +1,7 @@
 // ReSharper disable once CheckNamespace
 namespace OpenAI;
 
-public static partial class Prices
+public static partial class Metadata
 {
     /// <summary>
     /// According https://openai.com/pricing/ <br/>

src/libs/OpenAI/Prices/Prices.cs → src/libs/OpenAI/Metadata/Metadata.cs

@@ -4,7 +4,7 @@ namespace OpenAI;
 /// <summary>
 /// According https://openai.com/pricing/
 /// </summary>
-public static partial class Prices
+public static partial class Metadata
 {
     /// <summary>
     /// Just a constant for 1e-3.

src/libs/OpenAI/OpenAI.csproj

@@ -2,6 +2,7 @@
 
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0;net4.6.2;net6.0;net8.0</TargetFrameworks>
+    <NoWarn>$(NoWarn);CA1724</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>