Skip to main content

Class: QueryEngineTool

Simple Tool interface. Likely to change.

Implements​

Constructors​

new QueryEngineTool()​

new QueryEngineTool(__namedParameters): QueryEngineTool

Parameters​

• __namedParameters: QueryEngineToolParams

Returns​

QueryEngineTool

Defined in​

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

Properties​

metadata​

metadata: ToolMetadata<JSONSchemaType<QueryEngineParam>>

Implementation of​

BaseTool.metadata

Defined in​

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

Methods​

call()​

call(__namedParameters): Promise<MessageContent>

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<MessageContent>

The output of the tool.

Implementation of​

BaseTool.call

Defined in​

packages/llamaindex/src/tools/QueryEngineTool.ts:42