[OpenAI] Support Top Logprob in Chat Completions

sdk/openai/openai/CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Features Added
 
 - Create a new `OpenAIError` model to represent the error model returned.
+- Adds support for `logprobs` and `topLogprobs` in `GetChatCompletionsOptions` to support log probabilities for chat completions.
 
 ### Bugs Fixed
 

sdk/openai/openai/assets.json

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

sdk/openai/openai/review/openai-models.api.md

@@ -661,6 +661,7 @@ export interface GetChatCompletionsOptions extends OperationOptions {
     functionCall?: FunctionCallPreset | FunctionName;
     functions?: FunctionDefinition[];
     logitBias?: Record<string, number>;
+    logprobs?: boolean;
     maxTokens?: number;
     n?: number;
     presencePenalty?: number;
@@ -670,6 +671,7 @@ export interface GetChatCompletionsOptions extends OperationOptions {
     temperature?: number;
     toolChoice?: ChatCompletionsNamedToolSelectionUnion;
     tools?: ChatCompletionsToolDefinitionUnion[];
+    topLogprobs?: number;
     topP?: number;
     user?: string;
 }

sdk/openai/openai/review/openai.api.md

@@ -626,6 +626,7 @@ export interface GetChatCompletionsOptions extends OperationOptions {
     functionCall?: FunctionCallPreset | FunctionName;
     functions?: FunctionDefinition[];
     logitBias?: Record<string, number>;
+    logprobs?: boolean;
     maxTokens?: number;
     n?: number;
     presencePenalty?: number;
@@ -635,6 +636,7 @@ export interface GetChatCompletionsOptions extends OperationOptions {
     temperature?: number;
     toolChoice?: ChatCompletionsNamedToolSelectionUnion;
     tools?: ChatCompletionsToolDefinitionUnion[];
+    topLogprobs?: number;
     topP?: number;
     user?: string;
 }

sdk/openai/openai/samples-dev/audioTranscription.ts

@@ -33,5 +33,5 @@ export async function main() {
 }
 
 main().catch((err) => {
-  parseOpenAIError(err)
+  parseOpenAIError(err);
 });

sdk/openai/openai/samples-dev/audioTranslation.ts

@@ -33,5 +33,5 @@ export async function main() {
 }
 
 main().catch((err) => {
-  parseOpenAIError(err)
+  parseOpenAIError(err);
 });

sdk/openai/openai/samples-dev/bringYourOwnData.ts

@@ -68,5 +68,5 @@ export async function main() {
 }
 
 main().catch((err) => {
-  parseOpenAIError(err)
+  parseOpenAIError(err);
 });

sdk/openai/openai/samples-dev/chatCompletions.ts

@@ -37,6 +37,5 @@ export async function main() {
 }
 
 main().catch((err) => {
-  parseOpenAIError(err)
+  parseOpenAIError(err);
 });
-

sdk/openai/openai/samples-dev/completions.ts

@@ -34,5 +34,5 @@ export async function main() {
 }
 
 main().catch((err) => {
-  parseOpenAIError(err)
+  parseOpenAIError(err);
 });

sdk/openai/openai/samples-dev/getEmbeddings.ts

@@ -37,5 +37,5 @@ export async function main() {
 }
 
 main().catch((err) => {
-  parseOpenAIError(err)
+  parseOpenAIError(err);
 });

sdk/openai/openai/samples-dev/getImages.ts

@@ -39,5 +39,5 @@ export async function main() {
 }
 
 main().catch((err) => {
-  parseOpenAIError(err)
+  parseOpenAIError(err);
 });

sdk/openai/openai/samples-dev/openAi.ts

@@ -34,5 +34,5 @@ export async function main() {
 }
 
 main().catch((err) => {
-  parseOpenAIError(err)
+  parseOpenAIError(err);
 });

sdk/openai/openai/samples-dev/streamChatCompletions.ts

@@ -43,5 +43,5 @@ export async function main() {
 }
 
 main().catch((err) => {
-  parseOpenAIError(err)
+  parseOpenAIError(err);
 });

sdk/openai/openai/samples-dev/streamChatCompletionsWithContentFilter.ts

@@ -64,5 +64,5 @@ export async function main() {
 }
 
 main().catch((err) => {
-  parseOpenAIError(err)
+  parseOpenAIError(err);
 });

sdk/openai/openai/samples-dev/streamCompletions.ts

@@ -36,5 +36,5 @@ export async function main() {
 }
 
 main().catch((err) => {
-  parseOpenAIError(err)
+  parseOpenAIError(err);
 });

sdk/openai/openai/samples-dev/toolCall.ts

@@ -62,5 +62,5 @@ export async function main() {
 }
 
 main().catch((err) => {
-  parseOpenAIError(err)
+  parseOpenAIError(err);
 });

sdk/openai/openai/src/models/options.ts

@@ -233,4 +233,14 @@ export interface GetChatCompletionsOptions extends OperationOptions {
    *   This additional specification is only compatible with Azure OpenAI.
    */
   azureExtensionOptions?: AzureExtensionsOptions;
+  /**
+   * Whether to return log probabilities of the output tokens. If true, the log probabilities of
+   * each output token are returned in the `content` of `message`.
+   */
+  logprobs?: boolean;
+  /**
+   * An integer between 0 and 5 specifying the number of most likely tokens to return at each token position,
+   * each with an associated log probability. `logprobs` must be set to `true` if this parameter is used.
+   */
+  topLogprobs?: number;
 }

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

@@ -465,6 +465,35 @@ describe("OpenAI", function () {
               authMethod,
             );
           });
+
+          it("returns log prob information", async function () {
+            updateWithSucceeded(
+              await withDeployments(
+                getSucceeded(
+                  authMethod,
+                  deployments,
+                  models,
+                  chatCompletionDeployments,
+                  chatCompletionModels,
+                ),
+                (deploymentName) =>
+                  client.getChatCompletions(
+                    deploymentName,
+                    [{ role: "user", content: "What's the weather like in Boston?" }],
+                    {
+                      logprobs: true,
+                      topLogprobs: 3,
+                    },
+                  ),
+                (result) => {
+                  assertChatCompletions(result);
+                },
+              ),
+              chatCompletionDeployments,
+              chatCompletionModels,
+              authMethod,
+            );
+          });
         });
 
         describe("streamChatCompletions", function () {

sdk/openai/openai/test/public/utils/asserts.ts

@@ -21,6 +21,8 @@ import {
   ChatCompletionsToolCallUnion,
   ChatFinishDetails,
   ChatResponseMessage,
+  ChatTokenLogProbabilityInfo,
+  ChatTokenLogProbabilityResult,
   Choice,
   Completions,
   CompletionsLogProbabilityModel,
@@ -277,12 +279,29 @@ function assertChatChoice(choice: ChatChoice, options: ChatCompletionTestOptions
     assert.isUndefined(choice.delta);
   }
   assert.isNumber(choice.index);
+  ifDefined(choice.logprobs?.content, (content) =>
+    assertNonEmptyArray(content, assertLogprobResult),
+  );
   ifDefined(choice.contentFilterResults, assertContentFilterResultsForChoice);
   ifDefined(choice.finishReason, assert.isString);
   ifDefined(choice.finishDetails, assertChatFinishDetails);
   ifDefined(choice.enhancements, assertAzureChatEnhancements);
 }
 
+function assertLogprobResult(logprobResult: ChatTokenLogProbabilityResult): void {
+  assert.isNumber(logprobResult.logprob);
+  assert.isString(logprobResult.token);
+  ifDefined(logprobResult.bytes, (bytes) => assertNonEmptyArray(bytes, assert.isNumber));
+  ifDefined(logprobResult.topLogprobs, (topLogprobs) =>
+    assertNonEmptyArray(topLogprobs, assertTokenLogProbInfo),
+  );
+}
+
+function assertTokenLogProbInfo(tokenLogprobInfo: ChatTokenLogProbabilityInfo): void {
+  ifDefined(tokenLogprobInfo.bytes, (bytes) => assertNonEmptyArray(bytes, assert.isNumber));
+  assert.isNumber(tokenLogprobInfo.logprob);
+  assert.isString(tokenLogprobInfo.token);
+}
 function assertUsage(usage: CompletionsUsage | undefined): void {
   assert.isDefined(usage);
   const castUsage = usage as CompletionsUsage;