@ai-sdk/openai - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

./dist/index.js

@@ -768,2 +768,4 @@ "use strict";
     this.organization = options.organization;
+    this.project = options.project;
+    this.headers = options.headers;
   }
@@ -780,3 +782,5 @@ get baseConfig() {
         })}`,
-        "OpenAI-Organization": this.organization
+        "OpenAI-Organization": this.organization,
+        "OpenAI-Project": this.project,
+        ...this.headers
       })
@@ -783,0 +787,0 @@ };

dist/index.d.ts

@@ -95,38 +95,2 @@ import { LanguageModelV1 } from '@ai-sdk/provider';
 
-/**
- * @deprecated Use `createOpenAI` instead.
- */
-declare class OpenAI {
-    /**
-     * Base URL for the OpenAI API calls.
-     */
-    readonly baseURL: string;
-    readonly apiKey?: string;
-    readonly organization?: string;
-    /**
-     * Creates a new OpenAI provider instance.
-     */
-    constructor(options?: {
-        /**
-         * Base URL for the OpenAI API calls.
-         */
-        baseURL?: string;
-        /**
-         * @deprecated Use `baseURL` instead.
-         */
-        baseUrl?: string;
-        /**
-         * API key for authenticating requests.
-         */
-        apiKey?: string;
-        /**
-         * Organization ID.
-         */
-        organization?: string;
-    });
-    private get baseConfig();
-    chat(modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): OpenAIChatLanguageModel;
-    completion(modelId: OpenAICompletionModelId, settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
-}
-
 interface OpenAIProvider {
@@ -138,24 +102,33 @@ (modelId: 'gpt-3.5-turbo-instruct', settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
 }
-/**
- * Create an OpenAI provider.
- */
-declare function createOpenAI(options?: {
+interface OpenAIProviderSettings {
     /**
-     * Base URL for the OpenAI API calls.
-     */
+  Base URL for the OpenAI API calls.
+       */
     baseURL?: string;
     /**
-     * @deprecated Use `baseURL` instead.
-     */
+  @deprecated Use `baseURL` instead.
+       */
     baseUrl?: string;
     /**
-     * API key for authenticating requests.
-     */
+  API key for authenticating requests.
+       */
     apiKey?: string;
     /**
-     * Organization ID.
-     */
+  OpenAI Organization.
+       */
     organization?: string;
-}): OpenAIProvider;
+    /**
+  OpenAI project.
+       */
+    project?: string;
+    /**
+  Custom headers to include in the requests.
+       */
+    headers?: Record<string, string>;
+}
 /**
+Create an OpenAI provider instance.
+ */
+declare function createOpenAI(options?: OpenAIProviderSettings): OpenAIProvider;
+/**
  * Default OpenAI provider instance.
@@ -165,2 +138,32 @@ */
 
-export { OpenAI, type OpenAIProvider, createOpenAI, openai };
+/**
+@deprecated Use `createOpenAI` instead.
+ */
+declare class OpenAI {
+    /**
+  Base URL for the OpenAI API calls.
+     */
+    readonly baseURL: string;
+    readonly apiKey?: string;
+    /**
+  OpenAI Organization.
+     */
+    readonly organization?: string;
+    /**
+  OpenAI project.
+     */
+    readonly project?: string;
+    /**
+  Custom headers to include in the requests.
+     */
+    readonly headers?: Record<string, string>;
+    /**
+     * Creates a new OpenAI provider instance.
+     */
+    constructor(options?: OpenAIProviderSettings);
+    private get baseConfig();
+    chat(modelId: OpenAIChatModelId, settings?: OpenAIChatSettings): OpenAIChatLanguageModel;
+    completion(modelId: OpenAICompletionModelId, settings?: OpenAICompletionSettings): OpenAICompletionLanguageModel;
+}
+
+export { OpenAI, type OpenAIProvider, type OpenAIProviderSettings, createOpenAI, openai };

dist/index.js

@@ -768,2 +768,4 @@ "use strict";
     this.organization = options.organization;
+    this.project = options.project;
+    this.headers = options.headers;
   }
@@ -780,3 +782,5 @@ get baseConfig() {
         })}`,
-        "OpenAI-Organization": this.organization
+        "OpenAI-Organization": this.organization,
+        "OpenAI-Project": this.project,
+        ...this.headers
       })
@@ -783,0 +787,0 @@ };

package.json

 {
   "name": "@ai-sdk/openai",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "license": "Apache-2.0",
@@ -5,0 +5,0 @@ "sideEffects": false,

README.md

@@ -19,9 +19,22 @@ # Vercel AI SDK - OpenAI Provider
 ```ts
-import { createOpenAI } from '@ai-sdk/openai'
+import { createOpenAI } from '@ai-sdk/openai';
 
 const openai = createOpenAI({
-  baseURL: '', // optional base URL for proxies etc.
-  apiKey: '' // optional API key, default to env property OPENAI_API_KEY
-  organization: '' // optional organization
-})
+  // optional base URL for proxies etc.
+  baseURL: '',
+
+  // optional API key, default to env property OPENAI_API_KEY
+  apiKey: '',
+
+  // optional OpenAI organization:
+  organization: '',
+
+  // optional OpenAI project:
+  project: '',
+
+  // optional custom headers:
+  headers: {
+    'custom-header': 'value',
+  },
+});
 ```
@@ -28,0 +41,0 @@

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

Total package byte prevSize

188161

increased by0.73%

Lines of code

2586

increased by0.58%

Number of lines in readme file

106

increased by13.98%

No dependency changes