Skip to content

Commit

Permalink
feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
nahsra authored May 23, 2024
1 parent 0ff1f30 commit 1121d37
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The `executable` could involve multiple command line tokens (e.g., `npm run` or

## Configuring OpenAI

You can optionally allow codemods to access OpenAI by adding the following environment variable:
You can optionally allow codemods to access OpenAI by running with the following environment variable during execution:
```bash
CODEMODDER_OPENAI_API_KEY=<KEY>
```
Expand All @@ -91,7 +91,7 @@ In the case of problems communicating with an AI subprocessor, all other codemod

### Using Azure OpenAI

Codemods request access to OpenAI models by name, and by default are given access to types that talk to OpenAI directly. It's possible to override the default behavior to use Azure OpenAI in codemods by specifying the following environment variables:
Codemods request access to OpenAI models by name, and by default are given access to types that talk to OpenAI directly. It's possible to use Azure OpenAI in codemods by specifying the following environment variables:

```bash
CODEMODDER_AZURE_OPENAI_API_KEY=<KEY>
Expand All @@ -102,6 +102,7 @@ CODEMODDER_AZURE_OPENAI_GPT-4-TURBO-2024-04-12_API_DEPLOYMENT=<DEPLOYMENT_NAME>

- Providing `CODEMODDER_AZURE_OPENAI_API_KEY` without `CODEMODDER_AZURE_OPENAI_ENDPOINT` (and vice versa) will cause a failure on startup.
- If using Azure OpenAI and a codemod requests access to a model for which there is no corresponding `CODEMODDER_AZURE_OPENAI_(MODELNAME)_DEPLOYMENT` variable, the deployment name will be assumed to be the name of the model (e.g., "gpt-4o").
- If both Azure and OpenAI instructions are available, Azure will be preferred.

## Console output

Expand Down

0 comments on commit 1121d37

Please sign in to comment.