[azopenai] Prep for release on Monday (#25576)

- Removing example boilerplate that checks for environment variables existence. These examples aren't executable, so it wasn't doing anything except being distracting for people reading the example
- Change over more eligible examples to use the openai/v1 endpoint
- Addressing valid lint warnings.

Author: richardpark-msft

sdk/ai/azopenai/CHANGELOG.md

@@ -1,15 +1,16 @@
 # Release History
 
-## 0.9.0 (2025-11-07)
+## 0.9.0 (2025-11-10)
 
 ### Features Added
 
 - Updating to /v3 of the OpenAI SDK (github.com/openai/openai-go/v3).
 
 ### Other Changes
 
-- Added examples demonstrating support for Managed Identity
+- Added examples demonstrating support for Managed Identity.
 - Added examples demonstrating support for deepseek-r1 reasoning.
+- Migrated examples to using the openai/v1 endpoint.
 
 ## 0.8.0 (2025-06-03)
 

sdk/ai/azopenai/client_audio_test.go

@@ -107,7 +107,11 @@ func TestClient_GetAudioSpeech(t *testing.T) {
 		// when it sends the request.
 		tempFile, err = os.CreateTemp("", "audio*.flac")
 		require.NoError(t, err)
-		defer tempFile.Close()
+
+		t.Cleanup(func() {
+			err := tempFile.Close()
+			require.NoError(t, err)
+		})
 
 		_, err = tempFile.Write(audioBytes)
 		require.NoError(t, err)

sdk/ai/azopenai/client_chat_completions_extensions_test.go

@@ -69,7 +69,10 @@ func TestChatExtensionsStreaming_extensions_bringYourOwnData(t *testing.T) {
 			&azureOpenAI.Cognitive,
 		))
 
-	defer streamer.Close()
+	t.Cleanup(func() {
+		err := streamer.Close()
+		require.NoError(t, err)
+	})
 
 	text := ""
 

sdk/ai/azopenai/client_chat_completions_test.go

@@ -39,7 +39,7 @@ var expectedContent = "1, 2, 3, 4, 5, 6, 7, 8, 9, 10."
 var expectedRole = constant.ValueOf[constant.Assistant]()
 
 func TestClient_GetChatCompletions(t *testing.T) {
-	testFn := func(t *testing.T, client *openai.ChatCompletionService, deployment string, returnedModel string, checkRAI bool) {
+	testFn := func(t *testing.T, client *openai.ChatCompletionService, deployment string, checkRAI bool) {
 		resp, err := client.New(context.Background(), newStainlessTestChatCompletionOptions(deployment))
 		skipNowIfThrottled(t, err)
 		require.NoError(t, err)
@@ -76,12 +76,12 @@ func TestClient_GetChatCompletions(t *testing.T) {
 	t.Run("AzureOpenAI", func(t *testing.T) {
 		client := newStainlessTestClientWithAzureURL(t, azureOpenAI.ChatCompletionsRAI.Endpoint)
 
-		testFn(t, &client.Chat.Completions, azureOpenAI.ChatCompletionsRAI.Model, "gpt-4", true)
+		testFn(t, &client.Chat.Completions, azureOpenAI.ChatCompletionsRAI.Model, true)
 	})
 
 	t.Run("AzureOpenAI.DefaultAzureCredential", func(t *testing.T) {
 		client := newStainlessTestClientWithAzureURL(t, azureOpenAI.ChatCompletionsRAI.Endpoint)
-		testFn(t, &client.Chat.Completions, azureOpenAI.ChatCompletions.Model, "gpt-4", true)
+		testFn(t, &client.Chat.Completions, azureOpenAI.ChatCompletions.Model, true)
 	})
 }
 

sdk/ai/azopenai/client_shared_test.go

@@ -74,14 +74,8 @@ func getEnvVariable(varName string, playbackValue string) string {
 	return val
 }
 
-func getEndpoint(ev string, azure bool) string {
-	fakeEP := fakeAzureEndpoint
-
-	if !azure {
-		fakeEP = fakeOpenAIEndpoint
-	}
-
-	v := getEnvVariable(ev, fakeEP)
+func getEndpoint(ev string) string {
+	v := getEnvVariable(ev, fakeAzureEndpoint)
 
 	if !strings.HasSuffix(v, "/") {
 		// (this just makes recording replacement easier)
@@ -116,22 +110,22 @@ var azureOpenAI = func() testVars {
 		OpenAI         endpoint
 	}{
 		USEast: endpoint{
-			URL:    getEndpoint("AOAI_ENDPOINT_USEAST", true),
+			URL:    getEndpoint("AOAI_ENDPOINT_USEAST"),
 			APIKey: getEnvVariable("AOAI_ENDPOINT_USEAST_API_KEY", fakeAPIKey),
 			Azure:  true,
 		},
 		USEast2: endpoint{
-			URL:    getEndpoint("AOAI_ENDPOINT_USEAST2", true),
+			URL:    getEndpoint("AOAI_ENDPOINT_USEAST2"),
 			APIKey: getEnvVariable("AOAI_ENDPOINT_USEAST2_API_KEY", fakeAPIKey),
 			Azure:  true,
 		},
 		USNorthCentral: endpoint{
-			URL:    getEndpoint("AOAI_ENDPOINT_USNORTHCENTRAL", true),
+			URL:    getEndpoint("AOAI_ENDPOINT_USNORTHCENTRAL"),
 			APIKey: getEnvVariable("AOAI_ENDPOINT_USNORTHCENTRAL_API_KEY", fakeAPIKey),
 			Azure:  true,
 		},
 		SWECentral: endpoint{
-			URL:    getEndpoint("AOAI_ENDPOINT_SWECENTRAL", true),
+			URL:    getEndpoint("AOAI_ENDPOINT_SWECENTRAL"),
 			APIKey: getEnvVariable("AOAI_ENDPOINT_SWECENTRAL_API_KEY", fakeAPIKey),
 			Azure:  true,
 		},
@@ -223,9 +217,9 @@ var azureOpenAI = func() testVars {
 		}
 
 		for area, epm := range remaps {
-			os.Setenv("AOAI_"+area+"_ENDPOINT", epm.Endpoint.URL)
-			os.Setenv("AOAI_"+area+"_API_KEY", epm.Endpoint.APIKey)
-			os.Setenv("AOAI_"+area+"_MODEL", epm.Model)
+			_ = os.Setenv("AOAI_"+area+"_ENDPOINT", epm.Endpoint.URL)
+			_ = os.Setenv("AOAI_"+area+"_API_KEY", epm.Endpoint.APIKey)
+			_ = os.Setenv("AOAI_"+area+"_MODEL", epm.Model)
 		}
 	}
 
@@ -275,7 +269,6 @@ func newStainlessTestClientWithV1URL(t *testing.T, ep endpoint) openai.Client {
 }
 
 const fakeAzureEndpoint = "https://Sanitized.openai.azure.com/"
-const fakeOpenAIEndpoint = "https://Sanitized.openai.com/v1"
 const fakeAPIKey = "redacted"
 const fakeCognitiveEndpoint = "https://Sanitized.openai.azure.com"
 const fakeCognitiveIndexName = "index"

sdk/ai/azopenai/custom_client_image_test.go

@@ -42,7 +42,9 @@ func TestImageGeneration_AzureOpenAI(t *testing.T) {
 		headResp, err := http.DefaultClient.Head(resp.Data[0].URL)
 		require.NoError(t, err)
 
-		headResp.Body.Close()
+		err = headResp.Body.Close()
+		require.NoError(t, err)
+
 		require.Equal(t, http.StatusOK, headResp.StatusCode)
 		require.NotEmpty(t, resp.Data[0].RevisedPrompt)
 	}

sdk/ai/azopenai/example_audio_test.go

@@ -9,7 +9,9 @@ import (
 	"io"
 	"os"
 
+	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
 	"github.com/openai/openai-go/v3"
+	"github.com/openai/openai-go/v3/azure"
 )
 
 // Example_audioTranscription demonstrates how to transcribe speech to text using Azure OpenAI's Whisper model.
@@ -22,30 +24,38 @@ import (
 // The example uses environment variables for configuration:
 // - AOAI_WHISPER_ENDPOINT: Your Azure OpenAI endpoint URL
 // - AOAI_WHISPER_MODEL: The deployment name of your Whisper model
+// - AZURE_OPENAI_API_VERSION: Azure OpenAI service API version to use. See https://learn.microsoft.com/azure/ai-foundry/openai/api-version-lifecycle?tabs=go for information about API versions.
 //
 // Audio transcription is useful for accessibility features, creating searchable archives of audio content,
 // generating captions or subtitles, and enabling voice commands in applications.
 func Example_audioTranscription() {
-	if !CheckRequiredEnvVars("AOAI_WHISPER_ENDPOINT", "AOAI_WHISPER_MODEL") {
-		fmt.Fprintf(os.Stderr, "Skipping example, environment variables missing\n")
-		return
-	}
-
 	endpoint := os.Getenv("AOAI_WHISPER_ENDPOINT")
 	model := os.Getenv("AOAI_WHISPER_MODEL")
+	apiVersion := os.Getenv("AZURE_OPENAI_API_VERSION")
+
+	tokenCredential, err := azidentity.NewDefaultAzureCredential(nil)
 
-	client, err := CreateOpenAIClientWithToken(endpoint, "")
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "ERROR: %s\n", err)
 		return
 	}
 
+	client := openai.NewClient(
+		azure.WithEndpoint(endpoint, apiVersion),
+		azure.WithTokenCredential(tokenCredential),
+	)
+
 	audio_file, err := os.Open("testdata/sampledata_audiofiles_myVoiceIsMyPassportVerifyMe01.mp3")
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "ERROR: %s\n", err)
 		return
 	}
-	defer audio_file.Close()
+
+	defer func() {
+		if err := audio_file.Close(); err != nil {
+			fmt.Fprintf(os.Stderr, "ERROR: %s\n", err)
+		}
+	}()
 
 	resp, err := client.Audio.Transcriptions.New(context.TODO(), openai.AudioTranscriptionNewParams{
 		Model:          openai.AudioModel(model),
@@ -71,24 +81,26 @@ func Example_audioTranscription() {
 // The example uses environment variables for configuration:
 // - AOAI_TTS_ENDPOINT: Your Azure OpenAI endpoint URL
 // - AOAI_TTS_MODEL: The deployment name of your text-to-speech model
+// - AZURE_OPENAI_API_VERSION: Azure OpenAI service API version to use. See https://learn.microsoft.com/azure/ai-foundry/openai/api-version-lifecycle?tabs=go for information about API versions.
 //
 // Text-to-speech conversion is valuable for creating audiobooks, virtual assistants,
 // accessibility tools, and adding voice interfaces to applications.
 func Example_generateSpeechFromText() {
-	if !CheckRequiredEnvVars("AOAI_TTS_ENDPOINT", "AOAI_TTS_MODEL") {
-		fmt.Fprintf(os.Stderr, "Skipping example, environment variables missing\n")
-		return
-	}
-
 	endpoint := os.Getenv("AOAI_TTS_ENDPOINT")
 	model := os.Getenv("AOAI_TTS_MODEL")
+	apiVersion := os.Getenv("AZURE_OPENAI_API_VERSION")
 
-	client, err := CreateOpenAIClientWithToken(endpoint, "")
+	tokenCredential, err := azidentity.NewDefaultAzureCredential(nil)
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "ERROR: %s\n", err)
 		return
 	}
 
+	client := openai.NewClient(
+		azure.WithEndpoint(endpoint, apiVersion),
+		azure.WithTokenCredential(tokenCredential),
+	)
+
 	audioResp, err := client.Audio.Speech.New(context.Background(), openai.AudioSpeechNewParams{
 		Model:          openai.SpeechModel(model),
 		Input:          "i am a computer",
@@ -101,7 +113,11 @@ func Example_generateSpeechFromText() {
 		return
 	}
 
-	defer audioResp.Body.Close()
+	defer func() {
+		if err := audioResp.Body.Close(); err != nil {
+			fmt.Fprintf(os.Stderr, "ERROR: %s\n", err)
+		}
+	}()
 
 	audioBytes, err := io.ReadAll(audioResp.Body)
 
@@ -124,30 +140,37 @@ func Example_generateSpeechFromText() {
 // The example uses environment variables for configuration:
 // - AOAI_WHISPER_ENDPOINT: Your Azure OpenAI endpoint URL
 // - AOAI_WHISPER_MODEL: The deployment name of your Whisper model
+// - AZURE_OPENAI_API_VERSION: Azure OpenAI service API version to use. See https://learn.microsoft.com/azure/ai-foundry/openai/api-version-lifecycle?tabs=go for information about API versions.
 //
 // Speech translation is essential for cross-language communication, creating multilingual content,
 // and building applications that break down language barriers.
 func Example_audioTranslation() {
-	if !CheckRequiredEnvVars("AOAI_WHISPER_ENDPOINT", "AOAI_WHISPER_MODEL") {
-		fmt.Fprintf(os.Stderr, "Skipping example, environment variables missing\n")
-		return
-	}
-
 	endpoint := os.Getenv("AOAI_WHISPER_ENDPOINT")
 	model := os.Getenv("AOAI_WHISPER_MODEL")
+	apiVersion := os.Getenv("AZURE_OPENAI_API_VERSION")
 
-	client, err := CreateOpenAIClientWithToken(endpoint, "")
+	tokenCredential, err := azidentity.NewDefaultAzureCredential(nil)
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "ERROR: %s\n", err)
 		return
 	}
 
+	client := openai.NewClient(
+		azure.WithEndpoint(endpoint, apiVersion),
+		azure.WithTokenCredential(tokenCredential),
+	)
+
 	audio_file, err := os.Open("testdata/sampleaudio_hindi_myVoiceIsMyPassportVerifyMe.mp3")
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "ERROR: %s\n", err)
 		return
 	}
-	defer audio_file.Close()
+
+	defer func() {
+		if err := audio_file.Close(); err != nil {
+			fmt.Fprintf(os.Stderr, "ERROR: %s\n", err)
+		}
+	}()
 
 	resp, err := client.Audio.Translations.New(context.TODO(), openai.AudioTranslationNewParams{
 		Model:  openai.AudioModel(model),

sdk/ai/azopenai/example_azure_auth_methods_test.go

@@ -31,11 +31,6 @@ import (
 // - Managed Identity
 // - Azure CLI credentials
 func Example_usingDefaultAzureCredential() {
-	if !CheckRequiredEnvVars("AOAI_ENDPOINT", "AOAI_MODEL") {
-		fmt.Fprintf(os.Stderr, "Environment variables are not set, not running example.")
-		return
-	}
-
 	endpoint := os.Getenv("AOAI_ENDPOINT")
 	model := os.Getenv("AOAI_MODEL")
 	tenantID := os.Getenv("AZURE_TENANT_ID")
@@ -80,11 +75,6 @@ func Example_usingManagedIdentityCredential() {
 	endpoint := os.Getenv("AOAI_ENDPOINT")
 	model := os.Getenv("AOAI_MODEL")
 
-	if endpoint == "" || model == "" {
-		fmt.Fprintf(os.Stderr, "Environment variables are not set, not running example.")
-		return
-	}
-
 	var credential *azidentity.ManagedIdentityCredential
 	var err error
 

sdk/ai/azopenai/example_azure_content_filtering_test.go

@@ -9,7 +9,9 @@ import (
 	"os"
 
 	"github.com/Azure/azure-sdk-for-go/sdk/ai/azopenai"
+	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
 	"github.com/openai/openai-go/v3"
+	"github.com/openai/openai-go/v3/azure"
 )
 
 // Example_usingAzureContentFiltering demonstrates how to use Azure OpenAI's content filtering capabilities.
@@ -23,27 +25,29 @@ import (
 // The example uses environment variables for configuration:
 // - AOAI_ENDPOINT: Your Azure OpenAI endpoint URL
 // - AOAI_MODEL: The deployment name of your model
+// - AZURE_OPENAI_API_VERSION: Azure OpenAI service API version to use. See https://learn.microsoft.com/azure/ai-foundry/openai/api-version-lifecycle?tabs=go for information about API versions.
 //
 // Content filtering is essential for:
 // - Maintaining content safety and compliance
 // - Monitoring content severity levels
 // - Implementing content moderation policies
 // - Handling filtered content gracefully
 func Example_usingAzureContentFiltering() {
-	if !CheckRequiredEnvVars("AOAI_ENDPOINT", "AOAI_MODEL") {
-		fmt.Fprintf(os.Stderr, "Environment variables are not set, not running example.")
-		return
-	}
-
 	endpoint := os.Getenv("AOAI_ENDPOINT")
 	model := os.Getenv("AOAI_MODEL")
+	apiVersion := os.Getenv("AZURE_OPENAI_API_VERSION")
 
-	client, err := CreateOpenAIClientWithToken(endpoint, "")
+	tokenCredential, err := azidentity.NewDefaultAzureCredential(nil)
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "ERROR: %s\n", err)
 		return
 	}
 
+	client := openai.NewClient(
+		azure.WithEndpoint(endpoint, apiVersion),
+		azure.WithTokenCredential(tokenCredential),
+	)
+
 	// Standard OpenAI chat completion request
 	chatParams := openai.ChatCompletionNewParams{
 		Model:     openai.ChatModel(model),
@@ -135,27 +139,29 @@ func Example_usingAzureContentFiltering() {
 // The example uses environment variables for configuration:
 // - AOAI_ENDPOINT: Your Azure OpenAI endpoint URL
 // - AOAI_MODEL: The deployment name of your model
+// - AZURE_OPENAI_API_VERSION: Azure OpenAI service API version to use. See https://learn.microsoft.com/azure/ai-foundry/openai/api-version-lifecycle?tabs=go for information about API versions.
 //
 // Streaming with prompt filtering is useful for:
 // - Real-time content moderation
 // - Progressive content delivery
 // - Monitoring content safety during generation
 // - Building responsive applications with content safety checks
 func Example_usingAzurePromptFilteringWithStreaming() {
-	if !CheckRequiredEnvVars("AOAI_ENDPOINT", "AOAI_MODEL") {
-		fmt.Fprintf(os.Stderr, "Environment variables are not set, not running example.")
-		return
-	}
-
 	endpoint := os.Getenv("AOAI_ENDPOINT")
 	model := os.Getenv("AOAI_MODEL")
+	apiVersion := os.Getenv("AZURE_OPENAI_API_VERSION")
 
-	client, err := CreateOpenAIClientWithToken(endpoint, "")
+	tokenCredential, err := azidentity.NewDefaultAzureCredential(nil)
 	if err != nil {
 		fmt.Fprintf(os.Stderr, "ERROR: %s\n", err)
 		return
 	}
 
+	client := openai.NewClient(
+		azure.WithEndpoint(endpoint, apiVersion),
+		azure.WithTokenCredential(tokenCredential),
+	)
+
 	// Example of streaming with Azure extensions
 	fmt.Fprintf(os.Stderr, "Streaming example:\n")
 	streamingParams := openai.ChatCompletionNewParams{