QueryEngineTool

Defined in: packages/llamaindex/src/tools/QueryEngineTool.ts:31

Implements

• BaseTool<QueryEngineParam>

Constructors

Constructor

new QueryEngineTool(__namedParameters): QueryEngineTool

Defined in: packages/llamaindex/src/tools/QueryEngineTool.ts:36

Parameters

__namedParameters

QueryEngineToolParams

Returns

QueryEngineTool

Properties

metadata

metadata: ToolMetadata<JSONSchemaType<QueryEngineParam>>

Defined in: packages/llamaindex/src/tools/QueryEngineTool.ts:33

Implementation of

BaseTool.metadata

---

includeSourceNodes

includeSourceNodes: boolean

Defined in: packages/llamaindex/src/tools/QueryEngineTool.ts:34

Methods

call()

call(__namedParameters): Promise<JSONValue>

Defined in: packages/llamaindex/src/tools/QueryEngineTool.ts:50

This could be undefined if the implementation is not provided, which might be the case when communicating with a llm.

Parameters

__namedParameters

QueryEngineParam

Returns

Promise<JSONValue>

The output of the tool.

Implementation of

BaseTool.call