Update OpenAI library & types

Author: hmarr

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "openai-chat-tokens",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "description": "Estimate the number of tokens an OpenAI chat completion request will use",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -25,11 +25,11 @@
   "devDependencies": {
     "@types/jest": "^29.5.3",
     "jest": "^29.6.1",
-    "openai": "^4.0.0-beta.4",
+    "openai": "^4.2.0",
     "ts-jest": "^29.1.1",
     "typescript": "^5.1.6"
   },
   "dependencies": {
     "js-tiktoken": "^1.0.7"
   }
-}
+}

package.json

@@ -1,7 +1,11 @@
+import OpenAI from "openai";
+
+type OpenAIFunction = OpenAI.Chat.CompletionCreateParams.Function;
+
 // Types representing the OpenAI function definitions. While the OpenAI client library
 // does have types for function definitions, the properties are just Record<string, unknown>,
 // which isn't very useful for type checking this formatting code.
-export interface FunctionDef {
+export interface FunctionDef extends Omit<OpenAIFunction, "parameters"> {
   name: string;
   description?: string;
   parameters: ObjectProp;
@@ -32,9 +36,9 @@ type Prop = {
     | { type: "boolean" }
     | { type: "null" }
     | {
-        type: "array";
-        items?: Prop;
-      }
+      type: "array";
+      items?: Prop;
+    }
   );
 
 // When OpenAI use functions in the prompt, they format them as TypeScript definitions rather than OpenAPI JSON schemas.

src/functions.ts

@@ -2,8 +2,8 @@ import OpenAI from "openai";
 import { Tiktoken, getEncoding } from "js-tiktoken";
 import { FunctionDef, formatFunctionDefinitions } from "./functions";
 
-type Message = OpenAI.Chat.CompletionCreateParams.CreateChatCompletionRequestNonStreaming.Message;
-type Function = OpenAI.Chat.CompletionCreateParams.CreateChatCompletionRequestNonStreaming.Function;
+type Message = OpenAI.Chat.CreateChatCompletionRequestMessage;
+type Function = OpenAI.Chat.CompletionCreateParams.Function;
 
 let encoder: Tiktoken | undefined;
 

src/index.ts

@@ -1,35 +1,15 @@
 import OpenAI from "openai";
 import { promptTokensEstimate } from "../src";
 
-type Message = OpenAI.Chat.CompletionCreateParams.CreateChatCompletionRequestNonStreaming.Message;
-type Function = OpenAI.Chat.CompletionCreateParams.CreateChatCompletionRequestNonStreaming.Function;
+type Message = OpenAI.Chat.CreateChatCompletionRequestMessage;
+type Function = OpenAI.Chat.CompletionCreateParams.Function;
 type Example = {
   messages: Message[];
   functions?: Function[];
   tokens: number;
   validate?: boolean
 };
 
-const r: OpenAI.Chat.CompletionCreateParams.CreateChatCompletionRequestNonStreaming = {
-  "model": "gpt-3.5-turbo",
-  "temperature": 0,
-  "functions": [
-    {
-      "name": "do_stuff",
-      "parameters": {
-        "type": "object",
-        "properties": {}
-      }
-    }
-  ],
-  "messages": [
-    {
-      "role": "system",
-      "content": "hello:"
-    },
-  ]
-};
-
 const TEST_CASES: Example[] = [
   // these match https://github.com/openai/openai-cookbook/blob/main/examples/How_to_count_tokens_with_tiktoken.ipynb
   {