From 464f45fd0a6ce6063c13c3a2b8b5669ed93348c8 Mon Sep 17 00:00:00 2001 From: Dan D'Avella Date: Thu, 23 May 2024 13:47:38 -0400 Subject: [PATCH] Add Azure OpenAI API version environment variable --- cli.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/cli.md b/cli.md index 2de1af5..6f02d0e 100644 --- a/cli.md +++ b/cli.md @@ -96,11 +96,13 @@ Codemods request access to OpenAI models by name, and by default are given acces ```bash CODEMODDER_AZURE_OPENAI_API_KEY= CODEMODDER_AZURE_OPENAI_ENDPOINT= +CODEMODDER_AZURE_OPENAI_API_VERSION= CODEMODDER_AZURE_OPENAI_GPT-3_5-TURBO-2024-12-12_DEPLOYMENT= 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. +- The `CODEMODDER_AZURE_API_VERSION` is optional and codemodders can choose a reasonable default as a fallback. This spec does not intend to be prescriptive about particular fallback versions. - 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.