[OpenAI] Deserialize Chat Message Request (Azure#27138)

Author: minhanh-phan

sdk/openai/openai/CHANGELOG.md

@@ -13,6 +13,7 @@
 - Returns `usage` information when available.
 - Fixes a bug where errors weren't properly being thrown from the streaming methods.
 - Returns `error` information in `ContentFilterResults` when available.
+- Fixes parsing of `functionCall` in `ChatMessage` objects.
 
 ## 1.0.0-beta.5 (2023-08-25)
 

sdk/openai/openai/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "js",
   "TagPrefix": "js/openai/openai",
-  "Tag": "js/openai/openai_85d9317957"
+  "Tag": "js/openai/openai_d3a9528d70"
 }

sdk/openai/openai/sources/customizations/api/operations.ts

@@ -7,11 +7,13 @@ import {
   ImageGenerations,
   ImageLocation,
 } from "../../generated/src/models/models.js";
-import { GetCompletionsOptions } from "../../generated/src/models/options.js";
+import {
+  GetChatCompletionsWithAzureExtensionsOptions,
+  GetCompletionsOptions,
+  GetChatCompletionsOptions as GeneratedGetChatCompletionsOptions,
+} from "../../generated/src/models/options.js";
 import {
   _getCompletionsSend,
-  _getChatCompletionsSend,
-  _getChatCompletionsWithAzureExtensionsSend,
   _beginAzureBatchImageGenerationSend,
 } from "../../generated/src/api/operations.js";
 import { getOaiSSEs } from "./oaiSse.js";
@@ -20,14 +22,17 @@ import {
   BeginAzureBatchImageGenerationDefaultResponse,
   BeginAzureBatchImageGenerationLogicalResponse,
   OpenAIContext as Client,
+  GetChatCompletions200Response,
+  GetChatCompletionsDefaultResponse,
   GetChatCompletionsWithAzureExtensions200Response,
   GetChatCompletionsWithAzureExtensionsDefaultResponse,
   ImageGenerationsOutput,
   ImagePayloadOutput,
   getLongRunningPoller,
   isUnexpected,
+  ChatMessage as GeneratedChatMessage,
 } from "../../generated/src/rest/index.js";
-import { StreamableMethod } from "@azure-rest/core-client";
+import { StreamableMethod, operationOptionsToRequestParameters } from "@azure-rest/core-client";
 import { ChatCompletions } from "../models/models.js";
 import { getChatCompletionsResult, getCompletionsResult } from "./deserializers.js";
 import { GetChatCompletionsOptions } from "./models.js";
@@ -287,3 +292,74 @@ export async function getAudioTranscription<Format extends AudioResultFormat>(
     ? body
     : (renameKeysToCamelCase(body) as AudioResult<Format>);
 }
+
+export function _getChatCompletionsWithAzureExtensionsSend(
+  context: Client,
+  messages: ChatMessage[],
+  deploymentId: string,
+  options: GetChatCompletionsWithAzureExtensionsOptions = { requestOptions: {} }
+): StreamableMethod<
+  | GetChatCompletionsWithAzureExtensions200Response
+  | GetChatCompletionsWithAzureExtensionsDefaultResponse
+> {
+  return context
+    .path("/deployments/{deploymentId}/extensions/chat/completions", deploymentId)
+    .post({
+      ...operationOptionsToRequestParameters(options),
+      body: {
+        messages: parseChatMessage(messages),
+        functions: options?.functions,
+        function_call: options?.functionCall,
+        max_tokens: options?.maxTokens,
+        temperature: options?.temperature,
+        top_p: options?.topP,
+        logit_bias: options?.logitBias,
+        user: options?.user,
+        n: options?.n,
+        stop: options?.stop,
+        presence_penalty: options?.presencePenalty,
+        frequency_penalty: options?.frequencyPenalty,
+        stream: options?.stream,
+        model: options?.model,
+        dataSources: options?.dataSources,
+      },
+    });
+}
+
+export function _getChatCompletionsSend(
+  context: Client,
+  messages: ChatMessage[],
+  deploymentId: string,
+  options: GeneratedGetChatCompletionsOptions = { requestOptions: {} }
+): StreamableMethod<GetChatCompletions200Response | GetChatCompletionsDefaultResponse> {
+  return context.path("/deployments/{deploymentId}/chat/completions", deploymentId).post({
+    ...operationOptionsToRequestParameters(options),
+    body: {
+      messages: parseChatMessage(messages),
+      functions: options?.functions,
+      function_call: options?.functionCall,
+      max_tokens: options?.maxTokens,
+      temperature: options?.temperature,
+      top_p: options?.topP,
+      logit_bias: options?.logitBias,
+      user: options?.user,
+      n: options?.n,
+      stop: options?.stop,
+      presence_penalty: options?.presencePenalty,
+      frequency_penalty: options?.frequencyPenalty,
+      stream: options?.stream,
+      model: options?.model,
+      dataSources: options?.dataSources,
+    },
+  });
+}
+
+function parseChatMessage(messages: ChatMessage[]): GeneratedChatMessage[] {
+  return messages.map((p: ChatMessage) => ({
+    role: p.role,
+    content: p.content ?? null,
+    name: p.name,
+    function_call: p.functionCall,
+    context: p.context,
+  }));
+}

sdk/openai/openai/src/api/operations.ts

@@ -29,6 +29,7 @@ import {
   BeginAzureBatchImageGeneration202Response,
   BeginAzureBatchImageGenerationDefaultResponse,
   BeginAzureBatchImageGenerationLogicalResponse,
+  ChatMessage as GeneratedChatMessage,
   OpenAIContext as Client,
   GetChatCompletions200Response,
   GetChatCompletionsDefaultResponse,
@@ -241,7 +242,7 @@ export function _getChatCompletionsSend(
   return context.path("/deployments/{deploymentId}/chat/completions", deploymentId).post({
     ...operationOptionsToRequestParameters(options),
     body: {
-      messages: messages,
+      messages: parseChatMessage(messages),
       functions: options?.functions,
       function_call: options?.functionCall,
       max_tokens: options?.maxTokens,
@@ -376,7 +377,7 @@ export function _getChatCompletionsWithAzureExtensionsSend(
     .post({
       ...operationOptionsToRequestParameters(options),
       body: {
-        messages: messages,
+        messages: parseChatMessage(messages),
         functions: options?.functions,
         function_call: options?.functionCall,
         max_tokens: options?.maxTokens,
@@ -786,3 +787,13 @@ export async function getAudioTranscription<Format extends AudioResultFormat>(
     ? body
     : (renameKeysToCamelCase(body) as AudioResult<Format>);
 }
+
+function parseChatMessage(messages: ChatMessage[]): GeneratedChatMessage[] {
+  return messages.map((p: ChatMessage) => ({
+    role: p.role,
+    content: p.content ?? null,
+    name: p.name,
+    function_call: p.functionCall,
+    context: p.context,
+  }));
+}

sdk/openai/openai/test/public/node/whisper.spec.ts

@@ -19,7 +19,7 @@ function getModel(authMethod: AuthMethod): string {
 }
 
 describe("OpenAI", function () {
-  matrix([["AzureAPIKey", "OpenAIKey"]] as const, async function (authMethod: AuthMethod) {
+  matrix([["AzureAPIKey", "OpenAIKey", "AAD"]] as const, async function (authMethod: AuthMethod) {
     describe(`[${authMethod}] Client`, () => {
       let recorder: Recorder;
       let client: OpenAIClient;

sdk/openai/openai/test/public/openai.spec.ts

@@ -22,7 +22,7 @@ import {
 } from "./utils/utils.js";
 import { createHttpHeaders, createPipelineRequest } from "@azure/core-rest-pipeline";
 import { getImageDimensions } from "./utils/getImageDimensions.js";
-import { OpenAIClient, ImageLocation } from "../../src/index.js";
+import { OpenAIClient, ImageLocation, ChatMessage } from "../../src/index.js";
 
 describe("OpenAI", function () {
   let recorder: Recorder;
@@ -158,7 +158,6 @@ describe("OpenAI", function () {
               "What's the most common feedback we received from our customers about the product?",
           },
         ];
-        const weatherMessages = [{ role: "user", content: "What's the weather like in Boston?" }];
         const getCurrentWeather = {
           name: "get_current_weather",
           description: "Get the current weather in a given location",
@@ -210,11 +209,33 @@ describe("OpenAI", function () {
                   chatCompletionDeployments,
                   chatCompletionModels
                 ),
-                async (deploymentName) =>
-                  client.getChatCompletions(deploymentName, weatherMessages, {
+                async (deploymentName) => {
+                  const weatherMessages: ChatMessage[] = [
+                    { role: "user", content: "What's the weather like in Boston?" },
+                  ];
+                  const result = await client.getChatCompletions(deploymentName, weatherMessages, {
                     functions: [getCurrentWeather],
-                  }),
-                (c) => assertChatCompletions(c, { functions: true })
+                  });
+                  assertChatCompletions(result, { functions: true });
+                  const responseMessage = result.choices[0].message;
+                  if (!responseMessage?.functionCall) {
+                    assert.fail("Undefined function call");
+                  }
+                  const functionArgs = JSON.parse(responseMessage.functionCall.arguments);
+                  weatherMessages.push(responseMessage);
+                  weatherMessages.push({
+                    role: "function",
+                    name: responseMessage.functionCall.name,
+                    content: JSON.stringify({
+                      location: functionArgs.location,
+                      temperature: "72",
+                      unit: functionArgs.unit,
+                      forecast: ["sunny", "windy"],
+                    }),
+                  });
+                  return client.getChatCompletions(deploymentName, weatherMessages);
+                },
+                (result) => assertChatCompletions(result, { functions: true })
               ),
               chatCompletionDeployments,
               chatCompletionModels,
@@ -289,6 +310,9 @@ describe("OpenAI", function () {
           });
 
           it("calls functions", async function () {
+            const weatherMessages: ChatMessage[] = [
+              { role: "user", content: "What's the weather like in Boston?" },
+            ];
             updateWithSucceeded(
               await withDeployments(
                 getSucceeded(