@mastra/client-js 0.0.0-message-ordering-20250415215612 → 0.0.0-message-list-update-20250715150321

package/src/resources/agent.ts

@@ -1,8 +1,21 @@
-import type { GenerateReturn } from '@mastra/core';
+import {
+  parsePartialJson,
+  processDataStream,
+  processTextStream,
+  type JSONValue,
+  type ReasoningUIPart,
+  type TextUIPart,
+  type ToolInvocation,
+  type ToolInvocationUIPart,
+  type UIMessage,
+  type UseChatOptions,
+} from '@ai-sdk/ui-utils';
+import { Tool, type CoreMessage, type GenerateReturn } from '@mastra/core';
 import type { JSONSchema7 } from 'json-schema';
 import { ZodSchema } from 'zod';
-import { zodToJsonSchema } from 'zod-to-json-schema';
-import { processDataStream } from '@ai-sdk/ui-utils';
+import { zodToJsonSchema } from '../utils/zod-to-json-schema';
+import { processClientTools } from '../utils/process-client-tools';
+import { v4 as uuid } from '@lukeed/uuid';
 
 import type {
   GenerateParams,
@@ -14,29 +27,9 @@ import type {
 } from '../types';
 
 import { BaseResource } from './base';
-
-export class AgentTool extends BaseResource {
-  constructor(
-    options: ClientOptions,
-    private agentId: string,
-    private toolId: string,
-  ) {
-    super(options);
-  }
-
-  /**
-   * Executes a specific tool for an agent
-   * @param params - Parameters required for tool execution
-   * @returns Promise containing tool execution results
-   */
-  /** @deprecated use CreateRun/startRun */
-  execute(params: { data: any }): Promise<any> {
-    return this.request(`/api/agents/${this.agentId}/tools/${this.toolId}/execute`, {
-      method: 'POST',
-      body: params,
-    });
-  }
-}
+import type { RuntimeContext } from '@mastra/core/runtime-context';
+import { parseClientRuntimeContext } from '../utils';
+import { MessageList } from '@mastra/core/agent';
 
 export class AgentVoice extends BaseResource {
   constructor(
@@ -70,7 +63,7 @@ export class AgentVoice extends BaseResource {
    * @param options - Optional provider-specific options
    * @returns Promise containing the transcribed text
    */
-  listen(audio: Blob, options?: Record<string, any>): Promise<Response> {
+  listen(audio: Blob, options?: Record<string, any>): Promise<{ text: string }> {
     const formData = new FormData();
     formData.append('audio', audio);
 
@@ -91,6 +84,14 @@ export class AgentVoice extends BaseResource {
   getSpeakers(): Promise<Array<{ voiceId: string; [key: string]: any }>> {
     return this.request(`/api/agents/${this.agentId}/voice/speakers`);
   }
+
+  /**
+   * Get the listener configuration for the agent's voice provider
+   * @returns Promise containing a check if the agent has listening capabilities
+   */
+  getListener(): Promise<{ enabled: boolean }> {
+    return this.request(`/api/agents/${this.agentId}/voice/listener`);
+  }
 }
 
 export class Agent extends BaseResource {
@@ -117,65 +118,642 @@ export class Agent extends BaseResource {
    * @param params - Generation parameters including prompt
    * @returns Promise containing the generated response
    */
-  generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(
+  async generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(
+    params: GenerateParams<T> & { output?: never; experimental_output?: never },
+  ): Promise<GenerateReturn<T>>;
+  async generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(
+    params: GenerateParams<T> & { output: T; experimental_output?: never },
+  ): Promise<GenerateReturn<T>>;
+  async generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(
+    params: GenerateParams<T> & { output?: never; experimental_output: T },
+  ): Promise<GenerateReturn<T>>;
+  async generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(
     params: GenerateParams<T>,
   ): Promise<GenerateReturn<T>> {
     const processedParams = {
       ...params,
-      output: params.output instanceof ZodSchema ? zodToJsonSchema(params.output) : params.output,
-      experimental_output:
-        params.experimental_output instanceof ZodSchema
-          ? zodToJsonSchema(params.experimental_output)
-          : params.experimental_output,
+      output: params.output ? zodToJsonSchema(params.output) : undefined,
+      experimental_output: params.experimental_output ? zodToJsonSchema(params.experimental_output) : undefined,
+      runtimeContext: parseClientRuntimeContext(params.runtimeContext),
+      clientTools: processClientTools(params.clientTools),
     };
 
-    return this.request(`/api/agents/${this.agentId}/generate`, {
+    const { runId, resourceId, threadId, runtimeContext } = processedParams as GenerateParams;
+
+    const response: GenerateReturn<T> = await this.request(`/api/agents/${this.agentId}/generate`, {
       method: 'POST',
       body: processedParams,
     });
+
+    if (response.finishReason === 'tool-calls') {
+      const toolCalls = (
+        response as unknown as {
+          toolCalls: { toolName: string; args: any; toolCallId: string }[];
+          messages: CoreMessage[];
+        }
+      ).toolCalls;
+
+      if (!toolCalls || !Array.isArray(toolCalls)) {
+        return response;
+      }
+
+      for (const toolCall of toolCalls) {
+        const clientTool = params.clientTools?.[toolCall.toolName] as Tool;
+
+        if (clientTool && clientTool.execute) {
+          const result = await clientTool.execute(
+            { context: toolCall?.args, runId, resourceId, threadId, runtimeContext: runtimeContext as RuntimeContext },
+            {
+              messages: (response as unknown as { messages: CoreMessage[] }).messages,
+              toolCallId: toolCall?.toolCallId,
+            },
+          );
+
+          const updatedMessages = [
+            {
+              role: 'user',
+              content: params.messages,
+            },
+            ...(response.response as unknown as { messages: CoreMessage[] }).messages,
+            {
+              role: 'tool',
+              content: [
+                {
+                  type: 'tool-result',
+                  toolCallId: toolCall.toolCallId,
+                  toolName: toolCall.toolName,
+                  result,
+                },
+              ],
+            },
+          ];
+          // @ts-ignore
+          return this.generate({
+            ...params,
+            messages: updatedMessages,
+          });
+        }
+      }
+    }
+
+    return response;
+  }
+
+  private async processChatResponse({
+    stream,
+    update,
+    onToolCall,
+    onFinish,
+    getCurrentDate = () => new Date(),
+    lastMessage,
+    streamProtocol,
+  }: {
+    stream: ReadableStream<Uint8Array>;
+    update: (options: { message: UIMessage; data: JSONValue[] | undefined; replaceLastMessage: boolean }) => void;
+    onToolCall?: UseChatOptions['onToolCall'];
+    onFinish?: (options: { message: UIMessage | undefined; finishReason: string; usage: string }) => void;
+    generateId?: () => string;
+    getCurrentDate?: () => Date;
+    lastMessage: UIMessage | undefined;
+    streamProtocol: 'text' | 'data';
+  }) {
+    const replaceLastMessage = lastMessage?.role === 'assistant';
+    let step = replaceLastMessage
+      ? 1 +
+        // find max step in existing tool invocations:
+        (lastMessage.toolInvocations?.reduce((max, toolInvocation) => {
+          return Math.max(max, toolInvocation.step ?? 0);
+        }, 0) ?? 0)
+      : 0;
+
+    const message: UIMessage = replaceLastMessage
+      ? structuredClone(lastMessage)
+      : {
+          id: uuid(),
+          createdAt: getCurrentDate(),
+          role: 'assistant',
+          content: '',
+          parts: [],
+        };
+
+    let currentTextPart: TextUIPart | undefined = undefined;
+    let currentReasoningPart: ReasoningUIPart | undefined = undefined;
+    let currentReasoningTextDetail: { type: 'text'; text: string; signature?: string } | undefined = undefined;
+
+    function updateToolInvocationPart(toolCallId: string, invocation: ToolInvocation) {
+      const part = message.parts.find(
+        part => part.type === 'tool-invocation' && part.toolInvocation.toolCallId === toolCallId,
+      ) as ToolInvocationUIPart | undefined;
+
+      if (part != null) {
+        part.toolInvocation = invocation;
+      } else {
+        message.parts.push({
+          type: 'tool-invocation',
+          toolInvocation: invocation,
+        });
+      }
+    }
+
+    const data: JSONValue[] = [];
+
+    // keep list of current message annotations for message
+    let messageAnnotations: JSONValue[] | undefined = replaceLastMessage ? lastMessage?.annotations : undefined;
+
+    // keep track of partial tool calls
+    const partialToolCalls: Record<string, { text: string; step: number; index: number; toolName: string }> = {};
+
+    let usage: any = {
+      completionTokens: NaN,
+      promptTokens: NaN,
+      totalTokens: NaN,
+    };
+    let finishReason: string = 'unknown';
+
+    function execUpdate() {
+      // make a copy of the data array to ensure UI is updated (SWR)
+      const copiedData = [...data];
+
+      // keeps the currentMessage up to date with the latest annotations,
+      // even if annotations preceded the message creation
+      if (messageAnnotations?.length) {
+        message.annotations = messageAnnotations;
+      }
+
+      const copiedMessage = {
+        // deep copy the message to ensure that deep changes (msg attachments) are updated
+        // with SolidJS. SolidJS uses referential integration of sub-objects to detect changes.
+        ...structuredClone(message),
+        // add a revision id to ensure that the message is updated with SWR. SWR uses a
+        // hashing approach by default to detect changes, but it only works for shallow
+        // changes. This is why we need to add a revision id to ensure that the message
+        // is updated with SWR (without it, the changes get stuck in SWR and are not
+        // forwarded to rendering):
+        revisionId: uuid(),
+      } as UIMessage;
+
+      update({
+        message: copiedMessage,
+        data: copiedData,
+        replaceLastMessage,
+      });
+    }
+
+    if (streamProtocol === 'text') {
+      await processTextStream({
+        stream,
+        onTextPart(value) {
+          message.content += value;
+          execUpdate();
+        },
+      });
+
+      onFinish?.({ message, finishReason, usage });
+    } else {
+      await processDataStream({
+        stream,
+        onTextPart(value) {
+          if (currentTextPart == null) {
+            currentTextPart = {
+              type: 'text',
+              text: value,
+            };
+            message.parts.push(currentTextPart);
+          } else {
+            currentTextPart.text += value;
+          }
+
+          message.content += value;
+          execUpdate();
+        },
+        onReasoningPart(value) {
+          if (currentReasoningTextDetail == null) {
+            currentReasoningTextDetail = { type: 'text', text: value };
+            if (currentReasoningPart != null) {
+              currentReasoningPart.details.push(currentReasoningTextDetail);
+            }
+          } else {
+            currentReasoningTextDetail.text += value;
+          }
+
+          if (currentReasoningPart == null) {
+            currentReasoningPart = {
+              type: 'reasoning',
+              reasoning: value,
+              details: [currentReasoningTextDetail],
+            };
+            message.parts.push(currentReasoningPart);
+          } else {
+            currentReasoningPart.reasoning += value;
+          }
+
+          message.reasoning = (message.reasoning ?? '') + value;
+
+          execUpdate();
+        },
+        onReasoningSignaturePart(value) {
+          if (currentReasoningTextDetail != null) {
+            currentReasoningTextDetail.signature = value.signature;
+          }
+        },
+        onRedactedReasoningPart(value) {
+          if (currentReasoningPart == null) {
+            currentReasoningPart = {
+              type: 'reasoning',
+              reasoning: '',
+              details: [],
+            };
+            message.parts.push(currentReasoningPart);
+          }
+
+          currentReasoningPart.details.push({
+            type: 'redacted',
+            data: value.data,
+          });
+
+          currentReasoningTextDetail = undefined;
+
+          execUpdate();
+        },
+        onFilePart(value) {
+          message.parts.push({
+            type: 'file',
+            mimeType: value.mimeType,
+            data: value.data,
+          });
+
+          execUpdate();
+        },
+        onSourcePart(value) {
+          message.parts.push({
+            type: 'source',
+            source: value,
+          });
+
+          execUpdate();
+        },
+        onToolCallStreamingStartPart(value) {
+          if (message.toolInvocations == null) {
+            message.toolInvocations = [];
+          }
+
+          // add the partial tool call to the map
+          partialToolCalls[value.toolCallId] = {
+            text: '',
+            step,
+            toolName: value.toolName,
+            index: message.toolInvocations.length,
+          };
+
+          const invocation = {
+            state: 'partial-call',
+            step,
+            toolCallId: value.toolCallId,
+            toolName: value.toolName,
+            args: undefined,
+          } as const;
+
+          message.toolInvocations.push(invocation);
+
+          updateToolInvocationPart(value.toolCallId, invocation);
+
+          execUpdate();
+        },
+        onToolCallDeltaPart(value) {
+          const partialToolCall = partialToolCalls[value.toolCallId];
+
+          partialToolCall!.text += value.argsTextDelta;
+
+          const { value: partialArgs } = parsePartialJson(partialToolCall!.text);
+
+          const invocation = {
+            state: 'partial-call',
+            step: partialToolCall!.step,
+            toolCallId: value.toolCallId,
+            toolName: partialToolCall!.toolName,
+            args: partialArgs,
+          } as const;
+
+          message.toolInvocations![partialToolCall!.index] = invocation;
+
+          updateToolInvocationPart(value.toolCallId, invocation);
+
+          execUpdate();
+        },
+        async onToolCallPart(value) {
+          const invocation = {
+            state: 'call',
+            step,
+            ...value,
+          } as const;
+
+          if (partialToolCalls[value.toolCallId] != null) {
+            // change the partial tool call to a full tool call
+            message.toolInvocations![partialToolCalls[value.toolCallId]!.index] = invocation;
+          } else {
+            if (message.toolInvocations == null) {
+              message.toolInvocations = [];
+            }
+
+            message.toolInvocations.push(invocation);
+          }
+
+          updateToolInvocationPart(value.toolCallId, invocation);
+
+          execUpdate();
+
+          // invoke the onToolCall callback if it exists. This is blocking.
+          // In the future we should make this non-blocking, which
+          // requires additional state management for error handling etc.
+          if (onToolCall) {
+            const result = await onToolCall({ toolCall: value });
+            if (result != null) {
+              const invocation = {
+                state: 'result',
+                step,
+                ...value,
+                result,
+              } as const;
+
+              // store the result in the tool invocation
+              message.toolInvocations![message.toolInvocations!.length - 1] = invocation;
+
+              updateToolInvocationPart(value.toolCallId, invocation);
+
+              execUpdate();
+            }
+          }
+        },
+        onToolResultPart(value) {
+          const toolInvocations = message.toolInvocations;
+
+          if (toolInvocations == null) {
+            throw new Error('tool_result must be preceded by a tool_call');
+          }
+
+          // find if there is any tool invocation with the same toolCallId
+          // and replace it with the result
+          const toolInvocationIndex = toolInvocations.findIndex(
+            invocation => invocation.toolCallId === value.toolCallId,
+          );
+
+          if (toolInvocationIndex === -1) {
+            throw new Error('tool_result must be preceded by a tool_call with the same toolCallId');
+          }
+
+          const invocation = {
+            ...toolInvocations[toolInvocationIndex],
+            state: 'result' as const,
+            ...value,
+          } as const;
+
+          toolInvocations[toolInvocationIndex] = invocation as ToolInvocation;
+
+          updateToolInvocationPart(value.toolCallId, invocation as ToolInvocation);
+
+          execUpdate();
+        },
+        onDataPart(value) {
+          data.push(...value);
+          execUpdate();
+        },
+        onMessageAnnotationsPart(value) {
+          if (messageAnnotations == null) {
+            messageAnnotations = [...value];
+          } else {
+            messageAnnotations.push(...value);
+          }
+
+          execUpdate();
+        },
+        onFinishStepPart(value) {
+          step += 1;
+
+          // reset the current text and reasoning parts
+          currentTextPart = value.isContinued ? currentTextPart : undefined;
+          currentReasoningPart = undefined;
+          currentReasoningTextDetail = undefined;
+        },
+        onStartStepPart(value) {
+          // keep message id stable when we are updating an existing message:
+          if (!replaceLastMessage) {
+            message.id = value.messageId;
+          }
+
+          // add a step boundary part to the message
+          message.parts.push({ type: 'step-start' });
+          execUpdate();
+        },
+        onFinishMessagePart(value) {
+          finishReason = value.finishReason;
+          if (value.usage != null) {
+            // usage = calculateLanguageModelUsage(value.usage);
+            usage = value.usage;
+          }
+        },
+        onErrorPart(error) {
+          throw new Error(error);
+        },
+      });
+
+      onFinish?.({ message, finishReason, usage });
+    }
+  }
+
+  /**
+   * Processes the stream response and handles tool calls
+   */
+  private async processStreamResponse(processedParams: any, writable: WritableStream<Uint8Array>) {
+    const response: Response & {
+      processDataStream: (options?: Omit<Parameters<typeof processDataStream>[0], 'stream'>) => Promise<void>;
+    } = await this.request(`/api/agents/${this.agentId}/stream`, {
+      method: 'POST',
+      body: processedParams,
+      stream: true,
+    });
+
+    if (!response.body) {
+      throw new Error('No response body');
+    }
+
+    try {
+      const streamProtocol = processedParams.output ? 'text' : 'data';
+      let toolCalls: ToolInvocation[] = [];
+      let finishReasonToolCalls = false;
+      let messages: UIMessage[] = [];
+      let hasProcessedToolCalls = false;
+
+      // Use tee() to split the stream into two branches
+      const [streamForWritable, streamForProcessing] = response.body.tee();
+
+      // Pipe one branch to the writable stream
+      streamForWritable
+        .pipeTo(writable, {
+          preventClose: true,
+        })
+        .catch(error => {
+          console.error('Error piping to writable stream:', error);
+        });
+
+      // Process the other branch for chat response handling
+      this.processChatResponse({
+        stream: streamForProcessing,
+        update: ({ message }) => {
+          messages.push(message);
+        },
+        onFinish: async ({ finishReason, message }) => {
+          if (finishReason === 'tool-calls') {
+            const toolCall = [...(message?.parts ?? [])]
+              .reverse()
+              .find(part => part.type === 'tool-invocation')?.toolInvocation;
+            if (toolCall) {
+              toolCalls.push(toolCall);
+            }
+
+            // Handle tool calls if needed
+            for (const toolCall of toolCalls) {
+              const clientTool = processedParams.clientTools?.[toolCall.toolName] as Tool;
+              if (clientTool && clientTool.execute) {
+                const result = await clientTool.execute(
+                  {
+                    context: toolCall?.args,
+                    runId: processedParams.runId,
+                    resourceId: processedParams.resourceId,
+                    threadId: processedParams.threadId,
+                    runtimeContext: processedParams.runtimeContext as RuntimeContext,
+                  },
+                  {
+                    messages: (response as unknown as { messages: CoreMessage[] }).messages,
+                    toolCallId: toolCall?.toolCallId,
+                  },
+                );
+
+                const lastMessage: UIMessage = JSON.parse(JSON.stringify(messages[messages.length - 1]));
+
+                const toolInvocationPart = lastMessage?.parts?.find(
+                  part => part.type === 'tool-invocation' && part.toolInvocation?.toolCallId === toolCall.toolCallId,
+                ) as ToolInvocationUIPart | undefined;
+
+                if (toolInvocationPart) {
+                  toolInvocationPart.toolInvocation = {
+                    ...toolInvocationPart.toolInvocation,
+                    state: 'result',
+                    result,
+                  };
+                }
+
+                const toolInvocation = lastMessage?.toolInvocations?.find(
+                  toolInvocation => toolInvocation.toolCallId === toolCall.toolCallId,
+                ) as ToolInvocation | undefined;
+
+                if (toolInvocation) {
+                  toolInvocation.state = 'result';
+                  // @ts-ignore
+                  toolInvocation.result = result;
+                }
+
+                // write the tool result part to the stream
+                const writer = writable.getWriter();
+
+                try {
+                  await writer.write(
+                    new TextEncoder().encode(
+                      'a:' +
+                        JSON.stringify({
+                          toolCallId: toolCall.toolCallId,
+                          result,
+                        }) +
+                        '\n',
+                    ),
+                  );
+                } finally {
+                  writer.releaseLock();
+                }
+
+                // Convert messages to the correct format for the recursive call
+                const originalMessages = processedParams.messages;
+                const messageArray = Array.isArray(originalMessages) ? originalMessages : [originalMessages];
+
+                // Recursively call stream with updated messages
+                this.processStreamResponse(
+                  {
+                    ...processedParams,
+                    messages: [...messageArray, ...messages, lastMessage],
+                  },
+                  writable,
+                );
+              }
+            }
+          } else {
+            setTimeout(() => {
+              if (!writable.locked) {
+                writable.close();
+              }
+            }, 0);
+          }
+        },
+        lastMessage: undefined,
+        streamProtocol,
+      });
+    } catch (error) {
+      console.error('Error processing stream response:', error);
+    }
+    return response;
   }
 
   /**
    * Streams a response from the agent
    * @param params - Stream parameters including prompt
-   * @returns Promise containing the enhanced Response object with processDataStream method
+   * @returns Promise containing the enhanced Response object with processDataStream and processTextStream methods
    */
   async stream<T extends JSONSchema7 | ZodSchema | undefined = undefined>(
     params: StreamParams<T>,
   ): Promise<
     Response & {
       processDataStream: (options?: Omit<Parameters<typeof processDataStream>[0], 'stream'>) => Promise<void>;
+      processTextStream: (options?: Omit<Parameters<typeof processTextStream>[0], 'stream'>) => Promise<void>;
     }
   > {
     const processedParams = {
       ...params,
-      output: params.output instanceof ZodSchema ? zodToJsonSchema(params.output) : params.output,
-      experimental_output:
-        params.experimental_output instanceof ZodSchema
-          ? zodToJsonSchema(params.experimental_output)
-          : params.experimental_output,
+      output: params.output ? zodToJsonSchema(params.output) : undefined,
+      experimental_output: params.experimental_output ? zodToJsonSchema(params.experimental_output) : undefined,
+      runtimeContext: parseClientRuntimeContext(params.runtimeContext),
+      clientTools: processClientTools(params.clientTools),
     };
 
-    const response: Response & {
-      processDataStream: (options?: Omit<Parameters<typeof processDataStream>[0], 'stream'>) => Promise<void>;
-    } = await this.request(`/api/agents/${this.agentId}/stream`, {
-      method: 'POST',
-      body: processedParams,
-      stream: true,
-    });
+    // Create a readable stream that will handle the response processing
+    const { readable, writable } = new TransformStream<Uint8Array, Uint8Array>();
+    // Start processing the response in the background
+    const response = await this.processStreamResponse(processedParams, writable);
 
-    if (!response.body) {
-      throw new Error('No response body');
-    }
+    // Create a new response with the readable stream
+    const streamResponse = new Response(readable, {
+      status: response.status,
+      statusText: response.statusText,
+      headers: response.headers,
+    }) as Response & {
+      processDataStream: (options?: Omit<Parameters<typeof processDataStream>[0], 'stream'>) => Promise<void>;
+      processTextStream: (options?: Omit<Parameters<typeof processTextStream>[0], 'stream'>) => Promise<void>;
+    };
 
-    response.processDataStream = async (options = {}) => {
+    // Add the processDataStream method to the response
+    streamResponse.processDataStream = async (options = {}) => {
       await processDataStream({
-        stream: response.body as ReadableStream<Uint8Array>,
+        stream: streamResponse.body as ReadableStream<Uint8Array>,
         ...options,
       });
     };
 
-    return response;
+    //Add the processTextStream method to the response
+    streamResponse.processTextStream = async options => {
+      await processTextStream({
+        stream: streamResponse.body as ReadableStream<Uint8Array>,
+        onTextPart: options?.onTextPart ?? (() => {}),
+      });
+    };
+
+    return streamResponse;
   }
 
   /**
@@ -187,6 +765,23 @@ export class Agent extends BaseResource {
     return this.request(`/api/agents/${this.agentId}/tools/${toolId}`);
   }
 
+  /**
+   * Executes a tool for the agent
+   * @param toolId - ID of the tool to execute
+   * @param params - Parameters required for tool execution
+   * @returns Promise containing the tool execution results
+   */
+  executeTool(toolId: string, params: { data: any; runtimeContext?: RuntimeContext }): Promise<any> {
+    const body = {
+      data: params.data,
+      runtimeContext: params.runtimeContext ? Object.fromEntries(params.runtimeContext.entries()) : undefined,
+    };
+    return this.request(`/api/agents/${this.agentId}/tools/${toolId}/execute`, {
+      method: 'POST',
+      body,
+    });
+  }
+
   /**
    * Retrieves evaluation results for the agent
    * @returns Promise containing agent evaluations