prompt Namespace Reference

Classes
class	BaseClass
	PromptProviderBase. More...
class	EmbedBaseClass
	EmbedBaseClass. More...
struct	Embedding
struct	EmbedRequest
struct	EmbedResponse
class	OllamaProvider
	OllamaProvider. More...
class	OpenAIEmbedding
	OpenAIEmbedding. More...
class	OpenAIProvider
	OpenAIProvider. More...
class	OpenAITokenize
	OpenAITokenize. More...
class	PromptBaseClass
	PromptBaseClass. More...
class	PromptBridge
	PromptBridge. More...
struct	PromptDialogue
class	PromptException
struct	PromptOption
struct	PromptRequest
struct	PromptResponse
class	RestBaseClass
	RestBaseClass. More...
class	TokenizeBaseClass
	TokenizeBaseClass. More...
struct	TokenRequest
struct	TokenResponse

Functions
static const prompt::PromptRequest	fromMsg (const prompt_msgs::msg::Prompt &prompt)
	Converts prompt_msgs::msg::Prompt into prompt::PromptRequest which is used internally in prompt tools.
static const prompt::EmbedRequest	fromMsg (const prompt_msgs::msg::Embed &input)
	Converts prompt_msgs::msg::Embed into prompt::EmbedRequest which is used internally in prompt tools.
static const prompt::TokenRequest	fromMsg (const prompt_msgs::msg::Token &input)
	Converts prompt_msgs::msg::Token into prompt::TokenRequest which is used internally in prompt tools.
static const prompt_msgs::msg::PromptResponse	toMsg (const prompt::PromptResponse &res)
	Converts prompt::PromptResponse into prompt_msgs::msg::PromptResponse which is used in ros2 eco system.
static const prompt_msgs::msg::EmbedResponse	toMsg (const prompt::EmbedResponse &res)
	Converts prompt::EmbedResponse into prompt_msgs::msg::EmbedResponse which is used in ros2 eco system.
static const prompt_msgs::msg::TokenResponse	toMsg (const prompt::TokenResponse &res)
	Converts prompt::TokenResponse into prompt_msgs::msg::TokenResponse which is used in ros2 eco system.
std::vector< prompt::PromptOption >	load_from_parameters (rclcpp::Node::SharedPtr node, std::string plugin_name)
	Load prompt options from ROS2 parameters.
void	ensure_model_options (rclcpp::Node::SharedPtr node, std::vector< prompt::PromptOption > &options, std::vector< prompt::PromptOption > &required_options)
	Check and add required model options to the prompt options.

Function Documentation

ensure_model_options()

void prompt::ensure_model_options	(	rclcpp::Node::SharedPtr	node,
		std::vector< prompt::PromptOption > &	options,
		std::vector< prompt::PromptOption > &	required_options
	)

Check and add required model options to the prompt options.

This method checks if the required model options are present in the prompt options. If any required option is missing, it adds it to the prompt options.

Parameters

node	Shared pointer to the ROS2 node
options	The prompt options to check and modify
required_options	The required model options to ensure are present

fromMsg() [1/3]

static const prompt::EmbedRequest prompt::fromMsg ( const prompt_msgs::msg::Embed &  input )

static

Converts prompt_msgs::msg::Embed into prompt::EmbedRequest which is used internally in prompt tools.

Parameters

prompt

input ros2 message

Returns

const prompt::EmbedRequest

fromMsg() [2/3]

static const prompt::PromptRequest prompt::fromMsg ( const prompt_msgs::msg::Prompt &  prompt )

static

Converts prompt_msgs::msg::Prompt into prompt::PromptRequest which is used internally in prompt tools.

Parameters

prompt

input ros2 message

Returns

const prompt::PromptRequest

fromMsg() [3/3]

static const prompt::TokenRequest prompt::fromMsg ( const prompt_msgs::msg::Token &  input )

static

Converts prompt_msgs::msg::Token into prompt::TokenRequest which is used internally in prompt tools.

Parameters

prompt

input ros2 message

Returns

const prompt::TokenRequest

load_from_parameters()

std::vector< prompt::PromptOption > prompt::load_from_parameters	(	rclcpp::Node::SharedPtr	node,
		std::string	plugin_name
	)

Load prompt options from ROS2 parameters.

This function loads prompt options from the ROS2 parameter server for a given plugin. It retrieves the option keys and their corresponding values and types, and constructs a vector of PromptOption structs.

Parameters

node	Shared pointer to the ROS2 node
plugin_name	Name of the plugin for which to load options

Returns

std::vector<prompt::PromptOption> Vector of loaded prompt options

toMsg() [1/3]

static const prompt_msgs::msg::EmbedResponse prompt::toMsg ( const prompt::EmbedResponse &  res )

static

Converts prompt::EmbedResponse into prompt_msgs::msg::EmbedResponse which is used in ros2 eco system.

Parameters

res

Returns

const prompt_msgs::msg::EmbedResponse

toMsg() [2/3]

static const prompt_msgs::msg::PromptResponse prompt::toMsg ( const prompt::PromptResponse &  res )

static

Converts prompt::PromptResponse into prompt_msgs::msg::PromptResponse which is used in ros2 eco system.

Parameters

res

Returns

const prompt_msgs::msg::PromptResponse

toMsg() [3/3]

static const prompt_msgs::msg::TokenResponse prompt::toMsg ( const prompt::TokenResponse &  res )

static

Converts prompt::TokenResponse into prompt_msgs::msg::TokenResponse which is used in ros2 eco system.

Parameters

res

Returns

const prompt_msgs::msg::TokenResponse