update instruct -> instructor + clean up exports

instructor-ai · Jan 2, 2024 · 781b51e · 781b51e
1 parent 1001867
commit 781b51e
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 243 deletions.
diff --git a/examples/test.ts → examples/extract_user/index.ts b/examples/test.ts → examples/extract_user/index.ts
@@ -1,4 +1,4 @@
-import { Instruct } from "@/instructor"
+import Instructor from "@/instructor"
 import OpenAI from "openai"
 import { z } from "zod"
 
@@ -16,7 +16,7 @@ const oai = new OpenAI({
   organization: process.env.OPENAI_ORG_ID ?? undefined
 })
 
-const client = new Instruct({
+const client = new Instructor({
   client: oai,
   mode: "FUNCTIONS"
 })

diff --git a/examples/extract_user/run.ts b/examples/extract_user/run.ts
diff --git a/package.json b/package.json
@@ -2,9 +2,15 @@
   "name": "instructor-js",
   "version": "0.0.1",
   "description": "structured outputs for llms",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
+  "main": "./dist/instructor.js",
+  "module": "./dist/instructor.mjs",
+  "types": "./dist/instructor.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/instructor.mjs",
+      "require": "./dist/instructor.js"
+    }
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsup",

diff --git a/src/index.ts b/src/index.ts
diff --git a/src/instructor.ts b/src/instructor.ts
@@ -38,12 +38,12 @@ type PatchedChatCompletionCreateParams = ChatCompletionCreateParamsNonStreaming
   max_retries?: number
 }
 
-export class Instruct {
+export default class Instructor {
   private client: OpenAI
   private mode: MODE
 
   /**
-   * Creates an instance of the `Instruct` class.
+   * Creates an instance of the `Instructor` class.
    * @param {OpenAI} client - The OpenAI client.
    * @param {string} mode - The mode of operation.
    */

diff --git a/src/patch.ts b/src/patch.ts
diff --git a/tests/functions.test.ts b/tests/functions.test.ts
@@ -1,4 +1,4 @@
-import { Instruct } from "@/instructor"
+import Instructor from "@/instructor"
 import { describe, expect, test } from "bun:test"
 import OpenAI from "openai"
 import { z } from "zod"
@@ -18,7 +18,7 @@ async function extractUser() {
     organization: process.env.OPENAI_ORG_ID ?? undefined
   })
 
-  const client = new Instruct({
+  const client = new Instructor({
     client: oai,
     mode: "FUNCTIONS"
   })