Merge pull request #3636 from diberry/diberry/0320-fix-agents-js

Agent quickstarts - JS - fix toolResources

Author: denrea

articles/ai-services/agents/includes/quickstart-javascript.md

@@ -4,7 +4,7 @@ author: aahill
 ms.author: aahi
 ms.service: azure-ai-agent-service
 ms.topic: include
-ms.date: 02/03/2025
+ms.date: 03/21/2025
 ms.custom: devx-track-js
 ---
 
@@ -37,6 +37,12 @@ ms.custom: devx-track-js
 | Run       | Activation of an agent to begin running based on the contents of Thread. The agent uses its configuration and Thread’s Messages to perform tasks by calling models and tools. As part of a Run, the agent appends Messages to the Thread. |
 | Run Step  | A detailed list of steps the agent took as part of a Run. An agent can call tools or create Messages during its run. Examining Run Steps allows you to understand how the agent is getting to its results.                                |
 
+Key objects in this code include: 
+
+* [AIProjectsClient](/javascript/api/@azure/ai-projects/aiprojectsclient)
+* [ToolUtility](/javascript/api/@azure/ai-projects/toolutility)
+* [Agent operations](/javascript/api/@azure/ai-projects/agentsoperations)
+
 First, initialize a new project by running:
 
 ```console
@@ -84,7 +90,6 @@ Next, create an `index.js` file and paste in the code below:
 
 ```javascript
 // index.js
-
 import {
   AIProjectsClient,
   DoneEvent,
@@ -101,6 +106,7 @@ dotenv.config();
 
 // Set the connection string from the environment variable
 const connectionString = process.env.PROJECT_CONNECTION_STRING;
+const model = "gpt-4o";
 
 // Throw an error if the connection string is not set
 if (!connectionString) {
@@ -114,10 +120,10 @@ export async function main() {
   );
 
   // Step 1 code interpreter tool
-  const codeInterpreterTool = ToolUtility.createCodeInterpreterTool();
+  const codeInterpreterTool = ToolUtility.createCodeInterpreterTool([]);
 
   // Step 2 an agent
-  const agent = await client.agents.createAgent("gpt-4o-mini", {
+  const agent = await client.agents.createAgent(model, {
     name: "my-agent",
     instructions: "You are a helpful agent",
     tools: [codeInterpreterTool.definition],
@@ -171,13 +177,14 @@ export async function main() {
 
   // Messages iterate from oldest to newest
   // messages[0] is the most recent
-  for (let i = messages.data.length - 1; i >= 0; i--) {
-    const m = messages.data[i];
-    if (m.content && m.content.length > 0 && isOutputOfType(m.content[0], "text")) {
-      const textContent = m.content[0];
-      console.log(`${textContent.text.value}`);
-      console.log(`---------------------------------`);
-    }
+  const messagesArray = messages.data;
+  for (let i = messagesArray.length - 1; i >= 0; i--) {
+      const m = messagesArray[i];
+      console.log(`Type: ${m.content[0].type}`);
+      if (isOutputOfType(m.content[0], "text")) {
+          const textContent = m.content[0];
+          console.log(`Text: ${textContent.text.value}`);
+      }
   }
 
   // 7. Delete the agent once done
@@ -189,4 +196,4 @@ main().catch((err) => {
 });
 ```
 
-Run the code using `node index.js` and observe.
+Run the code using `node index.js` and observe.

articles/ai-services/agents/includes/quickstart-output.md

@@ -4,23 +4,27 @@ author: aahill
 ms.author: aahi
 ms.service: azure-ai-agent-service
 ms.topic: include
-ms.date: 01/28/2025
+ms.date: 03/21/2025
 ms.custom: devx-track-js
 ---
 
 The output contains the prompt, and answers.
 
 ```
-I need to solve the equation `3x + 11 = 14`. Can you help me?
----------------------------------
-Sure! I can help you solve the equation \(3x + 11 = 14\).
+Type: text
+Text: Sure, I can help you solve the equation \(3x + 11 = 14\).
 
-To solve this equation, we need to isolate the variable \(x\). Let's go ahead and solve it.
----------------------------------
-The solution to the equation \(3x + 11 = 14\) is \(x = 1\). 
+To solve for \(x\), we need to isolate \(x\) on one side of the equation. Here are the steps:
 
-Therefore, the value of \(x\) that satisfies the equation is 1. 
+1. Subtract 11 from both sides of the equation:
+\[3x + 11 - 11 = 14 - 11\]
+\[3x = 3\]
 
-Let me know if you need help with anything else!
----------------------------------
+2. Divide both sides of the equation by 3:
+\[\frac{3x}{3} = \frac{3}{3}\]
+\[x = 1\]
+
+So the solution to the equation \(3x + 11 = 14\) is \(x = 1\).
+Type: text
+Text: I need to solve the equation `3x + 11 = 14`. Can you help me?
 ```

articles/ai-services/agents/includes/quickstart-typescript.md

@@ -4,7 +4,7 @@ author: aahill
 ms.author: aahi
 ms.service: azure-ai-agent-service
 ms.topic: include
-ms.date: 02/03/2025
+ms.date: 03/21/2025
 ms.custom: devx-track-ts
 ---
 
@@ -35,6 +35,12 @@ ms.custom: devx-track-ts
 | Run       | Activation of an agent to begin running based on the contents of Thread. The agent uses its configuration and Thread’s Messages to perform tasks by calling models and tools. As part of a Run, the agent appends Messages to the Thread. |
 | Run Step  | A detailed list of steps the agent took as part of a Run. An agent can call tools or create Messages during its run. Examining Run Steps allows you to understand how the agent is getting to its results.                                |
 
+Key objects in this code include: 
+
+* [AIProjectsClient](/javascript/api/@azure/ai-projects/aiprojectsclient)
+* [ToolUtility](/javascript/api/@azure/ai-projects/toolutility)
+* [Agent operations](/javascript/api/@azure/ai-projects/agentsoperations)
+
 Run the following commands to install the npm packages.
 
 ```console
@@ -68,61 +74,65 @@ Set this connection string as an environment variable named `PROJECT_CONNECTION_
 
 ```typescript
 // index.ts
-
-import type {
-  MessageDeltaChunk,
-  MessageDeltaTextContent,
-  MessageTextContentOutput,
-} from "@azure/ai-projects";
 import {
   AIProjectsClient,
   DoneEvent,
   ErrorEvent,
   isOutputOfType,
   MessageStreamEvent,
   RunStreamEvent,
-  ToolUtility,
+  ToolUtility
+} from "@azure/ai-projects";
+import type {
+  MessageDeltaChunk,
+  MessageDeltaTextContent,
+  MessageTextContentOutput
 } from "@azure/ai-projects";
 import { DefaultAzureCredential } from "@azure/identity";
+import dotenv from 'dotenv';
 
-const connectionString =
-  process.env["AZURE_AI_PROJECTS_CONNECTION_STRING"] || "<project connection string>";
+dotenv.config();
 
+// Set the connection string from the environment variable
+const connectionString = process.env.PROJECT_CONNECTION_STRING;
+const model = "gpt-4o";
+
+// Throw an error if the connection string is not set
 if (!connectionString) {
-  throw new Error("AZURE_AI_PROJECTS_CONNECTION_STRING must be set in the environment variables");
+  throw new Error("Please set the PROJECT_CONNECTION_STRING environment variable.");
 }
 
-export async function main(): Promise<void> {
+export async function main() {
   const client = AIProjectsClient.fromConnectionString(
     connectionString || "",
     new DefaultAzureCredential(),
   );
 
-  // Step 1: Create code interpreter tool
-  const codeInterpreterTool = ToolUtility.createCodeInterpreterTool();
+  // Step 1 code interpreter tool
+  const codeInterpreterTool = ToolUtility.createCodeInterpreterTool([]);
 
-  // Step 2: Create an agent
-  const agent = await client.agents.createAgent("gpt-4o-mini", {
+  // Step 2 an agent
+  const agent = await client.agents.createAgent(model, {
     name: "my-agent",
     instructions: "You are a helpful agent",
     tools: [codeInterpreterTool.definition],
     toolResources: codeInterpreterTool.resources,
   });
 
-  // Step 3: Create a thread
+  // Step 3 a thread
   const thread = await client.agents.createThread();
 
-  // Step 4: Add a message to thread
+  // Step 4 a message to thread
   await client.agents.createMessage(
     thread.id, {
     role: "user",
     content: "I need to solve the equation `3x + 11 = 14`. Can you help me?",
   });
 
-  // Intermission: message is now correlated with thread
-  // Intermission: listing messages will retrieve the message just added
+  // Intermission is now correlated with thread
+  // Intermission messages will retrieve the message just added
 
-  // Step 5: Run the agent
+  // Step 5 the agent
   const streamEventMessages = await client.agents.createRun(thread.id, agent.id).stream();
 
   for await (const eventMessage of streamEventMessages) {
@@ -156,13 +166,14 @@ export async function main(): Promise<void> {
 
   // Messages iterate from oldest to newest
   // messages[0] is the most recent
-  for (let i = messages.data.length - 1; i >= 0; i--) {
-    const m = messages.data[i];
-    if (isOutputOfType<MessageTextContentOutput>(m.content[0], "text")) {
-      const textContent = m.content[0] as MessageTextContentOutput;
-      console.log(`${textContent.text.value}`);
-      console.log(`---------------------------------`);
-    }
+  const messagesArray = messages.data;
+  for (let i = messagesArray.length - 1; i >= 0; i--) {
+      const m = messagesArray[i];
+      console.log(`Type: ${m.content[0].type}`);
+      if (isOutputOfType<MessageTextContentOutput>(m.content[0], "text")) {
+          const textContent = m.content[0] as MessageTextContentOutput;
+          console.log(`Text: ${textContent.text.value}`);
+      }
   }
 
   // 7. Delete the agent once done
@@ -174,3 +185,5 @@ main().catch((err) => {
 });
 ```
 
+
+Build the TypeScript code then run the code using `node index.js` and observe.