Azure · joseharriaga · Nov 1, 2023 · Oct 30, 2023
@@ -6,6 +6,8 @@
 
 ### Breaking Changes
 
+- Changed the representation of embeddings from `IReadOnlyList<float>` to `ReadOnlyMemory<float>`.
+
 ### Bugs Fixed
 
 ### Other Changes

@@ -103,7 +103,7 @@ We guarantee that all client instance methods are thread-safe and independent of
 
 You can familiarize yourself with different APIs using [Samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/openai/Azure.AI.OpenAI/tests/Samples).
 
-### Generate Chatbot Response
+### Generate chatbot response
 
 The `GenerateChatbotResponse` method authenticates using a DefaultAzureCredential, then generates text responses to input prompts.
 
@@ -120,7 +120,7 @@ string completion = completionsResponse.Value.Choices[0].Text;
 Console.WriteLine($"Chatbot: {completion}");
 ```
 
-### Generate Multiple Chatbot Responses With Subscription Key
+### Generate multiple chatbot responses with subscription key
 
 The `GenerateMultipleChatbotResponsesWithSubscriptionKey` method gives an example of generating text responses to input prompts using an Azure subscription key
 
@@ -152,7 +152,7 @@ foreach (string prompt in examplePrompts)
 }
 ```
 
-### Summarize Text with Completion
+### Summarize text with completion
 
 The `SummarizeText` method generates a summarization of the given input prompt.
 
@@ -190,7 +190,7 @@ string completion = completionsResponse.Value.Choices[0].Text;
 Console.WriteLine($"Summarization: {completion}");
 ```
 
-### Stream Chat Messages with non-Azure OpenAI
+### Stream chat messages with non-Azure OpenAI
 
 ```C# Snippet:StreamChatMessages
 string nonAzureOpenAIApiKey = "your-api-key-from-platform.openai.com";
@@ -221,7 +221,7 @@ await foreach (StreamingChatChoice choice in streamingChatCompletions.GetChoices
 }
 ```
 
-### Use Chat Functions
+### Use chat functions
 
 Chat Functions allow a caller of Chat Completions to define capabilities that the model can use to extend its
 functionality into external tools and data sources.
@@ -385,6 +385,18 @@ foreach (ChatMessage contextMessage in message.AzureExtensionsContext.Messages)
 }
 ```
 
+### Generate embeddings
+
+```C# Snippet:GenerateEmbeddings
+string deploymentOrModelName = "text-embedding-ada-002";
+EmbeddingsOptions embeddingsOptions = new("Your text string goes here");
+Response<Embeddings> response = await client.GetEmbeddingsAsync(deploymentOrModelName, embeddingsOptions);
+
+// The response includes the generated embedding.
+EmbeddingItem item = response.Value.Data[0];
+ReadOnlyMemory<float> embedding = item.Embedding;
+``````
+
 ### Generate images with DALL-E image generation models
 
 ```C# Snippet:GenerateImages

@@ -198,7 +198,7 @@ public static partial class AzureOpenAIModelFactory
         public static Azure.AI.OpenAI.CompletionsUsage CompletionsUsage(int completionTokens = 0, int promptTokens = 0, int totalTokens = 0) { throw null; }
         public static Azure.AI.OpenAI.ContentFilterResult ContentFilterResult(Azure.AI.OpenAI.ContentFilterSeverity severity = default(Azure.AI.OpenAI.ContentFilterSeverity), bool filtered = false) { throw null; }
         public static Azure.AI.OpenAI.ContentFilterResults ContentFilterResults(Azure.AI.OpenAI.ContentFilterResult sexual = null, Azure.AI.OpenAI.ContentFilterResult violence = null, Azure.AI.OpenAI.ContentFilterResult hate = null, Azure.AI.OpenAI.ContentFilterResult selfHarm = null, Azure.ResponseError error = null) { throw null; }
-        public static Azure.AI.OpenAI.EmbeddingItem EmbeddingItem(System.Collections.Generic.IEnumerable<float> embedding = null, int index = 0) { throw null; }
+        public static Azure.AI.OpenAI.EmbeddingItem EmbeddingItem(System.ReadOnlyMemory<float> embedding = default(System.ReadOnlyMemory<float>), int index = 0) { throw null; }
         public static Azure.AI.OpenAI.Embeddings Embeddings(System.Collections.Generic.IEnumerable<Azure.AI.OpenAI.EmbeddingItem> data = null, Azure.AI.OpenAI.EmbeddingsUsage usage = null) { throw null; }
         public static Azure.AI.OpenAI.EmbeddingsUsage EmbeddingsUsage(int promptTokens = 0, int totalTokens = 0) { throw null; }
         public static Azure.AI.OpenAI.ImageGenerations ImageGenerations(System.DateTimeOffset created = default(System.DateTimeOffset), System.Collections.Generic.IEnumerable<Azure.AI.OpenAI.ImageLocation> data = null) { throw null; }
@@ -384,7 +384,7 @@ internal ContentFilterResults() { }
     public partial class EmbeddingItem
     {
         internal EmbeddingItem() { }
-        public System.Collections.Generic.IReadOnlyList<float> Embedding { get { throw null; } }
+        public System.ReadOnlyMemory<float> Embedding { get { throw null; } }
         public int Index { get { throw null; } }
     }
     public partial class Embeddings

@@ -0,0 +1,36 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Runtime.CompilerServices;
+using System.Text.Json;
+using Azure.Core;
+
+namespace Azure.AI.OpenAI
+{
+    /// <summary> Representation of a single embeddings relatedness comparison. </summary>
+    public partial class EmbeddingItem
+    {
+        // CUSTOM CODE NOTE: The change of the Embedding property to ReadOnlyMemory<float>
+        // results in the constructor below being generated twice and thus a build error.
+        // We're adding it here verbatim as custom code to work around this issue.
+
+        /// <summary> Initializes a new instance of EmbeddingItem. </summary>
+        /// <param name="embedding">
+        /// List of embeddings value for the input prompt. These represent a measurement of the
+        /// vector-based relatedness of the provided input.
+        /// </param>
+        /// <param name="index"> Index of the prompt to which the EmbeddingItem corresponds. </param>
+        internal EmbeddingItem(ReadOnlyMemory<float> embedding, int index)
+        {
+            Embedding = embedding;
+            Index = index;
+        }
+
+        // CUSTOM CODE NOTE: We want to represent embeddings as ReadOnlyMemory<float> instead
+        // of IReadOnlyList<float>.
+        public ReadOnlyMemory<float> Embedding { get; }
+    }
+}
@@ -84,6 +84,13 @@ public async Task Embeddings(OpenAIClientServiceTarget serviceTarget)
             Assert.That(embeddingsRequest, Is.InstanceOf<EmbeddingsOptions>());
             Response<Embeddings> response = await client.GetEmbeddingsAsync(deploymentOrModelName, embeddingsRequest);
             Assert.That(response, Is.InstanceOf<Response<Embeddings>>());
+            Assert.That(response.Value, Is.Not.Null);
+            Assert.That(response.Value.Data, Is.Not.Null.Or.Empty);
+
+            EmbeddingItem firstItem = response.Value.Data[0];
+            Assert.That(firstItem, Is.Not.Null);
+            Assert.That(firstItem.Index, Is.EqualTo(0));
+            Assert.That(firstItem.Embedding, Is.Not.Null.Or.Empty);
         }
 
         [RecordedTest]

@@ -9,7 +9,7 @@
 
 namespace Azure.AI.OpenAI.Tests.Samples
 {
-    public partial class StreamingChat
+    public partial class ImagesSamples
     {
         [Test]
         [Ignore("Only verifying that the sample builds")]

@@ -9,7 +9,7 @@
 
 namespace Azure.AI.OpenAI.Tests.Samples
 {
-    public partial class StreamingChat
+    public partial class AudioSamples
     {
         [Test]
         [Ignore("Only verifying that the sample builds")]

@@ -9,7 +9,7 @@
 
 namespace Azure.AI.OpenAI.Tests.Samples
 {
-    public partial class StreamingChat
+    public partial class AudioSamples
     {
         [Test]
         [Ignore("Only verifying that the sample builds")]

@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Threading.Tasks;
+using Azure.Identity;
+using NUnit.Framework;
+
+namespace Azure.AI.OpenAI.Tests.Samples
+{
+    public partial class EmbeddingsSamples
+    {
+        [Test]
+        [Ignore("Only verifying that the sample builds")]
+        public async Task GenerateEmbeddings()
+        {
+            string endpoint = "https://myaccount.openai.azure.com/";
+            var client = new OpenAIClient(new Uri(endpoint), new DefaultAzureCredential());
+
+            #region Snippet:GenerateEmbeddings
+            string deploymentOrModelName = "text-embedding-ada-002";
+            EmbeddingsOptions embeddingsOptions = new("Your text string goes here");
+            Response<Embeddings> response = await client.GetEmbeddingsAsync(deploymentOrModelName, embeddingsOptions);
+
+            // The response includes the generated embedding.
+            EmbeddingItem item = response.Value.Data[0];
+            ReadOnlyMemory<float> embedding = item.Embedding;
+            #endregion
+        }
+    }
+}