Class SearchRecordsTool

java.lang.Object

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

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

public class SearchRecordsTool
extends AbstractAiTool

search_records: free-text record search (RecordSearchAction - and so any record search provider, e.g. Quick Search), as the current user, over the readable tables whose values the assistant may see. A table is searched only if its exposure allows values and none of its search fields is NONE (a match on an unexposed field would reveal its content). Record labels are only sent when every label field is exposed with VALUES (else "{table label} {id}"). Tables named in the input that are not searchable are silently skipped (as RecordSearchAction does), so a caller can't probe which tables exist.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
SearchRecordsTool()

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

Constructor Details

SearchRecordsTool

public SearchRecordsTool()

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