#include <openai_tokenize.hpp>

Inheritance diagram for prompt::OpenAITokenize:

[legend]

Collaboration diagram for prompt::OpenAITokenize:

[legend]

Public Member Functions
	OpenAITokenize ()
	Construct a new OpenAI Tokenize Provider object.

virtual void	initialize (rclcpp::Node::SharedPtr node) override
	Initialize the OpenAITokenize.

Public Member Functions inherited from prompt::TokenizeBaseClass
	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 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) override
	Convert a tokenize request to a JSON object.

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::shared_ptr< GptEncoding >	encoder_

Protected Attributes inherited from prompt::TokenizeBaseClass
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

OpenAITokenize.

Constructor & Destructor Documentation

◆ OpenAITokenize()

prompt::OpenAITokenize::OpenAITokenize ( )

inline

Construct a new OpenAI Tokenize Provider object.

Member Function Documentation

◆ initialize()

virtual void prompt::OpenAITokenize::initialize ( rclcpp::Node::SharedPtr node )

inlineoverridevirtual

Initialize the OpenAITokenize.

This method initializes the OpenAITokenize with parameters from the ROS parameter server.

Parameters

node	rclcpp::Node::SharedPtr ROS node

Implements prompt::BaseClass.

◆ process()

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

inlineoverrideprotectedvirtual

Convert a tokenize request to a JSON object.

This method converts the tokenize request to a JSON object that can be sent to the tokenize plugin. It includes the tokenize text and options in the JSON object.

Parameters

input The tokenize request to convert

Returns: A JSON object representing the tokenize request

Implements prompt::TokenizeBaseClass.

Member Data Documentation

◆ encoder_

std::shared_ptr<GptEncoding> prompt::OpenAITokenize::encoder_

protected

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

prompt_openai/include/prompt_openai/openai_tokenize.hpp

Public Member Functions

Protected Member Functions

Protected Attributes