From fa47aed70bab536a405964b7e806a076df71a801 Mon Sep 17 00:00:00 2001 From: Jeremy Lewi Date: Tue, 9 Apr 2024 12:48:21 -0700 Subject: [PATCH] Add support for AzureAI (#38) * Update the config command to set OpenAI deployments. * Add documentation for using Azure OpenAI. --- app/cmd/config.go | 29 +++++-- app/pkg/agent/agent.go | 2 +- app/pkg/config/azure.go | 19 +++++ app/pkg/config/config.go | 27 ++++++ app/pkg/oai/client.go | 120 ++++++++++++++++++++++++--- app/pkg/oai/client_test.go | 45 ++++++++++ docs/content/en/docs/azure/_index.md | 112 +++++++++++++++++++++++++ 7 files changed, 334 insertions(+), 20 deletions(-) create mode 100644 app/pkg/config/azure.go create mode 100644 app/pkg/oai/client_test.go create mode 100644 docs/content/en/docs/azure/_index.md diff --git a/app/cmd/config.go b/app/cmd/config.go index 188e34f3..11e29847 100644 --- a/app/cmd/config.go +++ b/app/cmd/config.go @@ -36,13 +36,30 @@ func NewSetConfigCmd() *cobra.Command { } pieces := strings.Split(args[0], "=") - if len(pieces) < 2 { - return errors.New("Invalid usage; set expects an argument in the form =") - } cfgName := pieces[0] - cfgValue := pieces[1] - viper.Set(cfgName, cfgValue) - fConfig := config.GetConfig() + + var fConfig *config.Config + switch cfgName { + case "azureOpenAI.deployments": + if len(pieces) != 3 { + return errors.New("Invalid argument; argument is not in the form azureOpenAI.deployments==") + } + + d := config.AzureDeployment{ + Model: pieces[1], + Deployment: pieces[2], + } + + fConfig = config.GetConfig() + config.SetAzureDeployment(fConfig, d) + default: + if len(pieces) < 2 { + return errors.New("Invalid usage; set expects an argument in the form =") + } + cfgValue := pieces[1] + viper.Set(cfgName, cfgValue) + fConfig = config.GetConfig() + } file := viper.ConfigFileUsed() if file == "" { diff --git a/app/pkg/agent/agent.go b/app/pkg/agent/agent.go index f70c0323..1f923577 100644 --- a/app/pkg/agent/agent.go +++ b/app/pkg/agent/agent.go @@ -76,7 +76,7 @@ func (a *Agent) completeWithRetries(ctx context.Context, req *v1alpha1.GenerateR }, } request := openai.ChatCompletionRequest{ - Model: openai.GPT3Dot5Turbo0125, + Model: oai.DefaultModel, Messages: messages, MaxTokens: 2000, Temperature: temperature, diff --git a/app/pkg/config/azure.go b/app/pkg/config/azure.go new file mode 100644 index 00000000..cf488e7e --- /dev/null +++ b/app/pkg/config/azure.go @@ -0,0 +1,19 @@ +package config + +func SetAzureDeployment(cfg *Config, d AzureDeployment) { + if cfg.AzureOpenAI == nil { + cfg.AzureOpenAI = &AzureOpenAIConfig{} + } + if cfg.AzureOpenAI.Deployments == nil { + cfg.AzureOpenAI.Deployments = make([]AzureDeployment, 0, 1) + } + // First check if there is a deployment for the model and if there is update it + for i := range cfg.AzureOpenAI.Deployments { + if cfg.AzureOpenAI.Deployments[i].Model == d.Model { + cfg.AzureOpenAI.Deployments[i].Deployment = d.Deployment + return + } + } + + cfg.AzureOpenAI.Deployments = append(cfg.AzureOpenAI.Deployments, d) +} diff --git a/app/pkg/config/config.go b/app/pkg/config/config.go index 2540b9fb..6a3115ed 100644 --- a/app/pkg/config/config.go +++ b/app/pkg/config/config.go @@ -42,6 +42,8 @@ type Config struct { Server ServerConfig `json:"server" yaml:"server"` Assets AssetConfig `json:"assets" yaml:"assets"` OpenAI OpenAIConfig `json:"openai" yaml:"openai"` + // AzureOpenAI contains configuration for Azure OpenAI. A non nil value means use Azure OpenAI. + AzureOpenAI *AzureOpenAIConfig `json:"azureOpenAI,omitempty" yaml:"azureOpenAI,omitempty"` } // ServerConfig configures the server @@ -71,6 +73,31 @@ type OpenAIConfig struct { APIKeyFile string `json:"apiKeyFile" yaml:"apiKeyFile"` } +type AzureOpenAIConfig struct { + // APIKeyFile is the path to the file containing the API key + APIKeyFile string `json:"apiKeyFile" yaml:"apiKeyFile"` + + // BaseURL is the baseURL for the API. + // This can be obtained using the Azure CLI with the command: + // az cognitiveservices account show \ + // --name \ + // --resource-group \ + // | jq -r .properties.endpoint + BaseURL string `json:"baseURL" yaml:"baseURL"` + + // Deployments is a list of Azure deployments of various models. + Deployments []AzureDeployment `json:"deployments" yaml:"deployments"` +} + +type AzureDeployment struct { + // Deployment is the Azure Deployment name + Deployment string `json:"deployment" yaml:"deployment"` + + // Model is the OpenAI name for this model + // This is used to map OpenAI models to Azure deployments + Model string `json:"model" yaml:"model"` +} + type CorsConfig struct { // AllowedOrigins is a list of origins allowed to make cross-origin requests. AllowedOrigins []string `json:"allowedOrigins" yaml:"allowedOrigins"` diff --git a/app/pkg/oai/client.go b/app/pkg/oai/client.go index c4b5592e..81adbd12 100644 --- a/app/pkg/oai/client.go +++ b/app/pkg/oai/client.go @@ -1,8 +1,12 @@ package oai import ( + "net/url" "strings" + "github.com/go-logr/zapr" + "go.uber.org/zap" + "github.com/hashicorp/go-retryablehttp" "github.com/jlewi/foyle/app/pkg/config" "github.com/jlewi/hydros/pkg/files" @@ -10,18 +14,18 @@ import ( "github.com/sashabaranov/go-openai" ) +const ( + DefaultModel = openai.GPT3Dot5Turbo0125 + + // AzureOpenAIVersion is the version of the Azure OpenAI API to use. + // For a list of versions see: + // https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#chat-completions + AzureOpenAIVersion = "2024-02-01" +) + // NewClient helper function to create a new OpenAI client from a config func NewClient(cfg config.Config) (*openai.Client, error) { - if cfg.OpenAI.APIKeyFile == "" { - return nil, errors.New("OpenAI APIKeyFile is required") - } - apiKeyBytes, err := files.Read(cfg.OpenAI.APIKeyFile) - if err != nil { - return nil, errors.Wrapf(err, "could not read OpenAI APIKeyFile: %v", cfg.OpenAI.APIKeyFile) - } - // make sure there is no leading or trailing whitespace - apiKey := strings.TrimSpace(string(apiKeyBytes)) - + log := zapr.NewLogger(zap.L()) // ************************************************************************ // Setup middleware // ************************************************************************ @@ -32,9 +36,99 @@ func NewClient(cfg config.Config) (*openai.Client, error) { retryClient := retryablehttp.NewClient() httpClient := retryClient.StandardClient() - clientCfg := openai.DefaultConfig(apiKey) - clientCfg.HTTPClient = httpClient - client := openai.NewClientWithConfig(clientCfg) + var clientConfig openai.ClientConfig + if cfg.AzureOpenAI != nil { + var clientErr error + clientConfig, clientErr = buildAzureConfig(cfg) + + if clientErr != nil { + return nil, clientErr + } + } else { + log.Info("Configuring OpenAI client") + apiKey, err := readAPIKey(cfg.OpenAI.APIKeyFile) + if err != nil { + return nil, err + } + clientConfig = openai.DefaultConfig(apiKey) + } + clientConfig.HTTPClient = httpClient + client := openai.NewClientWithConfig(clientConfig) return client, nil } + +// buildAzureConfig helper function to create a new Azure OpenAI client config +func buildAzureConfig(cfg config.Config) (openai.ClientConfig, error) { + apiKey, err := readAPIKey(cfg.AzureOpenAI.APIKeyFile) + if err != nil { + return openai.ClientConfig{}, err + } + u, err := url.Parse(cfg.AzureOpenAI.BaseURL) + if err != nil { + return openai.ClientConfig{}, errors.Wrapf(err, "could not parse Azure OpenAI BaseURL: %v", cfg.AzureOpenAI.BaseURL) + } + + if u.Scheme != "https" { + return openai.ClientConfig{}, errors.Errorf("Azure BaseURL %s is not valid; it must use the scheme https", cfg.AzureOpenAI.BaseURL) + } + + // Check that all required models are deployed + required := map[string]bool{ + DefaultModel: true, + } + + for _, d := range cfg.AzureOpenAI.Deployments { + delete(required, d.Model) + } + + if len(required) > 0 { + models := make([]string, 0, len(required)) + for m := range required { + models = append(models, m) + } + return openai.ClientConfig{}, errors.Errorf("Missing Azure deployments for for OpenAI models %v; update AzureOpenAIConfig.deployments in your configuration to specify deployments for these models ", strings.Join(models, ", ")) + } + log := zapr.NewLogger(zap.L()) + log.Info("Configuring Azure OpenAI", "baseURL", cfg.AzureOpenAI.BaseURL, "deployments", cfg.AzureOpenAI.Deployments) + clientConfig := openai.DefaultAzureConfig(apiKey, cfg.AzureOpenAI.BaseURL) + clientConfig.APIVersion = AzureOpenAIVersion + mapper := AzureModelMapper{ + modelToDeployment: make(map[string]string), + } + for _, m := range cfg.AzureOpenAI.Deployments { + mapper.modelToDeployment[m.Model] = m.Deployment + } + clientConfig.AzureModelMapperFunc = mapper.Map + + return clientConfig, nil +} + +// AzureModelMapper maps OpenAI models to Azure deployments +type AzureModelMapper struct { + modelToDeployment map[string]string +} + +// Map maps an OpenAI model to an Azure deployment +func (m AzureModelMapper) Map(model string) string { + log := zapr.NewLogger(zap.L()) + deployment, ok := m.modelToDeployment[model] + if !ok { + log.Error(errors.Errorf("No AzureAI deployment found for model %v", model), "missing deployment", "model", model) + return "missing-deployment" + } + return deployment +} + +func readAPIKey(apiKeyFile string) (string, error) { + if apiKeyFile == "" { + return "", errors.New("APIKeyFile is required") + } + apiKeyBytes, err := files.Read(apiKeyFile) + if err != nil { + return "", errors.Wrapf(err, "could not read APIKeyFile: %v", apiKeyFile) + } + // make sure there is no leading or trailing whitespace + apiKey := strings.TrimSpace(string(apiKeyBytes)) + return apiKey, nil +} diff --git a/app/pkg/oai/client_test.go b/app/pkg/oai/client_test.go new file mode 100644 index 00000000..0834f7d5 --- /dev/null +++ b/app/pkg/oai/client_test.go @@ -0,0 +1,45 @@ +package oai + +import ( + "os" + "testing" + + "github.com/jlewi/foyle/app/pkg/config" +) + +func Test_BuildAzureAIConfig(t *testing.T) { + f, err := os.CreateTemp("", "key.txt") + if err != nil { + t.Fatalf("Error creating temp file: %v", err) + } + if _, err := f.WriteString("somekey"); err != nil { + t.Fatalf("Error writing to temp file: %v", err) + } + + cfg := &config.Config{ + AzureOpenAI: &config.AzureOpenAIConfig{ + APIKeyFile: f.Name(), + BaseURL: "https://someurl.com", + Deployments: []config.AzureDeployment{ + { + Model: DefaultModel, + Deployment: "somedeployment", + }, + }, + }, + } + + if err := f.Close(); err != nil { + t.Fatalf("Error closing temp file: %v", err) + } + defer os.Remove(f.Name()) + + clientConfig, err := buildAzureConfig(*cfg) + if err != nil { + t.Fatalf("Error building Azure config: %v", err) + } + + if clientConfig.BaseURL != "https://someurl.com" { + t.Fatalf("Expected BaseURL to be https://someurl.com but got %v", clientConfig.BaseURL) + } +} diff --git a/docs/content/en/docs/azure/_index.md b/docs/content/en/docs/azure/_index.md new file mode 100644 index 00000000..009675b4 --- /dev/null +++ b/docs/content/en/docs/azure/_index.md @@ -0,0 +1,112 @@ +--- +title: "Azure OpenAI" +description: "Using Azure OpenAI with Foyle" +weight: 3 +--- + +## What You'll Learn + +How to configure Foyle to use Azure OpenAI + +## Prerequisites + +1. You need an Azure Account (Subscription) +1. You need access to [Azure Open AI](https://learn.microsoft.com/en-us/azure/ai-services/openai/overview#how-do-i-get-access-to-azure-openai) + + +## Setup Azure OpenAI + +You need the following Azure OpenAI resources: + +* [Azure Resource Group](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal) - This will be an Azure resource group that contains your Azure OpenAI resources + +* [Azure OpenAI Resource Group](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal) - This will contain your Azure OpenAI model deployments + + * You can use the Azure CLI to check if you have the required resources + + ``` + az cognitiveservices account list --output=table + Kind Location Name ResourceGroup + ------ ---------- -------------- ---------------- + OpenAI eastus ResourceName ResourceGroup + ``` + + * **Note** You can use the [pricing page](https://azure.microsoft.com/en-us/pricing/details/cognitive-services/openai-service/) to see which models are available + in a given region. Not all models are available an all regions so you need to select a region with the models you want to use with Foyle. + * Foyle currently uses [gpt-3.5-turbo-0125](https://platform.openai.com/docs/models/gpt-3-5-turbo) + +* A GPT3.5 deployment + * Use the CLI to list your current deployments + + ``` + az cognitiveservices account deployment list -g ${RESOURCEGROUP} -n ${RESOURCENAME} --output=table + ``` + + * If you need to create a deployment follow the [instructions](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=web-portal#deploy-a-model) + +## Setup Foyle To Use Azure Open AI + +### Set the Azure Open AI BaseURL + +We need to configure Foyle to use the appropriate Azure OpenAI endpoint. You can use the [CLI](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/create-resource?pivots=cli#get-the-endpoint-url) to determine +the endpoint associated with your resource group + +``` +az cognitiveservices account show \ +--name \ +--resource-group \ +| jq -r .properties.endpoint +``` + +Update the baseURL in your Foyle configuration + +``` +foyle config set azureOpenAI.baseURL=https://endpoint-for-Azure-OpenAI +``` + +### Set the Azure Open AI API Key + +Use the CLI to obtain the API key for your Azure OpenAI resource and save it to a file + +``` +az cognitiveservices account keys list \ +--name \ +--resource-group \ +| jq -r .key1 > ${HOME}/secrets/azureopenai.key +``` + +Next, configure Foyle to use this API key + +``` +foyle config set azureOpenAI.apiKeyFile=/path/to/your/key/file +``` + +### Specify model deployments + +You need to configure Foyle to use the appropriate Azure deployments for the models Foyle uses. + +Start by using the Azure CLI to list your deployments + + ``` + az cognitiveservices account deployment list --name=${RESOURCE_NAME} --resource-group=${RESOURCE_GROUP} --output=table + ``` + +Configure Foyle to use the appropriate deployments + +``` +foyle config set azureOpenAI.deployments=gpt-3.5-turbo-0125= +``` + +### Troubleshooting: + +#### Rate Limits + +If Foyle is returning rate limiting errors from Azure OpenAI, use the CLI to check +the rate limits for your deployments + +``` +az cognitiveservices account deployment list -g ${RESOURCEGROUP} -n ${RESOURCENAME} +``` + +Azure OpenAI sets the default values to be quite low; 1K tokens per minute. This is usually much +lower than your allotted quota. If you have available quota, you can use the UI or to increase these limits.