[OpenAI] Update README (#25947)

Per feedback from @achandmsft

Author: deyaaeldeen

common/tools/dev-tool/src/commands/run/testNodeJSInput.ts

@@ -2,6 +2,7 @@
 // Licensed under the MIT license
 
 import { leafCommand, makeCommandInfo } from "../../framework/command";
+import { resolveProject } from "../../util/resolveProject";
 import { runTestsWithProxyTool } from "../../util/testUtils";
 
 export const commandInfo = makeCommandInfo(
@@ -10,8 +11,11 @@ export const commandInfo = makeCommandInfo(
 );
 
 export default leafCommand(commandInfo, async (options) => {
+  const projectInfo = await resolveProject(process.cwd());
   const defaultMochaArgs =
-    "-r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --full-trace";
+    `${
+      projectInfo.packageJson.type === "module" ? "" : "-r esm "
+    } --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --full-trace`;
   const updatedArgs = options["--"]?.map((opt) =>
     opt.includes("**") && !opt.startsWith("'") && !opt.startsWith('"') ? `"${opt}"` : opt
   );

sdk/openai/openai/README.md

@@ -12,6 +12,12 @@ Use the client library for Azure OpenAI to:
 
 Azure OpenAI is a managed service that allows developers to deploy, tune, and generate content from OpenAI models on Azure resources.
 
+Checkout the following examples:
+
+- [Multiple Completions](#generate-multiple-completions-with-subscription-key)
+- [Chatbot](#generate-chatbot-response)
+- [Summarize Text](#summarize-text-with-completion)
+
 Key links:
 
 - [Source code](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/openai/openai)
@@ -135,22 +141,35 @@ You can familiarize yourself with different APIs using [Samples](https://github.
 
 ### Generate Chatbot Response
 
-This example authenticates using a DefaultAzureCredential, then generates text responses to input prompts.
+This example authenticates using a DefaultAzureCredential, then generates chat responses to input chat question and messages.
 
 ```javascript
 const endpoint = "https://myaccount.openai.azure.com/";
 const client = new OpenAIClient(endpoint, new DefaultAzureCredential());
 
-const deploymentName = "text-davinci-003";
-const prompt = ["What is Azure OpenAI?"];
-console.log(`Input: ${prompt}`);
+const deploymentId = "gpt-35-turbo";
 
-const { choices } = await client.getCompletions(deploymentName, prompt);
-const completion = choices[0].text;
-console.log(`Chatbot: ${completion}`);
+const messages = [
+  { role: "system", content: "You are a helpful assistant. You will talk like a pirate." },
+  { role: "user", content: "Can you help me?" },
+  { role: "assistant", content: "Arrrr! Of course, me hearty! What can I do for ye?" },
+  { role: "user", content: "What's the best way to train a parrot?" },
+];
+
+console.log(`Messages: ${messages.map((m) => m.content).join("\n")}`);
+
+const events = await client.listChatCompletions(deploymentId, messages, { maxTokens: 128 });
+for await (const event of events) {
+  for (const choice of event.choices) {
+    const delta = choice.delta?.content;
+    if (delta !== undefined) {
+      console.log(`Chatbot: ${delta}`);
+    }
+  }
+}
 ```
 
-### Generate Multiple Chatbot Responses With Subscription Key
+### Generate Multiple Completions With Subscription Key
 
 This example generates text responses to input prompts using an Azure subscription key
 
@@ -208,7 +227,9 @@ console.log(`Input: ${summarizationPrompt}`);
 
 const deploymentName = "text-davinci-003";
 
-const { choices } = await client.getCompletions(deploymentName, summarizationPrompt);
+const { choices } = await client.getCompletions(deploymentName, examplePrompts, {
+  maxTokens: 64
+});
 const completion = choices[0].text;
 console.log(`Summarization: ${completion}`);
 ```
@@ -228,8 +249,8 @@ setLogLevel("info");
 For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).
 
 <!-- LINKS -->
-[msdocs_openai_completion]: https://learn.microsoft.com/azure/cognitive-services/openai/how-to/completions
-[msdocs_openai_chat_completion]: https://learn.microsoft.com/azure/cognitive-services/openai/how-to/chatgpt
+[msdocs_openai_completion]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/openai/openai/samples/v1-beta/javascript/completions.js
+[msdocs_openai_chat_completion]: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/openai/openai/samples/v1-beta/javascript/listChatCompletions.js
 [msdocs_openai_embedding]: https://learn.microsoft.com/azure/cognitive-services/openai/concepts/understand-embeddings
 [azure_openai_completions_docs]: https://learn.microsoft.com/azure/cognitive-services/openai/how-to/completions
 [defaultazurecredential]: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential

sdk/openai/openai/assets.json

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

sdk/openai/openai/package.json

@@ -44,8 +44,8 @@
     "execute:samples": "dev-tool samples run samples-dev",
     "extract-api": "tsc -p . && api-extractor run --local",
     "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"sources/customizations/**/*.ts\" \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
-    "integration-test:browser": "echo skipped",
-    "integration-test:node": "nyc mocha --timeout 600000 \"test/internal/**/*.spec.ts\" \"test/public/{,!(browser)/**/}*.spec.ts\"",
+    "integration-test:browser": "npm run unit-test:browser",
+    "integration-test:node": "dev-tool run test:node-js-input -- --timeout 5000000 \"dist-esm/test/**/*.spec.js\"",
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
     "lint:fix": "eslint README.md package.json api-extractor.json src test --ext .ts,.javascript,.js --fix --fix-type [problem,suggestion]",
     "lint": "eslint README.md package.json api-extractor.json src test --ext .ts,.javascript,.js",

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

@@ -25,16 +25,29 @@ describe("README samples", () => {
   });
 
   it("Generate Chatbot Response", async function () {
-    const deploymentName = "text-davinci-003";
-    const prompt = ["What is Azure OpenAI?"];
-    console.log(`Input: ${prompt}`);
+    const deploymentId = "gpt-35-turbo";
 
-    const { choices } = await client.getCompletions(deploymentName, prompt);
-    const completion = choices[0].text;
-    console.log(`Chatbot: ${completion}`);
+    const messages = [
+      { role: "system", content: "You are a helpful assistant. You will talk like a pirate." },
+      { role: "user", content: "Can you help me?" },
+      { role: "assistant", content: "Arrrr! Of course, me hearty! What can I do for ye?" },
+      { role: "user", content: "What's the best way to train a parrot?" },
+    ];
+
+    console.log(`Messages: ${messages.map((m) => m.content).join("\n")}`);
+
+    const events = await client.listChatCompletions(deploymentId, messages, { maxTokens: 128 });
+    for await (const event of events) {
+      for (const choice of event.choices) {
+        const delta = choice.delta?.content;
+        if (delta !== undefined) {
+          console.log(`Chatbot: ${delta}`);
+        }
+      }
+    }
   });
 
-  it("Generate Multiple Chatbot Responses", async function () {
+  it("Generate Multiple Completions", async function () {
     const examplePrompts = [
       "How are you today?",
       "What is Azure OpenAI?",
@@ -46,7 +59,9 @@ describe("README samples", () => {
     const deploymentName = "text-davinci-003";
 
     let promptIndex = 0;
-    const { choices } = await client.getCompletions(deploymentName, examplePrompts);
+    const { choices } = await client.getCompletions(deploymentName, examplePrompts, {
+      maxTokens: 64,
+    });
     for (const choice of choices) {
       const completion = choice.text;
       console.log(`Input: ${examplePrompts[promptIndex++]}`);