[Search] Update Samples as per Azure OpenAI GA Version (Azure#46397)

ShivangiReja · ShivangiReja · web-flow · commit d3cd1400b974 · 2024-10-04T01:50:20.000-07:00
* [Search] Update Samples as per OpenAI GA Version

* Update ApiKeyCredential -&gt; AzureKeyCredential

---------

Co-authored-by: ShivangiReja &lt;shivangi.reja@microsoft.com&gt;
diff --git a/eng/Packages.Data.props b/eng/Packages.Data.props
@@ -128,7 +128,7 @@
     <PackageReference Update="Azure.Storage.Blobs" Version="12.21.1" />
     <PackageReference Update="Azure.Storage.Queues" Version="12.19.1" />
     <PackageReference Update="Azure.Storage.Files.Shares" Version="12.19.1" />
-    <PackageReference Update="Azure.AI.OpenAI" Version="2.0.0-beta.6" />
+    <PackageReference Update="Azure.AI.OpenAI" Version="2.0.0" />
     <PackageReference Update="Azure.ResourceManager" Version="1.13.0" />
     <PackageReference Update="Azure.ResourceManager.AppConfiguration" Version="1.3.2" />
     <PackageReference Update="Azure.ResourceManager.ApplicationInsights" Version="1.0.0" />
diff --git a/sdk/search/Azure.Search.Documents/assets.json b/sdk/search/Azure.Search.Documents/assets.json
@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "net",
   "TagPrefix": "net/search/Azure.Search.Documents",
-  "Tag": "net/search/Azure.Search.Documents_71e5c48d88"
+  "Tag": "net/search/Azure.Search.Documents_1b05ea0ca5"
 }
diff --git a/sdk/search/Azure.Search.Documents/samples/Sample07_VectorSearch_UsingReducedEmbeddings.md b/sdk/search/Azure.Search.Documents/samples/Sample07_VectorSearch_UsingReducedEmbeddings.md
@@ -107,7 +107,7 @@ public static ReadOnlyMemory<float> GetEmbeddings(string input)
     {
         Dimensions = 256
     };
-    Embedding embedding = embeddingClient.GenerateEmbedding(input, embeddingsOptions);
+    OpenAIEmbedding embedding = embeddingClient.GenerateEmbedding(input, embeddingsOptions);
     return embedding.ToFloats();
 }
 ```
diff --git a/sdk/search/Azure.Search.Documents/samples/Sample07_VectorSearch_UsingSemanticHybridQuery.md b/sdk/search/Azure.Search.Documents/samples/Sample07_VectorSearch_UsingSemanticHybridQuery.md
@@ -98,7 +98,7 @@ public static ReadOnlyMemory<float> GetEmbeddings(string input)
     AzureOpenAIClient openAIClient = new AzureOpenAIClient(endpoint, credential);
     EmbeddingClient embeddingClient = openAIClient.GetEmbeddingClient("text-embedding-ada-002");
 
-    Embedding embedding = embeddingClient.GenerateEmbedding(input);
+    OpenAIEmbedding embedding = embeddingClient.GenerateEmbedding(input);
     return embedding.ToFloats();
 }
 ```
diff --git a/sdk/search/Azure.Search.Documents/samples/Sample07_VectorSearch_UsingVectorizableTextQuery.md b/sdk/search/Azure.Search.Documents/samples/Sample07_VectorSearch_UsingVectorizableTextQuery.md
@@ -97,7 +97,7 @@ public static ReadOnlyMemory<float> GetEmbeddings(string input)
     AzureOpenAIClient openAIClient = new AzureOpenAIClient(endpoint, credential);
     EmbeddingClient embeddingClient = openAIClient.GetEmbeddingClient("text-embedding-ada-002");
 
-    Embedding embedding = embeddingClient.GenerateEmbedding(input);
+    OpenAIEmbedding embedding = embeddingClient.GenerateEmbedding(input);
     return embedding.ToFloats();
 }
 ```
diff --git a/sdk/search/Azure.Search.Documents/samples/Sample07_VectorSearch_UsingVectorizedQuery.md b/sdk/search/Azure.Search.Documents/samples/Sample07_VectorSearch_UsingVectorizedQuery.md
@@ -80,7 +80,7 @@ public static ReadOnlyMemory<float> GetEmbeddings(string input)
     AzureOpenAIClient openAIClient = new AzureOpenAIClient(endpoint, credential);
     EmbeddingClient embeddingClient = openAIClient.GetEmbeddingClient("text-embedding-ada-002");
 
-    Embedding embedding = embeddingClient.GenerateEmbedding(input);
+    OpenAIEmbedding embedding = embeddingClient.GenerateEmbedding(input);
     return embedding.ToFloats();
 }
 ```
diff --git a/sdk/search/Azure.Search.Documents/tests/Azure.Search.Documents.Tests.csproj b/sdk/search/Azure.Search.Documents/tests/Azure.Search.Documents.Tests.csproj
@@ -35,9 +35,6 @@
     <PackageReference Include="Azure.Storage.Blobs" />
     <PackageReference Include="Azure.Security.KeyVault.Keys" />
     <PackageReference Include="Microsoft.Spatial" />
-
-    <!-- Temporarily retain package-only references to Azure.AI.OpenAI pending 2.0.0 GA updates -->
-    <ExcludeFromProjectReferenceToConversion Include="Azure.AI.OpenAI" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/sdk/search/Azure.Search.Documents/tests/Samples/Sample07_VectorSearchCommons.cs b/sdk/search/Azure.Search.Documents/tests/Samples/Sample07_VectorSearchCommons.cs
@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using System;
+using System.ClientModel;
 using Azure.AI.OpenAI;
 using OpenAI.Embeddings;
 #pragma warning disable SA1402 // File may only contain a single type
@@ -20,7 +21,7 @@ public static ReadOnlyMemory<float> GetEmbeddings(string input)
             AzureOpenAIClient openAIClient = new AzureOpenAIClient(endpoint, credential);
             EmbeddingClient embeddingClient = openAIClient.GetEmbeddingClient("text-embedding-ada-002");
 
-            Embedding embedding = embeddingClient.GenerateEmbedding(input);
+            OpenAIEmbedding embedding = embeddingClient.GenerateEmbedding(input);
             return embedding.ToFloats();
         }
         #endregion
diff --git a/sdk/search/Azure.Search.Documents/tests/Samples/Sample07_VectorSearch_UsingReducedEmbeddings.cs b/sdk/search/Azure.Search.Documents/tests/Samples/Sample07_VectorSearch_UsingReducedEmbeddings.cs
@@ -10,6 +10,7 @@
 using Azure.Core.TestFramework;
 using Azure.AI.OpenAI;
 using OpenAI.Embeddings;
+using System.ClientModel;
 
 namespace Azure.Search.Documents.Tests.Samples.VectorSearch
 {
@@ -179,7 +180,7 @@ public static ReadOnlyMemory<float> GetEmbeddings(string input)
             {
                 Dimensions = 256
             };
-            Embedding embedding = embeddingClient.GenerateEmbedding(input, embeddingsOptions);
+            OpenAIEmbedding embedding = embeddingClient.GenerateEmbedding(input, embeddingsOptions);
             return embedding.ToFloats();
         }
         #endregion

Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@`
`2`	`2`	`"AssetsRepo": "Azure/azure-sdk-assets",`
`3`	`3`	`"AssetsRepoPrefixPath": "net",`
`4`	`4`	`"TagPrefix": "net/search/Azure.Search.Documents",`
`5`		`- "Tag": "net/search/Azure.Search.Documents_71e5c48d88"`
	`5`	`+ "Tag": "net/search/Azure.Search.Documents_1b05ea0ca5"`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ public static ReadOnlyMemory<float> GetEmbeddings(string input)`
`107`	`107`	`{`
`108`	`108`	`Dimensions = 256`
`109`	`109`	`};`
`110`		`- Embedding embedding = embeddingClient.GenerateEmbedding(input, embeddingsOptions);`
	`110`	`+ OpenAIEmbedding embedding = embeddingClient.GenerateEmbedding(input, embeddingsOptions);`
`111`	`111`	`return embedding.ToFloats();`
`112`	`112`	`}`
`113`	`113`	```
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ public static ReadOnlyMemory<float> GetEmbeddings(string input)`
`98`	`98`	`AzureOpenAIClient openAIClient = new AzureOpenAIClient(endpoint, credential);`
`99`	`99`	`EmbeddingClient embeddingClient = openAIClient.GetEmbeddingClient("text-embedding-ada-002");`
`100`	`100`
`101`		`- Embedding embedding = embeddingClient.GenerateEmbedding(input);`
	`101`	`+ OpenAIEmbedding embedding = embeddingClient.GenerateEmbedding(input);`
`102`	`102`	`return embedding.ToFloats();`
`103`	`103`	`}`
`104`	`104`	```
Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,7 @@ public static ReadOnlyMemory<float> GetEmbeddings(string input)`
`97`	`97`	`AzureOpenAIClient openAIClient = new AzureOpenAIClient(endpoint, credential);`
`98`	`98`	`EmbeddingClient embeddingClient = openAIClient.GetEmbeddingClient("text-embedding-ada-002");`
`99`	`99`
`100`		`- Embedding embedding = embeddingClient.GenerateEmbedding(input);`
	`100`	`+ OpenAIEmbedding embedding = embeddingClient.GenerateEmbedding(input);`
`101`	`101`	`return embedding.ToFloats();`
`102`	`102`	`}`
`103`	`103`	```
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ public static ReadOnlyMemory<float> GetEmbeddings(string input)`
`80`	`80`	`AzureOpenAIClient openAIClient = new AzureOpenAIClient(endpoint, credential);`
`81`	`81`	`EmbeddingClient embeddingClient = openAIClient.GetEmbeddingClient("text-embedding-ada-002");`
`82`	`82`
`83`		`- Embedding embedding = embeddingClient.GenerateEmbedding(input);`
	`83`	`+ OpenAIEmbedding embedding = embeddingClient.GenerateEmbedding(input);`
`84`	`84`	`return embedding.ToFloats();`
`85`	`85`	`}`
`86`	`86`	```
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`using Azure.Core.TestFramework;`
`11`	`11`	`using Azure.AI.OpenAI;`
`12`	`12`	`using OpenAI.Embeddings;`
	`13`	`+using System.ClientModel;`
`13`	`14`
`14`	`15`	`namespace Azure.Search.Documents.Tests.Samples.VectorSearch`
`15`	`16`	`{`
`@@ -179,7 +180,7 @@ public static ReadOnlyMemory<float> GetEmbeddings(string input)`
`179`	`180`	`{`
`180`	`181`	`Dimensions = 256`
`181`	`182`	`};`
`182`		`- Embedding embedding = embeddingClient.GenerateEmbedding(input, embeddingsOptions);`
	`183`	`+ OpenAIEmbedding embedding = embeddingClient.GenerateEmbedding(input, embeddingsOptions);`
`183`	`184`	`return embedding.ToFloats();`
`184`	`185`	`}`
`185`	`186`	`#endregion`