跳转到内容

runToolInputGuardrails

此内容尚不支持你的语言。 

function runToolInputGuardrails<TContext, TAgent>(__namedParameters): Promise<
  | {
  type: "allow";
}
  | {
  message: string;
  type: "reject";
}>;

Type Parameters

Section titled “Type Parameters”
Type Parameter

TContext

TAgent extends Agent<any, any>

Parameters

Section titled “Parameters”
Parameter Type

__namedParameters

{ agent: TAgent; context: RunContext<TContext>; guardrails?: ToolInputGuardrailDefinition<TContext>[]; onResult?: (result) => void; toolCall: { arguments: string; callId: string; id?: string; name: string; providerData?: Record<string, any>; status?: "completed" | "in_progress" | "incomplete"; type: "function_call"; }; }

__namedParameters.agent

TAgent

__namedParameters.context

RunContext<TContext>

__namedParameters.guardrails?

ToolInputGuardrailDefinition<TContext>[]

__namedParameters.onResult?

(result) => void

__namedParameters.toolCall

{ arguments: string; callId: string; id?: string; name: string; providerData?: Record<string, any>; status?: "completed" | "in_progress" | "incomplete"; type: "function_call"; }

__namedParameters.toolCall.arguments

string

__namedParameters.toolCall.callId

string

__namedParameters.toolCall.id?

string

__namedParameters.toolCall.name

string

__namedParameters.toolCall.providerData?

Record<string, any>

__namedParameters.toolCall.status?

"completed" | "in_progress" | "incomplete"

__namedParameters.toolCall.type

"function_call"

Returns

Section titled “Returns”

Promise< | { type: "allow"; } | { message: string; type: "reject"; }>