QueryEngineTool
Defined in: .build/typescript/packages/llamaindex/src/tools/QueryEngineTool.ts:31
Implements
Section titled “Implements”BaseTool
<QueryEngineParam
>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new QueryEngineTool(
__namedParameters
):QueryEngineTool
Defined in: .build/typescript/packages/llamaindex/src/tools/QueryEngineTool.ts:36
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”QueryEngineTool
Properties
Section titled “Properties”metadata
Section titled “metadata”metadata:
ToolMetadata
<JSONSchemaType
<QueryEngineParam
>>
Defined in: .build/typescript/packages/llamaindex/src/tools/QueryEngineTool.ts:33
Implementation of
Section titled “Implementation of”BaseTool.metadata
includeSourceNodes
Section titled “includeSourceNodes”includeSourceNodes:
boolean
Defined in: .build/typescript/packages/llamaindex/src/tools/QueryEngineTool.ts:34
Methods
Section titled “Methods”call()
Section titled “call()”call(
__namedParameters
):Promise
<JSONValue
>
Defined in: .build/typescript/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
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Promise
<JSONValue
>
The output of the tool.
Implementation of
Section titled “Implementation of”BaseTool.call