middleware | References | ArcGIS Maps SDK for JavaScript

ESM

import { createAgentMiddleware, createToolMiddleware } from "@arcgis/ai-components/agent-utils/middlewares/middleware.js";

Functions

Function

Creates an agent middleware with the specified hooks and options.

Signature: createAgentMiddleware <TCustomState extends AgentData = EmptyAgentData>(name: string, hooks: AgentMiddlewareHooks<TCustomState>, options?: { outputKey?: keyof AgentGraphState<TCustomState>; }): AgentMiddleware<TCustomState>

Parameter	Type	Description
name	string	The name of the middleware.
hooks	AgentMiddlewareHooks	The hooks to be used in the middleware.
options	{ outputKey?: keyof AgentGraphState; }	Optional configuration for the middleware, such as the output key.

Function

Creates a tool middleware with the specified hooks and options.

Signature: createToolMiddleware <TInput extends AgentData = AgentData, TOutput = unknown>(name: string, hooks: ToolMiddlewareHooks<TInput, TOutput>, options?: { outputKey?: string; }): FunctionToolMiddleware<TInput, TOutput>

Parameter	Type	Description
name	string	The name of the middleware.
hooks	ToolMiddlewareHooks<TInput, TOutput>	The hooks to be used in the middleware.
options	{ outputKey?: string; }	Optional configuration for the middleware, such as the output key.

Returns: FunctionToolMiddleware<TInput, TOutput>
The created function tool middleware.