openai - npm Package Compare versions

Comparing version 2.0.5 to 3.0.0

base.ts

@@ -7,3 +7,3 @@ /* tslint:disable */
  *
- * The version of the OpenAPI document: 1.0.4
+ * The version of the OpenAPI document: 1.0.5
  * 
@@ -10,0 +10,0 @@ *

common.ts

@@ -7,3 +7,3 @@ /* tslint:disable */
  *
- * The version of the OpenAPI document: 1.0.4
+ * The version of the OpenAPI document: 1.0.5
  * 
@@ -10,0 +10,0 @@ *

configuration.ts

@@ -7,3 +7,3 @@ /* tslint:disable */
  *
- * The version of the OpenAPI document: 1.0.4
+ * The version of the OpenAPI document: 1.0.5
  * 
@@ -10,0 +10,0 @@ *

dist/base.d.ts

@@ -5,3 +5,3 @@ /**
  *
- * The version of the OpenAPI document: 1.0.4
+ * The version of the OpenAPI document: 1.0.5
  *
@@ -8,0 +8,0 @@ *

dist/base.js

@@ -8,3 +8,3 @@ "use strict";
  *
- * The version of the OpenAPI document: 1.0.4
+ * The version of the OpenAPI document: 1.0.5
  *
@@ -11,0 +11,0 @@ *

dist/common.d.ts

@@ -5,3 +5,3 @@ /**
  *
- * The version of the OpenAPI document: 1.0.4
+ * The version of the OpenAPI document: 1.0.5
  *
@@ -8,0 +8,0 @@ *

dist/common.js

@@ -8,3 +8,3 @@ "use strict";
  *
- * The version of the OpenAPI document: 1.0.4
+ * The version of the OpenAPI document: 1.0.5
  *
@@ -11,0 +11,0 @@ *

dist/configuration.d.ts

@@ -5,3 +5,3 @@ /**
  *
- * The version of the OpenAPI document: 1.0.4
+ * The version of the OpenAPI document: 1.0.5
  *
@@ -8,0 +8,0 @@ *

dist/configuration.js

@@ -8,3 +8,3 @@ "use strict";
  *
- * The version of the OpenAPI document: 1.0.4
+ * The version of the OpenAPI document: 1.0.5
  *
@@ -11,0 +11,0 @@ *

dist/index.d.ts

@@ -5,3 +5,3 @@ /**
  *
- * The version of the OpenAPI document: 1.0.4
+ * The version of the OpenAPI document: 1.0.5
  *
@@ -8,0 +8,0 @@ *

dist/index.js

@@ -8,3 +8,3 @@ "use strict";
  *
- * The version of the OpenAPI document: 1.0.4
+ * The version of the OpenAPI document: 1.0.5
  *
@@ -11,0 +11,0 @@ *

index.ts

@@ -7,3 +7,3 @@ /* tslint:disable */
  *
- * The version of the OpenAPI document: 1.0.4
+ * The version of the OpenAPI document: 1.0.5
  * 
@@ -10,0 +10,0 @@ *

package.json

 {
   "name": "openai",
-  "version": "2.0.5",
+  "version": "3.0.0",
   "description": "Node.js library for the OpenAI API",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -25,3 +25,4 @@ # OpenAI Node.js Library
 
-const completion = await openai.createCompletion("text-davinci-001", {
+const completion = await openai.createCompletion({
+  model: "text-davinci-002",
   prompt: "Hello world",
@@ -41,4 +42,4 @@ });
 const completion = await openai.createCompletion(
-  "text-davinci-001",
   {
+    model: "text-davinci-002",
     prompt: "Hello world",
@@ -61,3 +62,4 @@ },
 try {
-  const completion = await openai.createCompletion("text-davinci-001", {
+  const completion = await openai.createCompletion({
+    model: "text-davinci-002",
     prompt: "Hello world",
@@ -76,4 +78,12 @@ });
 
+## Upgrade guide
+
+All breaking changes for major version releases are listed below.
+
+### 3.0.0
+
+- The function signature of `createCompletion(engineId, params)` changed to `createCompletion(params)`. The value previously passed in as the `engineId` argument should now be passed in as `model` in the params object (e.g. `createCompletion({ model: "text-davinci-002, ... })`)
+
 ## Thanks
 
 Thank you to [ceifa](https://github.com/ceifa) for creating and maintaining the original unofficial `openai` npm package before we released this official library! ceifa's original package has been renamed to [gpt-x](https://www.npmjs.com/package/gpt-x).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

7033

increased by0.79%

Number of lines in readme file

86

increased by13.16%

Worsened metrics

Total package byte prevSize

328628

decreased by-5.09%

No dependency changes