Class SearchHelpTool

java.lang.Object

com.kingsrook.qqq.backend.core.actions.ai.tools.AbstractAiTool

com.kingsrook.qqq.backend.core.actions.ai.tools.SearchHelpTool

public class SearchHelpTool
extends AbstractAiTool

search_help: keyword search over the app's own documentation - the names, labels, help content and aiDescriptions of the apps, tables, fields, processes and widgets the current user can see (exposed tables and fields only). Never reads customer data.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_RESULTS
static final int	MAX_TERMS
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
SearchHelpTool()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	execute(AiToolContext context, AiToolInput input)	Run the tool - returning the data to send to the model.
String	getDescription()	The tool's description, for the model.
Map<String,Object>	getInputSchema()	The tool's strict input schema (an object schema).
AiToolKind	getKind()	The tool's kind.
String	getName()	The tool's wire name (snake_case).

Methods inherited from class com.kingsrook.qqq.backend.core.actions.ai.tools.AbstractAiTool

getDefinition, getInputPropertyNames

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

MAX_RESULTS

public static final int MAX_RESULTS

See Also:

• Constant Field Values

MAX_TERMS

public static final int MAX_TERMS

See Also:

• Constant Field Values

Constructor Details

SearchHelpTool

public SearchHelpTool()

Method Details

getName

public String getName()

Description copied from class: AbstractAiTool

The tool's wire name (snake_case).

Specified by:

getName in class AbstractAiTool

getDescription

public String getDescription()

Description copied from class: AbstractAiTool

The tool's description, for the model.

Specified by:

getDescription in class AbstractAiTool

getKind

public AiToolKind getKind()

Description copied from class: AbstractAiTool

The tool's kind.

Specified by:

getKind in class AbstractAiTool

getInputSchema

public Map<String,Object> getInputSchema()

Description copied from class: AbstractAiTool

The tool's strict input schema (an object schema).

Specified by:

getInputSchema in class AbstractAiTool

execute

public Map<String,Object> execute(AiToolContext context,
 AiToolInput input)
                           throws QException

Description copied from class: AbstractAiTool

Run the tool - returning the data to send to the model.

Specified by:

execute in class AbstractAiTool

Throws:

QException