feat: adds prompt caching usage (#4)

kevinhermawan · Oct 3, 2024 · 4f329db · 4f329db
1 parent a0df5e0
commit 4f329db
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 11 deletions.
diff --git a/Package.resolved b/Package.resolved
@@ -23,8 +23,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/kevinhermawan/swift-json-schema.git",
       "state" : {
-        "revision" : "6bf106ad4ef4ee3c85ecab4963296374240b9415",
-        "version" : "1.0.2"
+        "revision" : "48cade5fb09c6fdc86adcf9af7e43a2c7582a65a",
+        "version" : "1.0.3"
       }
     }
   ],

diff --git a/Package.swift b/Package.swift
@@ -12,7 +12,7 @@ let package = Package(
             targets: ["LLMChatOpenAI"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/kevinhermawan/swift-json-schema.git", exact: "1.0.2"),
+        .package(url: "https://github.com/kevinhermawan/swift-json-schema.git", exact: "1.0.3"),
         .package(url: "https://github.com/apple/swift-docc-plugin.git", .upToNextMajor(from: "1.3.0"))
     ],
     targets: [

diff --git a/Sources/LLMChatOpenAI/ChatCompletion.swift b/Sources/LLMChatOpenAI/ChatCompletion.swift
@@ -157,7 +157,10 @@ public struct ChatCompletion: Decodable {
         /// Breakdown of tokens used in a completion.
         public let completionTokensDetails: CompletionTokensDetails?
 
-        public struct CompletionTokensDetails: Decodable {
+        /// Breakdown of tokens used in the prompt.
+        public let promptTokensDetails: PromptTokensDetails?
+
+        public struct CompletionTokensDetails: Decodable {            
             /// Tokens generated by the model for reasoning.
             public let reasoningTokens: Int
 
@@ -166,11 +169,21 @@ public struct ChatCompletion: Decodable {
             }
         }
 
+        public struct PromptTokensDetails: Decodable {
+            /// Cached tokens present in the prompt.
+            public let cachedTokens: Int
+
+            private enum CodingKeys: String, CodingKey {
+                case cachedTokens = "cached_tokens"
+            }
+        }
+
         private enum CodingKeys: String, CodingKey {
             case completionTokens = "completion_tokens"
             case promptTokens = "prompt_tokens"
             case totalTokens = "total_tokens"
             case completionTokensDetails = "completion_tokens_details"
+            case promptTokensDetails = "prompt_tokens_details"
         }
     }
 

diff --git a/Sources/LLMChatOpenAI/ChatCompletionChunk.swift b/Sources/LLMChatOpenAI/ChatCompletionChunk.swift
@@ -146,23 +146,37 @@ public struct ChatCompletionChunk: Decodable {
         /// Total number of tokens used in the request (prompt + completion).
         public let totalTokens: Int?
 
-        /// Additional details about completion tokens.
+        /// Breakdown of tokens used in a completion.
         public let completionTokensDetails: CompletionTokensDetails?
 
-        private enum CodingKeys: String, CodingKey {
-            case completionTokens = "completion_tokens"
-            case promptTokens = "prompt_tokens"
-            case totalTokens = "total_tokens"
-            case completionTokensDetails = "completion_tokens_details"
-        }
+        /// Breakdown of tokens used in the prompt.
+        public let promptTokensDetails: PromptTokensDetails?
 
         public struct CompletionTokensDetails: Decodable {
+            /// Tokens generated by the model for reasoning.
             public let reasoningTokens: Int
 
             private enum CodingKeys: String, CodingKey {
                 case reasoningTokens = "reasoning_tokens"
             }
         }
+
+        public struct PromptTokensDetails: Decodable {
+            /// Cached tokens present in the prompt.
+            public let cachedTokens: Int
+
+            private enum CodingKeys: String, CodingKey {
+                case cachedTokens = "cached_tokens"
+            }
+        }
+
+        private enum CodingKeys: String, CodingKey {
+            case completionTokens = "completion_tokens"
+            case promptTokens = "prompt_tokens"
+            case totalTokens = "total_tokens"
+            case completionTokensDetails = "completion_tokens_details"
+            case promptTokensDetails = "prompt_tokens_details"
+        }
     }
 
     private enum CodingKeys: String, CodingKey {