Azure OpenAI: update to 2023-08-01-preview with chat extensions support (Azure#38142)

* initial integration of /extensions/chat/completions

* ingest naming update: 'extensions' for outward representation

* snap to latest tsp update

* test update with now-working deployment

* updates for streaming (service support pending)

* incorporate feedback: include use of strong representation of Azure Cognitive Search options

* tsp update; move ACS options type to custom code pending future union approach

* Update BYOD streaming tests to pass

* Update TypeSpec to point to main

* Minor tweaks

* post-merge code regeneration

* test asset ref update

---------

Co-authored-by: Ralph El Hage <ralphe@microsoft.com>

Author: trrwilson

sdk/openai/Azure.AI.OpenAI/.gitignore

@@ -1,3 +1,4 @@
+package-lock.json
 TempTypeSpecFiles/
 **/Generated/cadl.json
 **/Generated/configuration.json

sdk/openai/Azure.AI.OpenAI/Azure.AI.OpenAI.sln

@@ -1,7 +1,7 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Version 16
-VisualStudioVersion = 16.0.29806.167
+# Visual Studio Version 17
+VisualStudioVersion = 17.6.33927.249
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.AI.OpenAI", "src\Azure.AI.OpenAI.csproj", "{E33D09D9-D809-472C-82E6-6A26BDB86FC2}"
 EndProject

sdk/openai/Azure.AI.OpenAI/api/Azure.AI.OpenAI.netstandard2.0.cs

@@ -1,5 +1,86 @@
 namespace Azure.AI.OpenAI
 {
+    public partial class AzureChatExtensionConfiguration
+    {
+        public AzureChatExtensionConfiguration() { }
+        public AzureChatExtensionConfiguration(Azure.AI.OpenAI.AzureChatExtensionType type, System.BinaryData parameters) { }
+        public System.BinaryData Parameters { get { throw null; } set { } }
+        public virtual Azure.AI.OpenAI.AzureChatExtensionType Type { get { throw null; } set { } }
+    }
+    public partial class AzureChatExtensionsMessageContext
+    {
+        public AzureChatExtensionsMessageContext() { }
+        public System.Collections.Generic.IList<Azure.AI.OpenAI.ChatMessage> Messages { get { throw null; } }
+    }
+    public partial class AzureChatExtensionsOptions
+    {
+        public AzureChatExtensionsOptions() { }
+        public System.Collections.Generic.IList<Azure.AI.OpenAI.AzureChatExtensionConfiguration> Extensions { get { throw null; } }
+    }
+    [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
+    public readonly partial struct AzureChatExtensionType : System.IEquatable<Azure.AI.OpenAI.AzureChatExtensionType>
+    {
+        private readonly object _dummy;
+        private readonly int _dummyPrimitive;
+        public AzureChatExtensionType(string value) { throw null; }
+        public static Azure.AI.OpenAI.AzureChatExtensionType AzureCognitiveSearch { get { throw null; } }
+        public bool Equals(Azure.AI.OpenAI.AzureChatExtensionType other) { throw null; }
+        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
+        public override bool Equals(object obj) { throw null; }
+        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
+        public override int GetHashCode() { throw null; }
+        public static bool operator ==(Azure.AI.OpenAI.AzureChatExtensionType left, Azure.AI.OpenAI.AzureChatExtensionType right) { throw null; }
+        public static implicit operator Azure.AI.OpenAI.AzureChatExtensionType (string value) { throw null; }
+        public static bool operator !=(Azure.AI.OpenAI.AzureChatExtensionType left, Azure.AI.OpenAI.AzureChatExtensionType right) { throw null; }
+        public override string ToString() { throw null; }
+    }
+    public partial class AzureCognitiveSearchChatExtensionConfiguration : Azure.AI.OpenAI.AzureChatExtensionConfiguration
+    {
+        public AzureCognitiveSearchChatExtensionConfiguration() { }
+        public AzureCognitiveSearchChatExtensionConfiguration(Azure.AI.OpenAI.AzureChatExtensionType type, System.Uri searchEndpoint, Azure.AzureKeyCredential searchKey, string indexName) { }
+        public int? DocumentCount { get { throw null; } set { } }
+        public System.Uri EmbeddingEndpoint { get { throw null; } set { } }
+        public Azure.AzureKeyCredential EmbeddingKey { get { throw null; } set { } }
+        public Azure.AI.OpenAI.AzureCognitiveSearchIndexFieldMappingOptions FieldMappingOptions { get { throw null; } set { } }
+        public string IndexName { get { throw null; } set { } }
+        public Azure.AI.OpenAI.AzureCognitiveSearchQueryType? QueryType { get { throw null; } set { } }
+        public System.Uri SearchEndpoint { get { throw null; } set { } }
+        public Azure.AzureKeyCredential SearchKey { get { throw null; } set { } }
+        public string SemanticConfiguration { get { throw null; } set { } }
+        public bool? ShouldRestrictResultScope { get { throw null; } set { } }
+        public override Azure.AI.OpenAI.AzureChatExtensionType Type { get { throw null; } set { } }
+    }
+    public partial class AzureCognitiveSearchIndexFieldMappingOptions
+    {
+        public AzureCognitiveSearchIndexFieldMappingOptions() { }
+        public System.Collections.Generic.IList<string> ContentFieldNames { get { throw null; } }
+        public string ContentFieldSeparator { get { throw null; } set { } }
+        public string FilepathFieldName { get { throw null; } set { } }
+        public string TitleFieldName { get { throw null; } set { } }
+        public string UrlFieldName { get { throw null; } set { } }
+        public System.Collections.Generic.IList<string> VectorFieldNames { get { throw null; } }
+    }
+    [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
+    public readonly partial struct AzureCognitiveSearchQueryType : System.IEquatable<Azure.AI.OpenAI.AzureCognitiveSearchQueryType>
+    {
+        private readonly object _dummy;
+        private readonly int _dummyPrimitive;
+        public AzureCognitiveSearchQueryType(string value) { throw null; }
+        public static Azure.AI.OpenAI.AzureCognitiveSearchQueryType Semantic { get { throw null; } }
+        public static Azure.AI.OpenAI.AzureCognitiveSearchQueryType Simple { get { throw null; } }
+        public static Azure.AI.OpenAI.AzureCognitiveSearchQueryType Vector { get { throw null; } }
+        public static Azure.AI.OpenAI.AzureCognitiveSearchQueryType VectorSemanticHybrid { get { throw null; } }
+        public static Azure.AI.OpenAI.AzureCognitiveSearchQueryType VectorSimpleHybrid { get { throw null; } }
+        public bool Equals(Azure.AI.OpenAI.AzureCognitiveSearchQueryType other) { throw null; }
+        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
+        public override bool Equals(object obj) { throw null; }
+        [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
+        public override int GetHashCode() { throw null; }
+        public static bool operator ==(Azure.AI.OpenAI.AzureCognitiveSearchQueryType left, Azure.AI.OpenAI.AzureCognitiveSearchQueryType right) { throw null; }
+        public static implicit operator Azure.AI.OpenAI.AzureCognitiveSearchQueryType (string value) { throw null; }
+        public static bool operator !=(Azure.AI.OpenAI.AzureCognitiveSearchQueryType left, Azure.AI.OpenAI.AzureCognitiveSearchQueryType right) { throw null; }
+        public override string ToString() { throw null; }
+    }
     public static partial class AzureOpenAIModelFactory
     {
         public static Azure.AI.OpenAI.ChatChoice ChatChoice(Azure.AI.OpenAI.ChatMessage message = null, int index = 0, Azure.AI.OpenAI.CompletionsFinishReason finishReason = default(Azure.AI.OpenAI.CompletionsFinishReason), Azure.AI.OpenAI.ChatMessage deltaMessage = null, Azure.AI.OpenAI.ContentFilterResults contentFilterResults = null) { throw null; }
@@ -13,8 +94,8 @@ public static partial class AzureOpenAIModelFactory
         public static Azure.AI.OpenAI.EmbeddingItem EmbeddingItem(System.Collections.Generic.IEnumerable<float> embedding = null, 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.InternalImageLocation> data = null) { throw null; }
-        public static Azure.AI.OpenAI.InternalImageLocation InternalImageLocation(System.Uri url = null) { 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; }
+        public static Azure.AI.OpenAI.ImageLocation ImageLocation(System.Uri url = null) { throw null; }
         public static Azure.AI.OpenAI.PromptFilterResult PromptFilterResult(int promptIndex = 0, Azure.AI.OpenAI.ContentFilterResults contentFilterResults = null) { throw null; }
         public static Azure.AI.OpenAI.StreamingChatChoice StreamingChatChoice(Azure.AI.OpenAI.ChatChoice originalBaseChoice = null) { throw null; }
         public static Azure.AI.OpenAI.StreamingChatCompletions StreamingChatCompletions(Azure.AI.OpenAI.ChatCompletions baseChatCompletions = null, System.Collections.Generic.List<Azure.AI.OpenAI.StreamingChatChoice> streamingChatChoices = null) { throw null; }
@@ -42,6 +123,7 @@ public partial class ChatCompletionsOptions
     {
         public ChatCompletionsOptions() { }
         public ChatCompletionsOptions(System.Collections.Generic.IEnumerable<Azure.AI.OpenAI.ChatMessage> messages) { }
+        public Azure.AI.OpenAI.AzureChatExtensionsOptions AzureExtensionsOptions { get { throw null; } set { } }
         public int? ChoiceCount { get { throw null; } set { } }
         public float? FrequencyPenalty { get { throw null; } set { } }
         public Azure.AI.OpenAI.FunctionDefinition FunctionCall { get { throw null; } set { } }
@@ -59,6 +141,7 @@ public partial class ChatMessage
     {
         public ChatMessage() { }
         public ChatMessage(Azure.AI.OpenAI.ChatRole role, string content) { }
+        public Azure.AI.OpenAI.AzureChatExtensionsMessageContext AzureExtensionsContext { get { throw null; } set { } }
         public string Content { get { throw null; } set { } }
         public Azure.AI.OpenAI.FunctionCall FunctionCall { get { throw null; } set { } }
         public string Name { get { throw null; } set { } }
@@ -73,6 +156,7 @@ public ChatMessage(Azure.AI.OpenAI.ChatRole role, string content) { }
         public static Azure.AI.OpenAI.ChatRole Assistant { get { throw null; } }
         public static Azure.AI.OpenAI.ChatRole Function { get { throw null; } }
         public static Azure.AI.OpenAI.ChatRole System { get { throw null; } }
+        public static Azure.AI.OpenAI.ChatRole Tool { get { throw null; } }
         public static Azure.AI.OpenAI.ChatRole User { get { throw null; } }
         public bool Equals(Azure.AI.OpenAI.ChatRole other) { throw null; }
         [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
@@ -244,7 +328,12 @@ public partial class ImageGenerations
     {
         internal ImageGenerations() { }
         public System.DateTimeOffset Created { get { throw null; } }
-        public System.Collections.Generic.IReadOnlyList<Azure.AI.OpenAI.InternalImageLocation> Data { get { throw null; } }
+        public System.Collections.Generic.IReadOnlyList<Azure.AI.OpenAI.ImageLocation> Data { get { throw null; } }
+    }
+    public partial class ImageLocation
+    {
+        internal ImageLocation() { }
+        public System.Uri Url { get { throw null; } }
     }
     [System.Runtime.InteropServices.StructLayoutAttribute(System.Runtime.InteropServices.LayoutKind.Sequential)]
     public readonly partial struct ImageSize : System.IEquatable<Azure.AI.OpenAI.ImageSize>
@@ -265,11 +354,6 @@ internal ImageGenerations() { }
         public static bool operator !=(Azure.AI.OpenAI.ImageSize left, Azure.AI.OpenAI.ImageSize right) { throw null; }
         public override string ToString() { throw null; }
     }
-    public partial class InternalImageLocation
-    {
-        internal InternalImageLocation() { }
-        public System.Uri Url { get { throw null; } }
-    }
     public partial class OpenAIClient
     {
         protected OpenAIClient() { }
@@ -297,13 +381,14 @@ public OpenAIClient(System.Uri endpoint, Azure.Core.TokenCredential tokenCredent
     }
     public partial class OpenAIClientOptions : Azure.Core.ClientOptions
     {
-        public OpenAIClientOptions(Azure.AI.OpenAI.OpenAIClientOptions.ServiceVersion version = Azure.AI.OpenAI.OpenAIClientOptions.ServiceVersion.V2023_07_01_Preview) { }
+        public OpenAIClientOptions(Azure.AI.OpenAI.OpenAIClientOptions.ServiceVersion version = Azure.AI.OpenAI.OpenAIClientOptions.ServiceVersion.V2023_08_01_Preview) { }
         public enum ServiceVersion
         {
             V2022_12_01 = 1,
             V2023_05_15 = 2,
             V2023_06_01_Preview = 3,
             V2023_07_01_Preview = 4,
+            V2023_08_01_Preview = 5,
         }
     }
     public partial class PromptFilterResult

sdk/openai/Azure.AI.OpenAI/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "net",
   "TagPrefix": "net/openai/Azure.AI.OpenAI",
-  "Tag": "net/openai/Azure.AI.OpenAI_2732937895"
+  "Tag": "net/openai/Azure.AI.OpenAI_a0250cd0f1"
 }

sdk/openai/Azure.AI.OpenAI/src/Custom/AzureChatExtensionConfiguration.cs

@@ -0,0 +1,61 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated/>
+
+#nullable disable
+
+using System;
+using Azure.Core;
+
+namespace Azure.AI.OpenAI
+{
+    public partial class AzureChatExtensionConfiguration
+    {
+        // CUSTOM CODE NOTE: required properties are moved here to support an init-only default constructor pattern.
+
+        /// <summary> Initializes a new instance of AzureChatExtensionConfiguration. </summary>
+        public AzureChatExtensionConfiguration()
+        {
+        }
+
+        /// <summary>
+        ///   The label for the type of an Azure chat extension. This typically corresponds to a matching Azure resource.
+        ///   Azure chat extensions are only compatible with Azure OpenAI.
+        /// </summary>
+        public virtual AzureChatExtensionType Type { get; set; }
+        /// <summary>
+        ///   The configuration payload used for the Azure chat extension. The structure payload details are specific to the
+        ///   extension being configured.
+        ///   Azure chat extensions are only compatible with Azure OpenAI.
+        /// <para>
+        /// To assign an object to this property use <see cref="BinaryData.FromObjectAsJson{T}(T, System.Text.Json.JsonSerializerOptions?)"/>.
+        /// </para>
+        /// <para>
+        /// To assign an already formated json string to this property use <see cref="BinaryData.FromString(string)"/>.
+        /// </para>
+        /// <para>
+        /// Examples:
+        /// <list type="bullet">
+        /// <item>
+        /// <term>BinaryData.FromObjectAsJson("foo")</term>
+        /// <description>Creates a payload of "foo".</description>
+        /// </item>
+        /// <item>
+        /// <term>BinaryData.FromString("\"foo\"")</term>
+        /// <description>Creates a payload of "foo".</description>
+        /// </item>
+        /// <item>
+        /// <term>BinaryData.FromObjectAsJson(new { key = "value" })</term>
+        /// <description>Creates a payload of { "key": "value" }.</description>
+        /// </item>
+        /// <item>
+        /// <term>BinaryData.FromString("{\"key\": \"value\"}")</term>
+        /// <description>Creates a payload of { "key": "value" }.</description>
+        /// </item>
+        /// </list>
+        /// </para>
+        /// </summary>
+        public BinaryData Parameters { get; set; }
+    }
+}

sdk/openai/Azure.AI.OpenAI/src/Custom/AzureChatExtensionsOptions.Serialization.cs

@@ -0,0 +1,27 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated/>
+
+#nullable disable
+
+using System.Text.Json;
+using Azure.Core;
+
+namespace Azure.AI.OpenAI
+{
+    public partial class AzureChatExtensionsOptions : IUtf8JsonSerializable
+    {
+        void IUtf8JsonSerializable.Write(Utf8JsonWriter writer)
+        {
+            // CUSTOM CODE NOTE: dataSources deserialize directly into the parent options payload.
+            writer.WritePropertyName("dataSources");
+            writer.WriteStartArray();
+            foreach (AzureChatExtensionConfiguration dataSource in Extensions)
+            {
+                (dataSource as IUtf8JsonSerializable).Write(writer);
+            }
+            writer.WriteEndArray();
+        }
+    }
+}

sdk/openai/Azure.AI.OpenAI/src/Custom/AzureChatExtensionsOptions.cs

@@ -0,0 +1,37 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated/>
+
+#nullable disable
+
+using System.Collections.Generic;
+
+namespace Azure.AI.OpenAI
+{
+    /// <summary>
+    /// An abstraction of additional settings used by chat completions to supplement standard behavior with
+    /// capabilities from configured Azure OpenAI extensions. These capabilities are specific to Azure OpenAI
+    /// and chat completions requests configured to use them will require use with with that service endpoint.
+    /// </summary>
+    public partial class AzureChatExtensionsOptions
+    {
+        // CUSTOM CODE NOTE: this wrapper type for /extensions/chat/completions data sources is currently "client
+        //                      only" and not yet reflected in the REST wire format. This will likely converge in
+        //                      future versions but for exists outside of code generation.
+
+        /// <summary>
+        /// Gets the collection of data source configurations to use with Azure OpenAI extensions for chat
+        /// completions.
+        /// </summary>
+        public IList<AzureChatExtensionConfiguration> Extensions { get; }
+
+        /// <summary>
+        /// Instantiates a new instance of AzureChatExtensionsOptions.
+        /// </summary>
+        public AzureChatExtensionsOptions()
+        {
+            Extensions = new List<AzureChatExtensionConfiguration>();
+        }
+    }
+}