30:Tbc5,# OpenAI Wrapper This notebook wraps the [OpenAI Node.js npm library](https://github.com/openai/openai-node). You can also copy/paste the code from it in order to use that library directly. See the [@osteele/openai-wrapper-example](https://observablehq.com/@osteele/openai-wrapper-example) notebook for examples.

**Note**: As an alternative, see the [@osteele/openai-api](https://observablehq.com/@osteele/openai-api) notebook. The functions in that notebook don't return as much information, but they are pre-configured with defaults that (in the author's opinion) make it slightly easier to use.

## Usage In order to run these examples, you need an OpenAI API Key. If you have an OpenAI account, you can get an API key from [this page](https://platform.openai.com/account/api-keys), where it is also called a "secret key". There are two ways to supply the API key to this notebook: ### Method 1. Inject the API in the import statement As an alternative to passing the API Key as a parameter to each function call, you specify it in the import statement. For example: ```js OPENAI_API_KEY = "sk-XXXXXXXX" ``` where `sk-XXXXXXXX` is your OpenAI API Key. ```js import { completions } with { OPENAI_API_KEY as API_KEY } from "@osteele/openai-api" ``` ```js completions("List ten ways of using ObservableHQ.") ```

**Security warning**: Don't include your API key in a public notebook. If you do, anyone can extract your key and use it. If you have a free account, this will blow through your OpenAPI quota. If you have a paid account, it will cost you money. In either case, if someone uses your key in ways that violate OpenAI's service terms, you might also lose access to OpenAI.

Observable Pro users: Instead of including the API key in the text of the notebook, you can add it as an [ObservableHQ secret](https://observablehq.com/@observablehq/secrets?collection=@observablehq/getting-data-in-and-out): E.g. instead of writing `OPENAI_API_KEY = "sk-XXXXXXXX"` as above, you can use `OPENAI_API_KEY = Secret("OPENAI_API_KEY")`.

### Method 2. Use `@tmcw/secret` Import `viewof openaiApiKey` from this notebook, and include `viewof openaiApiKey` in a cell: ```js import { completions, viewof openaiApiKey } from "@osteele/openai-api" ``` ```js viewof openaiApiKey ``` The first time that you run the notebook, enter the API key into the provided field, and save it. It will be saved into [window.localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage) with key `OPENAI_API_KEY`. Notebooks from this site that you run in your own browser will have access to this value. Pages from other sites do not. The first time that you save the API key, you may need to reload the page in order for the OpenAI functions to see the key. See the [@osteele/openai-api-example](https://observablehq.com/@osteele/openai-api-example) notebook as an example of this method.31:[] 2e:{"title":"OpenAI Wrapper","cells":[{"id":25,"value":"$30","pinned":false,"hidden":false,"mode":"md"},{"id":69,"value":"## Implementation","pinned":false,"hidden":false,"mode":"md"},{"id":13,"value":"openai_module = import(\"https://cdn.skypack.dev/openai@3.1?min\")","pinned":true,"hidden":false,"mode":"ojs"},{"id":122,"value":"### Key management","pinned":false,"hidden":false,"mode":"md"},{"id":106,"value":"import {secret} from \"@tmcw/secret\"","pinned":true,"hidden":false,"mode":"ojs"},{"id":54,"value":"// The importing notebook should import this notebook with a `with` statement that initializes this values. See the instructions at the top of this notebook.\nAPI_KEY = undefined","pinned":true,"hidden":false,"mode":"ojs"},{"id":110,"value":"viewof openaiApiKey = secret(\"OPENAI_API_KEY\", {\n description:\n \"This is an OpenAI API token whose value is only available to your notebooks.\",\n submit: \"Save OpenAI API key\"\n})","pinned":true,"hidden":false,"mode":"ojs"},{"id":120,"value":"### Constructor wrapper","pinned":false,"hidden":false,"mode":"md"},{"id":83,"value":"Note: the following cell produces an error:\n\n

openai = Error: The @osteele/openai-wrapper module must be imported with a \\`with\\` statement. See that notebook for usage instructions.

\n\nin this notebook. The function that it defines works when imported into another notebook, if the `with {OPENAI_API_KEY as API_KEY}` recipe from the instructions at the top of this notebook are followed.","pinned":false,"hidden":false,"mode":"md"},{"id":23,"value":"openai = {\n const { OpenAIApi, Configuration } = openai_module;\n const apiKey = API_KEY || openaiApiKey;\n if (!apiKey) {\n throw new Error(\n \"The @osteele/openai-wrapper module must be imported with a `with` statement. See that notebook for usage instructions.\"\n );\n }\n const configuration = new Configuration({ apiKey });\n return new OpenAIApi(configuration);\n}","pinned":true,"hidden":false,"mode":"ojs"}],"files":"$W31","stdlib":"1","titling":"auto"}