interface.md

Interface Information

Following are the details of the interfaces provided by the Prompt Capabilities package. A runner that intends to connect with one of these interfaces should support the input and ouput parameters described below.

PromptCapabilityRunner

Input Parameters:

Parameter Name	Type	Description
CapabilitySpecs	string[]	Capability specifications collected from upstream capabilities.
uuid	string	The uuid used to keep track of the prompts and their responses.
flush	bool	Whether to flush the accumulated information for the current prompt.

Output Parameters:

None

PromptPlanRunner

Input Parameters:

Parameter Name	Type	Description
replan	bool	Whether the iteration is a replanning step
task	string	Task Description for the current iteration
failedElements	string	A list of failed elements from the previous iteration, if any.
uuid	string	The uuid used to keep track of the prompts and their responses.
flush	bool	Whether to flush the accumulated information for the current prompt.

Output Parameters:

Parameter Name	Type	Description
plan	string	The generated plan for the current iteration.

PromptSpeechRunner

Input Parameters:

Parameter Name	Type	Description
task	string	The task or context to send to the LLM for generating a speakable response.
uuid	string	The uuid used to keep track of the prompts and their responses.
flush	bool	Whether to flush the accumulated information for the current prompt before generating the speech response.

Output Parameters:

None

PromptPoseRunner

Input Parameters:

Parameter Name	Type	Description
uuid	string	The uuid to associate the prompt with. This is used to keep track of the prompts and their responses.
flush	bool	Whether to flush the accumulated information for the current prompt.
x	double	The x-coordinate of the robot's pose.
y	double	The y-coordinate of the robot's pose.
z	double	The z-coordinate of the robot's pose.
qx	double	The x-coordinate of the robot's orientation quaternion.
qy	double	The y-coordinate of the robot's orientation quaternion.
qz	double	The z-coordinate of the robot's orientation quaternion.
qw	double	The w-coordinate of the robot's orientation quaternion.

Output Parameters:

None

PromptTextRunner

Input Parameters:

Parameter Name	Type	Description
uuid	string	The uuid to associate the prompt with. This is used to keep track of the prompts and their responses.
flush	bool	Whether to flush the accumulated information for the current prompt.
text	string	The text to be processed by the LLM.

Output Parameters:

Parameter Name	Type	Description
response	string	The response generated by the LLM for the given text.