Enhance OpenAI to be Azure OpenAi compatible (#3918)

Signed-off-by: fabistb <[email protected]>
Co-authored-by: Yaron Schneider <[email protected]>

Author: fabistb

conversation/openai/metadata.go

@@ -0,0 +1,25 @@
+/*
+Copyright 2025 The Dapr Authors
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package openai
+
+import "github.com/dapr/components-contrib/conversation"
+
+// OpenAILangchainMetadata extends LangchainMetadata with OpenAI-specific properties.
+type OpenAILangchainMetadata struct {
+	conversation.LangchainMetadata `json:",inline" mapstructure:",squash"`
+	APIType                        string `json:"apiType" mapstructure:"apiType"`
+	APIVersion                     string `json:"apiVersion" mapstructure:"apiVersion"`
+}

conversation/openai/metadata.yaml

@@ -40,3 +40,17 @@ metadata:
       A time-to-live value for a prompt cache to expire. Uses Golang durations
     type: string
     example: '10m'
+  - name: apiVersion
+    required: false
+    description: |
+      The API version to use for the Azure OpenAI service. This is required when using Azure OpenAI.
+    type: string
+    example: '2025-01-01-preview'
+    default: ''
+  - name: apiType
+    required: false
+    description: |
+      The type of API to use for the OpenAI service. This is required when using Azure OpenAI.
+    type: string
+    example: 'azure'
+    default: ''

conversation/openai/metadata_test.go

@@ -0,0 +1,67 @@
+/*
+Copyright 2025 The Dapr Authors
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+    http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package openai
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/dapr/components-contrib/conversation"
+)
+
+func TestOpenaiLangchainMetadata(t *testing.T) {
+	t.Run("json marshaling with endpoint", func(t *testing.T) {
+		metadata := OpenAILangchainMetadata{
+			LangchainMetadata: conversation.LangchainMetadata{
+				Key:      "test-key",
+				Model:    "gpt-4",
+				CacheTTL: "10m",
+				Endpoint: "https://custom-endpoint.openai.azure.com/",
+			},
+			APIType:    "azure",
+			APIVersion: "2025-01-01-preview",
+		}
+
+		bytes, err := json.Marshal(metadata)
+		require.NoError(t, err)
+
+		var unmarshaled OpenAILangchainMetadata
+		err = json.Unmarshal(bytes, &unmarshaled)
+		require.NoError(t, err)
+
+		assert.Equal(t, metadata.Key, unmarshaled.Key)
+		assert.Equal(t, metadata.Model, unmarshaled.Model)
+		assert.Equal(t, metadata.CacheTTL, unmarshaled.CacheTTL)
+		assert.Equal(t, metadata.Endpoint, unmarshaled.Endpoint)
+		assert.Equal(t, metadata.APIType, unmarshaled.APIType)
+		assert.Equal(t, metadata.APIVersion, unmarshaled.APIVersion)
+	})
+
+	t.Run("json unmarshaling with endpoint", func(t *testing.T) {
+		jsonStr := `{"key": "test-key", "model": "gpt-4", "endpoint": "https://custom-endpoint.openai.azure.com/", "apiType": "azure", "apiVersion": "2025-01-01-preview"}`
+
+		var metadata OpenAILangchainMetadata
+		err := json.Unmarshal([]byte(jsonStr), &metadata)
+		require.NoError(t, err)
+
+		assert.Equal(t, "test-key", metadata.Key)
+		assert.Equal(t, "gpt-4", metadata.Model)
+		assert.Equal(t, "https://custom-endpoint.openai.azure.com/", metadata.Endpoint)
+		assert.Equal(t, "azure", metadata.APIType)
+		assert.Equal(t, "2025-01-01-preview", metadata.APIVersion)
+	})
+}

conversation/openai/openai.go

@@ -16,6 +16,7 @@ package openai
 
 import (
 	"context"
+	"errors"
 	"reflect"
 
 	"github.com/dapr/components-contrib/conversation"
@@ -44,7 +45,7 @@ func NewOpenAI(logger logger.Logger) conversation.Conversation {
 const defaultModel = "gpt-4o"
 
 func (o *OpenAI) Init(ctx context.Context, meta conversation.Metadata) error {
-	md := conversation.LangchainMetadata{}
+	md := OpenAILangchainMetadata{}
 	err := kmeta.DecodeMetadata(meta.Properties, &md)
 	if err != nil {
 		return err
@@ -65,6 +66,14 @@ func (o *OpenAI) Init(ctx context.Context, meta conversation.Metadata) error {
 		options = append(options, openai.WithBaseURL(md.Endpoint))
 	}
 
+	if md.APIType == "azure" {
+		if md.Endpoint == "" || md.APIVersion == "" {
+			return errors.New("endpoint and apiVersion must be provided when apiType is set to 'azure'")
+		}
+
+		options = append(options, openai.WithAPIType(openai.APITypeAzure), openai.WithAPIVersion(md.APIVersion))
+	}
+
 	llm, err := openai.New(options...)
 	if err != nil {
 		return err
@@ -84,7 +93,7 @@ func (o *OpenAI) Init(ctx context.Context, meta conversation.Metadata) error {
 }
 
 func (o *OpenAI) GetComponentMetadata() (metadataInfo metadata.MetadataMap) {
-	metadataStruct := conversation.LangchainMetadata{}
+	metadataStruct := OpenAILangchainMetadata{}
 	metadata.GetMetadataInfoFromStructType(reflect.TypeOf(metadataStruct), &metadataInfo, metadata.ConversationType)
 	return
 }

conversation/openai/openai_test.go

@@ -55,8 +55,47 @@ func TestInit(t *testing.T) {
 				// we're mainly testing that initialization succeeds
 			},
 		},
+		{
+			name: "with apiType azure and missing apiVersion",
+			metadata: map[string]string{
+				"key":      "test-key",
+				"model":    "gpt-4",
+				"apiType":  "azure",
+				"endpoint": "https://custom-endpoint.openai.azure.com/",
+			},
+			testFn: func(t *testing.T, o *OpenAI, err error) {
+				require.Error(t, err)
+				assert.EqualError(t, err, "endpoint and apiVersion must be provided when apiType is set to 'azure'")
+			},
+		},
+		{
+			name: "with apiType azure and custom apiVersion",
+			metadata: map[string]string{
+				"key":        "test-key",
+				"model":      "gpt-4",
+				"apiType":    "azure",
+				"endpoint":   "https://custom-endpoint.openai.azure.com/",
+				"apiVersion": "2025-01-01-preview",
+			},
+			testFn: func(t *testing.T, o *OpenAI, err error) {
+				require.NoError(t, err)
+				assert.NotNil(t, o.LLM)
+			},
+		},
+		{
+			name: "with apiType azure but missing endpoint",
+			metadata: map[string]string{
+				"key":        "test-key",
+				"model":      "gpt-4",
+				"apiType":    "azure",
+				"apiVersion": "2025-01-01-preview",
+			},
+			testFn: func(t *testing.T, o *OpenAI, err error) {
+				require.Error(t, err)
+				assert.EqualError(t, err, "endpoint and apiVersion must be provided when apiType is set to 'azure'")
+			},
+		},
 	}
-
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
 			o := NewOpenAI(logger.NewLogger("openai test"))

tests/config/conversation/README.md

@@ -5,7 +5,7 @@ This directory contains conformance tests for all conversation components, inclu
 ## Available Components
 
 - **echo** - Simple echo component for testing (no configuration needed)
-- **openai** - OpenAI GPT models
+- **openai** - OpenAI GPT models (also supports Azure OpenAI)
 - **anthropic** - Anthropic Claude models  
 - **googleai** - Google Gemini models
 - **mistral** - Mistral AI models
@@ -52,6 +52,14 @@ export OPENAI_API_KEY="your_openai_api_key"
 ```
 Get your API key from: https://platform.openai.com/api-keys
 
+### Azure OpenAI
+```bash
+export AZURE_OPENAI_API_KEY="your_openai_api_key"
+export AZURE_OPENAI_ENDPOINT="your_azureopenai_endpoint_here"
+export AZURE_OPENAI_API_VERSION="your_azreopenai_api_version_here"
+```
+Get your configuration values from: https://ai.azure.com/
+
 ### Anthropic
 ```bash
 export ANTHROPIC_API_KEY="your_anthropic_api_key"
@@ -142,4 +150,5 @@ This approach provides better reliability and compatibility while maintaining ac
 - Cost-effective models are used by default to minimize API costs
 - HuggingFace uses the OpenAI compatibility layer as a workaround due to langchaingo API issues
 - Ollama requires a local server and must be explicitly enabled
+- OpenAI component is tested for OpenAI and Azure
 - All tests include proper initialization and basic conversation functionality testing 

tests/config/conversation/env.template

@@ -4,6 +4,11 @@
 # OpenAI API Key - Get from https://platform.openai.com/api-keys
 OPENAI_API_KEY=your_openai_api_key_here
 
+# Azure OpenAI - Get from https://ai.azure.com/
+AZURE_OPENAI_API_KEY=your_azureopenai_api_key_here
+AZURE_OPENAI_ENDPOINT=your_azureopenai_endpoint_here
+AZURE_OPENAI_API_VERSION=your_azreopenai_api_version_here
+
 # Anthropic API Key - Get from https://console.anthropic.com/
 ANTHROPIC_API_KEY=your_anthropic_api_key_here
 

tests/config/conversation/openai/azure/openai.yml

@@ -0,0 +1,18 @@
+apiVersion: dapr.io/v1alpha1
+kind: Component
+metadata:
+  name: openai
+spec:
+  type: conversation.openai
+  version: v1
+  metadata:
+    - name: key
+      value: "${{AZURE_OPENAI_API_KEY}}"
+    - name: model
+      value: "gpt-4o-mini" 
+    - name: endpoint
+      value: "${{AZURE_OPENAI_ENDPOINT}}"
+    - name: apiType
+      value: "azure"
+    - name: apiVersion
+      value: "${{AZURE_OPENAI_API_VERSION}}"

tests/config/conversation/openai/openai.yml renamed to tests/config/conversation/openai/openai/openai.yml

@@ -21,6 +21,9 @@ echo "  ./test_conformance.sh"
 echo ""
 echo "Option 2: Set environment variables directly:"
 echo "  export OPENAI_API_KEY=\"your_openai_api_key\""
+echo "  export AZURE_OPENAI_API_KEY=\"your_azureopenai_api_key\""
+echo "  export AZURE_OPENAI_ENDPOINT=\"your_azureopenai_endpoint\""
+echo "  export AZURE_OPENAI_API_VERSION=\"your_azureopenai_api_version\""
 echo "  export ANTHROPIC_API_KEY=\"your_anthropic_api_key\""
 echo "  export GOOGLE_AI_API_KEY=\"your_google_ai_api_key\""
 echo "  export MISTRAL_API_KEY=\"your_mistral_api_key\""