Official Node.js client library

dschnurr · January 20, 2022, 9:55pm

Hello!

We just released an official Node.js library for the OpenAI API. It’s available to install through npm, and you can find code examples in our API reference.

We hope you find this useful when developing Node.js apps that use our API!

strategicmachines · January 21, 2022, 3:54pm

Thank you! Good to see some additional support in nodejs for openai!

Juts one question - I noted that you used the ‘request’ package for the http client vs a package like axios (or even fetch). Are you aware that ‘request’ has been deprecated, and has not been actively maintained in over 2 years?

dschnurr · January 21, 2022, 5:21pm

Thanks for your reply!

This project is using the axios package, which you can verify here:

github.com

openai/openai-node/blob/4ac4160911fa7b3e0bfbbde3639fd880e5080536/api.ts#L17

      
        
            * The version of the OpenAPI document: 1.0.0
            * 
            *
            * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
            * https://openapi-generator.tech
            * Do not edit the class manually.
            */
            
            

            
import { Configuration } from './configuration';
            import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
            // Some imports not used depending on template conditions
            // @ts-ignore
            import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
            // @ts-ignore
            import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
            
            
/**
            * 
            * @export
            * @interface CreateAnswerRequest

I don’t see a place where we’re using the ‘request’ package, but if you find one please point us to it.

strategicmachines · January 26, 2022, 4:43pm

Good morning - Apologies! I mistakenly traced openai-node from the npm deployment to

GitHub - jtams/openai-node: A library for using the OpenAI GPT-3 API with Node. … which uses Request.

I can see now the right deployment using Axios is sitting at

ediardo · February 7, 2022, 9:52pm

Nice!

I tried it but in my tests, I couldn’t find a way to pass the userId string in my API calls. How can I pass this parameter?

I use the openai-api package by Nikita Jerschow. Happy to migrate to the official library in the future

strategicmachines · February 9, 2022, 7:50pm

What do you mean by ‘userId string’? If you are referring to the api key, you will be able to access it from your process object on a nodejs server, and pass it that way. Here is the example from the docs:

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

dschnurr · February 9, 2022, 8:18pm

Thanks for raising this @ediardo. I assume you’re referring to the “user” parameter mentioned in this Provide a user identifier section.

You’re correct that the “user” parameter is not explicitly supported by the current version of this package – typescript will throw and error if you try to pass it. As a temporary workaround, you can cast the request parameters to any in typescript and continue passing it:

const resp = await openai.createCompletion("text-davinci-001", {
    prompt: "Hello world",
    user: "user-1234",
} as any);

We’ll work on getting user natively supported in the next week or so.

ediardo · February 9, 2022, 8:29pm

Thank you for the prompt reply.

falko · February 15, 2022, 9:30pm

Cool, didn’t know it was this recent. I’m currently using this on my sideprojects it works great

dschnurr · February 16, 2022, 7:07pm

explicit support for the user parameter is added in version 2.0.4