Class GetRecordTool

java.lang.Object

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

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

public class GetRecordTool
extends AbstractAiTool

get_record: one record of a readable table, by primary key, read as the current user (so record security applies: a record the user can't see is NOT_FOUND, exactly like a missing one) - only exposed field values.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
GetRecordTool()

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

GetRecordTool

public GetRecordTool()

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