edits

Author: diberry

articles/ai-services/openai/includes/assistants-javascript.md

@@ -110,7 +110,7 @@ In our code we're going to specify the following values:
 
 An individual assistant can access up to 128 tools including `code interpreter`, and any custom tools you create via [functions](../how-to/assistant-functions.md).
 
-#### [TypeScript keyless (Recommended)](#tab/typescript-keyless)
+#### [TypeScript (Microsoft Entra ID)](#tab/typescript-keyless)
 
 1. Create the `index.ts` file with the following code:
 
@@ -244,76 +244,78 @@ An individual assistant can access up to 128 tools including `code interpreter`,
     node index.js
     ```
 
-#### [TypeScript with API key](#tab/typescript-key)
 
-1. Create the `index.ts` file with the following code:
+#### [JavaScript (Microsoft Entra ID)](#tab/javascript-keyless)
 
-    ```typescript
-    import { AzureOpenAI } from "openai";
-    import {
-      Assistant,
-      AssistantCreateParams,
-      AssistantTool,
-    } from "openai/resources/beta/assistants";
-    import { Message, MessagesPage } from "openai/resources/beta/threads/messages";
-    import { Run } from "openai/resources/beta/threads/runs/runs";
-    import { Thread } from "openai/resources/beta/threads/threads";
+1. Create the `index.js` file with the following code:
+
+    ```javascript
+    const { AzureOpenAI } = require("openai");
+    const {
+      DefaultAzureCredential,
+      getBearerTokenProvider,
+    } = require("@azure/identity");
     
     // Get environment variables
-    const azureOpenAIKey = process.env.AZURE_OPENAI_KEY as string;
-    const azureOpenAIEndpoint = process.env.AZURE_OPENAI_ENDPOINT as string;
-    const azureOpenAIDeployment = process.env
-      .AZURE_OPENAI_DEPLOYMENT_NAME as string;
-    const openAIVersion = process.env.OPENAI_API_VERSION as string;
+    const azureOpenAIEndpoint = process.env.AZURE_OPENAI_ENDPOINT;
+    const azureOpenAIDeployment = process.env.AZURE_OPENAI_DEPLOYMENT_NAME;
+    const azureOpenAIVersion = process.env.OPENAI_API_VERSION;
     
     // Check env variables
-    if (!azureOpenAIKey || !azureOpenAIEndpoint || !azureOpenAIDeployment || !openAIVersion) {
+    if (!azureOpenAIEndpoint || !azureOpenAIDeployment || !azureOpenAIVersion) {
       throw new Error(
-        "Please set AZURE_OPENAI_KEY and AZURE_OPENAI_ENDPOINT and AZURE_OPENAI_DEPLOYMENT_NAME in your environment variables."
+        "Please ensure to set AZURE_OPENAI_DEPLOYMENT_NAME and AZURE_OPENAI_ENDPOINT in your environment variables."
       );
     }
     
     // Get Azure SDK client
-    const getClient = (): AzureOpenAI => {
+    const getClient = () => {
+      const credential = new DefaultAzureCredential();
+      const scope = "https://cognitiveservices.azure.com/.default";
+      const azureADTokenProvider = getBearerTokenProvider(credential, scope);
+
       const assistantsClient = new AzureOpenAI({
         endpoint: azureOpenAIEndpoint,
-        apiVersion: openAIVersion,
-        apiKey: azureOpenAIKey,
+        apiVersion: azureOpenAIVersion,
+        azureADTokenProvider,
       });
       return assistantsClient;
     };
     
     const assistantsClient = getClient();
     
-    const options: AssistantCreateParams = {
+    const options = {
       model: azureOpenAIDeployment, // Deployment name seen in Azure AI Studio
       name: "Math Tutor",
       instructions:
         "You are a personal math tutor. Write and run JavaScript code to answer math questions.",
-      tools: [{ type: "code_interpreter" } as AssistantTool],
+      tools: [{ type: "code_interpreter" }],
     };
     const role = "user";
     const message = "I need to solve the equation `3x + 11 = 14`. Can you help me?";
     
     // Create an assistant
-    const assistantResponse: Assistant =
-      await assistantsClient.beta.assistants.create(options);
+    const assistantResponse = await assistantsClient.beta.assistants.create(
+      options
+    );
     console.log(`Assistant created: ${JSON.stringify(assistantResponse)}`);
     
     // Create a thread
-    const assistantThread: Thread = await assistantsClient.beta.threads.create({});
+    const assistantThread = await assistantsClient.beta.threads.create({});
     console.log(`Thread created: ${JSON.stringify(assistantThread)}`);
     
     // Add a user question to the thread
-    const threadResponse: Message =
-      await assistantsClient.beta.threads.messages.create(assistantThread.id, {
+    const threadResponse = await assistantsClient.beta.threads.messages.create(
+      assistantThread.id,
+      {
         role,
         content: message,
-      });
+      }
+    );
     console.log(`Message created:  ${JSON.stringify(threadResponse)}`);
     
     // Run the thread and poll it until it is in a terminal state
-    const runResponse: Run = await assistantsClient.beta.threads.runs.createAndPoll(
+    const runResponse = await assistantsClient.beta.threads.runs.createAndPoll(
       assistantThread.id,
       {
         assistant_id: assistantResponse.id,
@@ -323,8 +325,9 @@ An individual assistant can access up to 128 tools including `code interpreter`,
     console.log(`Run created:  ${JSON.stringify(runResponse)}`);
     
     // Get the messages
-    const runMessages: MessagesPage =
-      await assistantsClient.beta.threads.messages.list(assistantThread.id);
+    const runMessages = await assistantsClient.beta.threads.messages.list(
+      assistantThread.id
+    );
     for await (const runMessageDatum of runMessages) {
       for (const item of runMessageDatum.content) {
         // types are: "image_file" or "text"
@@ -334,107 +337,90 @@ An individual assistant can access up to 128 tools including `code interpreter`,
       }
     }
     ```
-    
 
-1. Create the `tsconfig.json` file to transpile the TypeScript code and copy the following code for ECMAScript.
-
-    ```json
-    {
-        "compilerOptions": {
-          "module": "NodeNext",
-          "target": "ES2022", // Supports top-level await
-          "moduleResolution": "NodeNext",
-          "skipLibCheck": true, // Avoid type errors from node_modules
-          "strict": true // Enable strict type-checking options
-        },
-        "include": ["*.ts"]
-    }
-    ```
-
-1. Transpile from TypeScript to JavaScript.
+1. Sign in to Azure with the following command:
 
     ```shell
-    tsc
+    az login
     ```
 
-1. Run the code with the following command:
+1. Run the JavaScript file.
 
     ```shell
     node index.js
     ```
 
-#### [JavaScript keyless](#tab/javascript-keyless)
 
-1. Create the `index.js` file with the following code:
+#### [TypeScript with API key](#tab/typescript-key)
 
-    ```nodejs
+1. Create the `index.ts` file with the following code:
+
+    ```typescript
     import { AzureOpenAI } from "openai";
-    
-    // Add `Cognitive Services User` to identity for Azure OpenAI resource
     import {
-      DefaultAzureCredential,
-      getBearerTokenProvider,
-    } from "@azure/identity";
+      Assistant,
+      AssistantCreateParams,
+      AssistantTool,
+    } from "openai/resources/beta/assistants";
+    import { Message, MessagesPage } from "openai/resources/beta/threads/messages";
+    import { Run } from "openai/resources/beta/threads/runs/runs";
+    import { Thread } from "openai/resources/beta/threads/threads";
     
     // Get environment variables
-    const azureOpenAIEndpoint = process.env.AZURE_OPENAI_ENDPOINT;
-    const azureOpenAIDeployment = process.env.AZURE_OPENAI_DEPLOYMENT_NAME;
-    const azureOpenAIVersion = process.env.OPENAI_API_VERSION;
+    const azureOpenAIKey = process.env.AZURE_OPENAI_KEY as string;
+    const azureOpenAIEndpoint = process.env.AZURE_OPENAI_ENDPOINT as string;
+    const azureOpenAIDeployment = process.env
+      .AZURE_OPENAI_DEPLOYMENT_NAME as string;
+    const openAIVersion = process.env.OPENAI_API_VERSION as string;
     
     // Check env variables
-    if (!azureOpenAIEndpoint || !azureOpenAIDeployment || !azureOpenAIVersion) {
+    if (!azureOpenAIKey || !azureOpenAIEndpoint || !azureOpenAIDeployment || !openAIVersion) {
       throw new Error(
-        "Please ensure to set AZURE_OPENAI_DEPLOYMENT_NAME and AZURE_OPENAI_ENDPOINT in your environment variables."
+        "Please set AZURE_OPENAI_KEY and AZURE_OPENAI_ENDPOINT and AZURE_OPENAI_DEPLOYMENT_NAME in your environment variables."
       );
     }
     
     // Get Azure SDK client
-    const getClient = () => {
-      const credential = new DefaultAzureCredential();
-      const scope = "https://cognitiveservices.azure.com/.default";
-      const azureADTokenProvider = getBearerTokenProvider(credential, scope);
+    const getClient = (): AzureOpenAI => {
       const assistantsClient = new AzureOpenAI({
         endpoint: azureOpenAIEndpoint,
-        apiVersion: azureOpenAIVersion,
-        azureADTokenProvider,
+        apiVersion: openAIVersion,
+        apiKey: azureOpenAIKey,
       });
       return assistantsClient;
     };
     
     const assistantsClient = getClient();
     
-    const options = {
+    const options: AssistantCreateParams = {
       model: azureOpenAIDeployment, // Deployment name seen in Azure AI Studio
       name: "Math Tutor",
       instructions:
         "You are a personal math tutor. Write and run JavaScript code to answer math questions.",
-      tools: [{ type: "code_interpreter" }],
+      tools: [{ type: "code_interpreter" } as AssistantTool],
     };
     const role = "user";
     const message = "I need to solve the equation `3x + 11 = 14`. Can you help me?";
     
     // Create an assistant
-    const assistantResponse = await assistantsClient.beta.assistants.create(
-      options
-    );
+    const assistantResponse: Assistant =
+      await assistantsClient.beta.assistants.create(options);
     console.log(`Assistant created: ${JSON.stringify(assistantResponse)}`);
     
     // Create a thread
-    const assistantThread = await assistantsClient.beta.threads.create({});
+    const assistantThread: Thread = await assistantsClient.beta.threads.create({});
     console.log(`Thread created: ${JSON.stringify(assistantThread)}`);
     
     // Add a user question to the thread
-    const threadResponse = await assistantsClient.beta.threads.messages.create(
-      assistantThread.id,
-      {
+    const threadResponse: Message =
+      await assistantsClient.beta.threads.messages.create(assistantThread.id, {
         role,
         content: message,
-      }
-    );
+      });
     console.log(`Message created:  ${JSON.stringify(threadResponse)}`);
     
     // Run the thread and poll it until it is in a terminal state
-    const runResponse = await assistantsClient.beta.threads.runs.createAndPoll(
+    const runResponse: Run = await assistantsClient.beta.threads.runs.createAndPoll(
       assistantThread.id,
       {
         assistant_id: assistantResponse.id,
@@ -444,9 +430,8 @@ An individual assistant can access up to 128 tools including `code interpreter`,
     console.log(`Run created:  ${JSON.stringify(runResponse)}`);
     
     // Get the messages
-    const runMessages = await assistantsClient.beta.threads.messages.list(
-      assistantThread.id
-    );
+    const runMessages: MessagesPage =
+      await assistantsClient.beta.threads.messages.list(assistantThread.id);
     for await (const runMessageDatum of runMessages) {
       for (const item of runMessageDatum.content) {
         // types are: "image_file" or "text"
@@ -456,14 +441,30 @@ An individual assistant can access up to 128 tools including `code interpreter`,
       }
     }
     ```
+    
 
-1. Sign in to Azure with the following command:
+1. Create the `tsconfig.json` file to transpile the TypeScript code and copy the following code for ECMAScript.
+
+    ```json
+    {
+        "compilerOptions": {
+          "module": "NodeNext",
+          "target": "ES2022", // Supports top-level await
+          "moduleResolution": "NodeNext",
+          "skipLibCheck": true, // Avoid type errors from node_modules
+          "strict": true // Enable strict type-checking options
+        },
+        "include": ["*.ts"]
+    }
+    ```
+
+1. Transpile from TypeScript to JavaScript.
 
     ```shell
-    az login
+    tsc
     ```
 
-1. Run the JavaScript file.
+1. Run the code with the following command:
 
     ```shell
     node index.js
@@ -473,7 +474,7 @@ An individual assistant can access up to 128 tools including `code interpreter`,
 
 1. Create the `index.js` file with the following code:
 
-    ```nodejs
+    ```javascript
     import { AzureOpenAI } from "openai";
     
     // Get environment variables

articles/ai-services/openai/includes/use-your-data-javascript.md

@@ -46,7 +46,6 @@ Your app's _package.json_ file will be updated with the dependencies.
 1. Open a command prompt where you want the new project, and create a new file named `ChatWithOwnData.ts`. Copy the following code into the `ChatWithOwnData.ts` file.
 
     ```typescript
-    import "dotenv/config";
     import { AzureOpenAI } from "openai";
     import { DefaultAzureCredential, getBearerTokenProvider } from "@azure/identity";
     import "@azure/openai/types";
@@ -145,8 +144,7 @@ Your app's _package.json_ file will be updated with the dependencies.
 1. Open a command prompt where you want the new project, and create a new file named `ChatWithOwnData.js`. Copy the following code into the `ChatWithOwnData.js` file.
 
     ```javascript
-    require("dotenv/config");
-    import { DefaultAzureCredential, getBearerTokenProvider } from "@azure/identity";
+    const { DefaultAzureCredential, getBearerTokenProvider } = require("@azure/identity");
     const { AzureOpenAI } = require("openai");
     
     // Set the Azure and AI Search values from environment variables
@@ -238,7 +236,6 @@ Your app's _package.json_ file will be updated with the dependencies.
 1. Open a command prompt where you want the new project, and create a new file named `ChatWithOwnData.ts`. Copy the following code into the `ChatWithOwnData.ts` file.
 
     ```typescript
-    import "dotenv/config";
     import { AzureOpenAI } from "openai";
     import "@azure/openai/types";
     
@@ -333,7 +330,6 @@ Your app's _package.json_ file will be updated with the dependencies.
 1. Open a command prompt where you want the new project, and create a new file named `ChatWithOwnData.js`. Copy the following code into the `ChatWithOwnData.js` file.
 
     ```javascript
-    require("dotenv/config");
     const { AzureOpenAI } = require("openai");
     
     // Set the Azure and AI Search values from environment variables