prompt::TokenizeBaseClass Class Reference

TokenizeBaseClass. More...

#include <tokenize_base_class.hpp>

Inheritance diagram for prompt::TokenizeBaseClass:

Collaboration diagram for prompt::TokenizeBaseClass:

Public Member Functions
	TokenizeBaseClass ()
	Constructor.
virtual	~TokenizeBaseClass ()=default
	Destructor.
virtual void	initialize_tokenize_base (rclcpp::Node::SharedPtr node, std::string plugin_name="TokenizeBaseClass")
	Initialize the REST base class.
virtual prompt::TokenResponse	get_tokens (prompt::TokenRequest &req) override
	get_tokens sends a text to a token provider
Public Member Functions inherited from prompt::BaseClass
	BaseClass ()=default
virtual	~BaseClass ()=default
virtual void	initialize (rclcpp::Node::SharedPtr node)=0
	Initialize the prompt pligin.
virtual prompt::EmbedResponse	get_embeddings (prompt::EmbedRequest &req)
	get_embeddings sends a text to an embedding provider using REST
virtual prompt::PromptResponse	sendPrompt (prompt::PromptRequest &req)
	Send a prompt to the prompt plugin.
virtual prompt::PromptResponse	sendConversation (prompt::PromptRequest &latest_request, std::vector< PromptDialogue > &conversation)
	Send a prompt to the prompt plugin.

Protected Member Functions
virtual prompt::TokenResponse	process (prompt::TokenRequest &input)=0
	Process a tokenize request.
Protected Member Functions inherited from prompt::BaseClass
virtual void	initialize_base (rclcpp::Node::SharedPtr node, std::string plugin_name="BaseClass")
	Initialize the prompt base class.

Protected Attributes
std::vector< prompt::PromptOption >	required_options_
	Model options.
Protected Attributes inherited from prompt::BaseClass
rclcpp::Node::SharedPtr	node_
	Node shared pointer.
std::string	plugin_name_
	Plugin name.

Detailed Description

TokenizeBaseClass.

This class implements a base class for RESTful prompt plugins. It provides a common interface for sending prompts and receiving responses

Constructor & Destructor Documentation

TokenizeBaseClass()

prompt::TokenizeBaseClass::TokenizeBaseClass ( )

inline

Constructor.

Initializes the TokenizeBaseClass with default values.

~TokenizeBaseClass()

virtual prompt::TokenizeBaseClass::~TokenizeBaseClass ( )

virtualdefault

Destructor.

Cleans up resources used by the TokenizeBaseClass.

Member Function Documentation

get_tokens()

virtual prompt::TokenResponse prompt::TokenizeBaseClass::get_tokens ( prompt::TokenRequest &  req )

inlineoverridevirtual

get_tokens sends a text to a token provider

Parameters

req	The token request containing the text and options.

Returns

const TokenResponse

Reimplemented from prompt::BaseClass.

initialize_tokenize_base()

virtual void prompt::TokenizeBaseClass::initialize_tokenize_base ( rclcpp::Node::SharedPtr  node, std::string  plugin_name = "TokenizeBaseClass"  )

inlinevirtual

Initialize the REST base class.

This method initializes the REST base class with parameters from the ROS parameter server.

Parameters

node	rclcpp::Node::SharedPtr ROS node
plugin_name	std::string Name of the plugin, used for parameter names

Exceptions

prompt::EmbedException

if there is an error during initialization

process()

virtual prompt::TokenResponse prompt::TokenizeBaseClass::process ( prompt::TokenRequest &  input )

protectedpure virtual

Process a tokenize request.

This method processes the tokenize request and returns a TokenResponse. Should be implemented by derived classes.

Parameters

input

The tokenize request to convert

Returns

A TokenResponse containing the tokens and options

Implemented in prompt::OpenAITokenize.

Member Data Documentation

required_options_

std::vector<prompt::PromptOption> prompt::TokenizeBaseClass::required_options_

protected

Model options.

This is the model options used by the prompt provider by default in case model options are not provided in the request

---

The documentation for this class was generated from the following file:

• prompt_base/include/prompt_base/tokenize_base_class.hpp