Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fetch, ESM & streamCompletion util #45

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
/node_modules

# build artifacts
dist
4 changes: 4 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ base.ts
common.ts
configuration.ts
index.ts
stream.ts
tsc-multi.json
tsconfig.esm.json
tsconfig.json
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,21 @@ try {

Streaming completions (`stream=true`) are not natively supported in this package yet, but [a workaround exists](https://github.com/openai/openai-node/issues/18#issuecomment-1369996933) if needed.

### Fetch support

Usage with Vercel Edge Functions or Cloudflare Workers where fetch is required could be supported with proper axios adapter :

```javascript
import fetchAdapter from "@haverstack/axios-fetch-adapter";

const configuration = new Configuration({
apiKey: process.env.OPENAI_API_KEY,
baseOptions: {
adapter: fetchAdapter
}
});
```

## Upgrade guide

All breaking changes for major version releases are listed below.
Expand Down
10 changes: 5 additions & 5 deletions api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2149,7 +2149,7 @@ export const OpenAIApiAxiosParamCreator = function (configuration?: Configuratio

setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...localVarFormParams.getHeaders(), ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...(localVarFormParams as any).getHeaders?.(), ...options.headers};
localVarRequestOptions.data = localVarFormParams;

return {
Expand Down Expand Up @@ -2294,7 +2294,7 @@ export const OpenAIApiAxiosParamCreator = function (configuration?: Configuratio

setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...localVarFormParams.getHeaders(), ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...(localVarFormParams as any).getHeaders?.(), ...options.headers};
localVarRequestOptions.data = localVarFormParams;

return {
Expand Down Expand Up @@ -2355,7 +2355,7 @@ export const OpenAIApiAxiosParamCreator = function (configuration?: Configuratio

setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...localVarFormParams.getHeaders(), ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...(localVarFormParams as any).getHeaders?.(), ...options.headers};
localVarRequestOptions.data = localVarFormParams;

return {
Expand Down Expand Up @@ -2500,7 +2500,7 @@ export const OpenAIApiAxiosParamCreator = function (configuration?: Configuratio

setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...localVarFormParams.getHeaders(), ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...(localVarFormParams as any).getHeaders?.(), ...options.headers};
localVarRequestOptions.data = localVarFormParams;

return {
Expand Down Expand Up @@ -2563,7 +2563,7 @@ export const OpenAIApiAxiosParamCreator = function (configuration?: Configuratio

setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...localVarFormParams.getHeaders(), ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...(localVarFormParams as any).getHeaders?.(), ...options.headers};
localVarRequestOptions.data = localVarFormParams;

return {
Expand Down
7 changes: 4 additions & 3 deletions configuration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
*/


const packageJson = require("../package.json");
import FormData from "form-data";
import { LIB_VERSION } from "./version";

export interface ConfigurationParameters {
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
Expand Down Expand Up @@ -98,15 +99,15 @@ export class Configuration {
this.baseOptions = {};
}
this.baseOptions.headers = {
'User-Agent': `OpenAI/NodeJS/${packageJson.version}`,
'User-Agent': `OpenAI/NodeJS/${LIB_VERSION}`,
'Authorization': `Bearer ${this.apiKey}`,
...this.baseOptions.headers,
}
if (this.organization) {
this.baseOptions.headers['OpenAI-Organization'] = this.organization;
}
if (!this.formDataCtor) {
this.formDataCtor = require("form-data");
this.formDataCtor = FormData;
}
}

Expand Down
Loading