[azopenai] Updating API version 2024-05-01 (Azure#22967)

Also got to fix some of my recordings so our test percentages aren't abysmal

Author: richardpark-msft

eng/config.json

@@ -46,7 +46,7 @@
         },
         {
             "Name": "azopenai",
-            "CoverageGoal": 0.26
+            "CoverageGoal": 0.22
         },
         {
             "Name": "ai/azopenaiassistants",

sdk/ai/azopenai/CHANGELOG.md

@@ -4,12 +4,17 @@
 
 ### Features Added
 
-- Updating to the `2024-04-01-preview` API version for Azure OpenAI. (PR#22798)
+- Updating to the `2024-05-01-preview` API version for Azure OpenAI. (PR#22967)
 
 ### Breaking Changes
 
 - ContentFilterResultDetailsForPrompt.CustomBlocklists has been changed from a []ContentFilterBlocklistIDResult to a struct, 
   containing the slice of []ContentFilterBlocklistIDResult.
+- OnYourDataEndpointVectorizationSource.Authentication's type has changed to OnYourDataVectorSearchAuthenticationOptionsClassification
+- Casing has been corrected for fields:
+  - Filepath -> FilePath
+  - FilepathField -> FilePathField
+  - CustomBlocklists -> CustomBlockLists
 
 ### Bugs Fixed
 

sdk/ai/azopenai/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "go",
   "TagPrefix": "go/ai/azopenai",
-  "Tag": "go/ai/azopenai_d0d55a804a"
+  "Tag": "go/ai/azopenai_6996498620"
 }

sdk/ai/azopenai/autorest.md

@@ -133,6 +133,44 @@ directive:
     transform: return $.replace(/InternalChatCompletionsResponseFormat/g, "respType")
 ```
 
+Fix casing of some fields
+
+```yaml
+directive:
+  # Filepath -> FilePath
+  - from: swagger-document
+    where: $.definitions.AzureChatExtensionRetrievedDocument
+    transform: $.properties.filepath["x-ms-client-name"] = "FilePath"
+  - from: swagger-document
+    where: $.definitions.AzureChatExtensionDataSourceResponseCitation
+    transform: $.properties.filepath["x-ms-client-name"] = "FilePath"
+  
+  # FilepathField -> FilePathField
+  - from: swagger-document
+    where: $.definitions.AzureCosmosDBFieldMappingOptions
+    transform: $.properties.filepath_field["x-ms-client-name"] = "FilePathField"
+  - from: swagger-document
+    where: $.definitions.AzureSearchIndexFieldMappingOptions
+    transform: $.properties.filepath_field["x-ms-client-name"] = "FilePathField"
+  - from: swagger-document
+    where: $.definitions.ElasticsearchIndexFieldMappingOptions
+    transform: $.properties.filepath_field["x-ms-client-name"] = "FilePathField"
+  - from: swagger-document
+    where: $.definitions.PineconeFieldMappingOptions
+    transform: $.properties.filepath_field["x-ms-client-name"] = "FilePathField"
+
+  # CustomBlocklist -> CustomBlockList
+  - from: swagger-document
+    where: $.definitions.ImageGenerationPromptFilterResults
+    transform: $.properties.custom_blocklists["x-ms-client-name"] = "CustomBlockLists"
+  - from: swagger-document
+    where: $.definitions.ContentFilterResultDetailsForPrompt
+    transform: $.properties.custom_blocklists["x-ms-client-name"] = "CustomBlockLists"    
+  - from: swagger-document
+    where: $.definitions.ContentFilterResultsForChoice
+    transform: $.properties.custom_blocklists["x-ms-client-name"] = "CustomBlockLists"    
+```
+
 ## Cleanup the audio transcription APIs
 
 We're wrapping the audio translation and transcription APIs, so we can eliminate some of 

sdk/ai/azopenai/client.go

@@ -13,7 +13,6 @@ import (
 	"mime"
 	"net/http"
 	"os"
-	"regexp"
 	"strings"
 	"testing"
 
@@ -76,7 +75,7 @@ func getEnvVariable(varName string, playbackValue string) string {
 	return val
 }
 
-var azureOpenAI, openAI, servers = func() (testVars, testVars, []string) {
+var azureOpenAI, openAI = func() (testVars, testVars) {
 	servers := struct {
 		USEast         endpoint
 		USNorthCentral endpoint
@@ -85,41 +84,32 @@ var azureOpenAI, openAI, servers = func() (testVars, testVars, []string) {
 		OpenAI         endpoint
 	}{
 		OpenAI: endpoint{
-			URL:    getEndpoint("OPENAI_ENDPOINT"), // ex: https://api.openai.com/v1/
+			URL:    getEndpoint("OPENAI_ENDPOINT", false), // ex: https://api.openai.com/v1/
 			APIKey: getEnvVariable("OPENAI_API_KEY", fakeAPIKey),
 			Azure:  false,
 		},
 		USEast: endpoint{
-			URL:    getEndpoint("AOAI_ENDPOINT_USEAST"),
+			URL:    getEndpoint("AOAI_ENDPOINT_USEAST", true),
 			APIKey: getEnvVariable("AOAI_ENDPOINT_USEAST_API_KEY", fakeAPIKey),
 			Azure:  true,
 		},
 		USEast2: endpoint{
-			URL:    getEndpoint("AOAI_ENDPOINT_USEAST2"),
+			URL:    getEndpoint("AOAI_ENDPOINT_USEAST2", true),
 			APIKey: getEnvVariable("AOAI_ENDPOINT_USEAST2_API_KEY", fakeAPIKey),
 			Azure:  true,
 		},
 		USNorthCentral: endpoint{
-			URL:    getEndpoint("AOAI_ENDPOINT_USNORTHCENTRAL"),
+			URL:    getEndpoint("AOAI_ENDPOINT_USNORTHCENTRAL", true),
 			APIKey: getEnvVariable("AOAI_ENDPOINT_USNORTHCENTRAL_API_KEY", fakeAPIKey),
 			Azure:  true,
 		},
 		SWECentral: endpoint{
-			URL:    getEndpoint("AOAI_ENDPOINT_SWECENTRAL"),
+			URL:    getEndpoint("AOAI_ENDPOINT_SWECENTRAL", true),
 			APIKey: getEnvVariable("AOAI_ENDPOINT_SWECENTRAL_API_KEY", fakeAPIKey),
 			Azure:  true,
 		},
 	}
 
-	// used when we setup the recording policy
-	endpoints := []string{
-		servers.OpenAI.URL,
-		servers.USEast.URL,
-		servers.USEast2.URL,
-		servers.USNorthCentral.URL,
-		servers.SWECentral.URL,
-	}
-
 	newTestVarsFn := func(azure bool) testVars {
 		return testVars{
 			ChatCompletions: endpointWithModel{
@@ -172,11 +162,9 @@ var azureOpenAI, openAI, servers = func() (testVars, testVars, []string) {
 			},
 			Cognitive: azopenai.AzureSearchChatExtensionConfiguration{
 				Parameters: &azopenai.AzureSearchChatExtensionParameters{
-					Endpoint:  to.Ptr(recording.GetEnvVariable("COGNITIVE_SEARCH_API_ENDPOINT", fakeCognitiveEndpoint)),
-					IndexName: to.Ptr(recording.GetEnvVariable("COGNITIVE_SEARCH_API_INDEX", fakeCognitiveIndexName)),
-					Authentication: &azopenai.OnYourDataAPIKeyAuthenticationOptions{
-						Key: to.Ptr(recording.GetEnvVariable("COGNITIVE_SEARCH_API_KEY", fakeAPIKey)),
-					},
+					Endpoint:       to.Ptr(recording.GetEnvVariable("COGNITIVE_SEARCH_API_ENDPOINT", fakeCognitiveEndpoint)),
+					IndexName:      to.Ptr(recording.GetEnvVariable("COGNITIVE_SEARCH_API_INDEX", fakeCognitiveIndexName)),
+					Authentication: &azopenai.OnYourDataSystemAssignedManagedIdentityAuthenticationOptions{},
 				},
 			},
 		}
@@ -195,8 +183,8 @@ var azureOpenAI, openAI, servers = func() (testVars, testVars, []string) {
 			"DALLE":                                   azureTestVars.DallE,
 			"EMBEDDINGS":                              azureTestVars.Embeddings,
 			// these resources are oversubscribed and occasionally fail in live testing.
-			//"VISION":                                  azureTestVars.Vision,
-			//"WHISPER": azureTestVars.Whisper,
+			// "VISION":                                  azureTestVars.Vision,
+			// "WHISPER": azureTestVars.Whisper,
 		}
 
 		for area, epm := range remaps {
@@ -206,7 +194,7 @@ var azureOpenAI, openAI, servers = func() (testVars, testVars, []string) {
 		}
 	}
 
-	return azureTestVars, newTestVarsFn(false), endpoints
+	return azureTestVars, newTestVarsFn(false)
 }()
 
 type testClientOption func(opt *azopenai.ClientOptions)
@@ -241,9 +229,10 @@ func newTestClient(t *testing.T, ep endpoint, options ...testClientOption) *azop
 	}
 }
 
-const fakeEndpoint = "https://fake-recorded-host.microsoft.com/"
+const fakeAzureEndpoint = "https://Sanitized.openai.azure.com/"
+const fakeOpenAIEndpoint = "https://Sanitized.openai.com/v1"
 const fakeAPIKey = "redacted"
-const fakeCognitiveEndpoint = "https://fake-cognitive-endpoint.microsoft.com"
+const fakeCognitiveEndpoint = "https://Sanitized.openai.azure.com"
 const fakeCognitiveIndexName = "index"
 
 type MultipartRecordingPolicy struct {
@@ -266,23 +255,12 @@ func newRecordingTransporter(t *testing.T) policy.Transporter {
 		err = recording.AddHeaderRegexSanitizer("Api-Key", fakeAPIKey, "", nil)
 		require.NoError(t, err)
 
-		err = recording.AddHeaderRegexSanitizer("User-Agent", "fake-user-agent", "", nil)
+		err = recording.AddHeaderRegexSanitizer("Uer-Agent", "fake-user-agent", "", nil)
 		require.NoError(t, err)
 
-		for _, ep := range servers {
-			err = recording.AddURISanitizer(fakeEndpoint, regexp.QuoteMeta(ep), nil)
-			require.NoError(t, err)
-		}
-
 		err = recording.AddURISanitizer("/openai/operations/images/00000000-AAAA-BBBB-CCCC-DDDDDDDDDDDD", "/openai/operations/images/[A-Za-z-0-9]+", nil)
 		require.NoError(t, err)
 
-		// there's only one OpenAI endpoint
-		if openAI.ChatCompletions.Endpoint.URL != "" {
-			err = recording.AddURISanitizer(fakeEndpoint, regexp.QuoteMeta(openAI.ChatCompletions.Endpoint.URL), nil)
-			require.NoError(t, err)
-		}
-
 		err = recording.AddGeneralRegexSanitizer(
 			fmt.Sprintf(`"endpoint": "%s"`, fakeCognitiveEndpoint),
 			fmt.Sprintf(`"endpoint":\s*"%s"`, *azureOpenAI.Cognitive.Parameters.Endpoint), nil)
@@ -292,11 +270,6 @@ func newRecordingTransporter(t *testing.T) policy.Transporter {
 			fmt.Sprintf(`"index_name": "%s"`, fakeCognitiveIndexName),
 			fmt.Sprintf(`"index_name":\s*"%s"`, *azureOpenAI.Cognitive.Parameters.IndexName), nil)
 		require.NoError(t, err)
-
-		err = recording.AddGeneralRegexSanitizer(
-			fmt.Sprintf(`"key": "%s"`, fakeAPIKey),
-			fmt.Sprintf(`"key":\s*"%s"`, *azureOpenAI.Cognitive.Parameters.Authentication.(*azopenai.OnYourDataAPIKeyAuthenticationOptions).Key), nil)
-		require.NoError(t, err)
 	}
 
 	t.Cleanup(func() {
@@ -377,11 +350,17 @@ func assertResponseIsError(t *testing.T, err error) {
 	require.Truef(t, respErr.StatusCode == http.StatusUnauthorized || respErr.StatusCode == http.StatusTooManyRequests, "An acceptable error comes back (actual: %d)", respErr.StatusCode)
 }
 
-func getEndpoint(ev string) string {
-	v := getEnvVariable(ev, fakeEndpoint)
+func getEndpoint(ev string, azure bool) string {
+	fakeEP := fakeAzureEndpoint
+
+	if !azure {
+		fakeEP = fakeOpenAIEndpoint
+	}
+
+	v := getEnvVariable(ev, fakeEP)
 
 	if !strings.HasSuffix(v, "/") {
-		// (this just makes recording replacement easier)
+		// (this just makes recording replacement easier)j
 		v += "/"
 	}