From 1121d377f14b75b5293f36f83a3fc4adb83a719d Mon Sep 17 00:00:00 2001 From: Arshan Dabirsiaghi Date: Thu, 23 May 2024 12:47:18 -0400 Subject: [PATCH] feedback --- cli.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/cli.md b/cli.md index a047ebf..2de1af5 100644 --- a/cli.md +++ b/cli.md @@ -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= ``` @@ -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= @@ -102,6 +102,7 @@ CODEMODDER_AZURE_OPENAI_GPT-4-TURBO-2024-04-12_API_DEPLOYMENT= - 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