agsamantha/node_modules/langchain/dist/agents/toolkits/json/json.js
2024-10-02 15:15:21 -05:00

71 lines
2.6 KiB
JavaScript

import { BaseToolkit } from "@langchain/core/tools";
import { JsonGetValueTool, JsonListKeysTool, } from "../../../tools/json.js";
import { JSON_PREFIX, JSON_SUFFIX } from "./prompt.js";
import { LLMChain } from "../../../chains/llm_chain.js";
import { ZeroShotAgent } from "../../mrkl/index.js";
import { AgentExecutor } from "../../executor.js";
/**
* Represents a toolkit for working with JSON data. It initializes the
* JSON tools based on the provided JSON specification.
* @example
* ```typescript
* const toolkit = new JsonToolkit(new JsonSpec());
* const executor = createJsonAgent(model, toolkit);
* const result = await executor.invoke({
* input: 'What are the required parameters in the request body to the /completions endpoint?'
* });
* ```
*/
export class JsonToolkit extends BaseToolkit {
constructor(jsonSpec) {
super();
Object.defineProperty(this, "jsonSpec", {
enumerable: true,
configurable: true,
writable: true,
value: jsonSpec
});
Object.defineProperty(this, "tools", {
enumerable: true,
configurable: true,
writable: true,
value: void 0
});
this.tools = [
new JsonListKeysTool(jsonSpec),
new JsonGetValueTool(jsonSpec),
];
}
}
/**
* @deprecated Create a specific agent with a custom tool instead.
*
* Creates a JSON agent using a language model, a JSON toolkit, and
* optional prompt arguments. It creates a prompt for the agent using the
* JSON tools and the provided prefix and suffix. It then creates a
* ZeroShotAgent with the prompt and the JSON tools, and returns an
* AgentExecutor for executing the agent with the tools.
* @param llm The language model used to create the JSON agent.
* @param toolkit The JSON toolkit used to create the JSON agent.
* @param args Optional prompt arguments used to create the JSON agent.
* @returns An AgentExecutor for executing the created JSON agent with the tools.
*/
export function createJsonAgent(llm, toolkit, args) {
const { prefix = JSON_PREFIX, suffix = JSON_SUFFIX, inputVariables = ["input", "agent_scratchpad"], } = args ?? {};
const { tools } = toolkit;
const prompt = ZeroShotAgent.createPrompt(tools, {
prefix,
suffix,
inputVariables,
});
const chain = new LLMChain({ prompt, llm });
const agent = new ZeroShotAgent({
llmChain: chain,
allowedTools: tools.map((t) => t.name),
});
return AgentExecutor.fromAgentAndTools({
agent,
tools,
returnIntermediateSteps: true,
});
}