YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches

LLM_nwc_yarp: The client side of any ILLM capable device. More...

#include <networkWrappers/LLM_nwc_yarp/LLM_nwc_yarp.h>

+ Inheritance diagram for LLM_nwc_yarp:

Public Member Functions

bool open (yarp::os::Searchable &config) override
 Open the DeviceDriver.
 
bool close () override
 Close the DeviceDriver.
 
bool setPrompt (const std::string &prompt) override
 Performs a question.
 
bool readPrompt (std::string &oPrompt) override
 Retrieves the provided prompt.
 
bool ask (const std::string &question, yarp::dev::LLM_Message &oAnswer) override
 Performs a question.
 
bool getConversation (std::vector< yarp::dev::LLM_Message > &oConversation) override
 Retrieves the whole conversation.
 
bool deleteConversation () override
 Delete the conversation and clear the system context from any internally stored context.
 
- Public Member Functions inherited from yarp::dev::DeviceDriver
 DeviceDriver ()
 
 DeviceDriver (const DeviceDriver &other)=delete
 
 DeviceDriver (DeviceDriver &&other) noexcept=delete
 
DeviceDriveroperator= (const DeviceDriver &other)=delete
 
DeviceDriveroperator= (DeviceDriver &&other) noexcept=delete
 
virtual ~DeviceDriver ()
 
virtual std::string id () const
 Return the id assigned to the PolyDriver.
 
virtual void setId (const std::string &id)
 Set the id for this device.
 
template<class T >
bool view (T *&x)
 Get an interface to the device driver.
 
virtual DeviceDrivergetImplementation ()
 Some drivers are bureaucrats, pointing at others.
 
- Public Member Functions inherited from yarp::dev::ILLM
virtual ~ILLM ()
 Destructor.
 
- Public Member Functions inherited from LLM_nwc_yarp_ParamsParser
 LLM_nwc_yarp_ParamsParser ()
 
 ~LLM_nwc_yarp_ParamsParser () override=default
 
bool parseParams (const yarp::os::Searchable &config) override
 Parse the DeviceDriver parameters.
 
std::string getDeviceClassName () const override
 Get the name of the DeviceDriver class.
 
std::string getDeviceName () const override
 Get the name of the device (i.e.
 
std::string getDocumentationOfDeviceParams () const override
 Get the documentation of the DeviceDriver's parameters.
 
std::vector< std::string > getListOfParams () const override
 Return a list of all params used by the device.
 
- Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual ~IDeviceDriverParams ()
 

Protected Attributes

yarp::dev::llm::ILLMMsgs m_LLM_RPC
 
yarp::os::Port m_rpc_port_to_LLM_server
 

Additional Inherited Members

- Public Attributes inherited from LLM_nwc_yarp_ParamsParser
const std::string m_device_classname = {"LLM_nwc_yarp"}
 
const std::string m_device_name = {"LLM_nwc_yarp"}
 
bool m_parser_is_strict = false
 
const parser_version_type m_parser_version = {}
 
const std::string m_local_defaultValue = {""}
 
const std::string m_remote_defaultValue = {""}
 
std::string m_local = {}
 
std::string m_remote = {}
 

Detailed Description

LLM_nwc_yarp: The client side of any ILLM capable device.

Parameters required by this device are shown in class: LLM_nwc_yarp_ParamsParser

Definition at line 20 of file LLM_nwc_yarp.h.

Member Function Documentation

◆ ask()

bool LLM_nwc_yarp::ask ( const std::string &  question,
yarp::dev::LLM_Message answer 
)
overridevirtual

Performs a question.

Parameters
questionthe text of the question provided by the user
answerthe returned answer
Returns
true/false

Implements yarp::dev::ILLM.

Definition at line 63 of file LLM_nwc_yarp.cpp.

◆ close()

bool LLM_nwc_yarp::close ( )
overridevirtual

Close the DeviceDriver.

Returns
true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 44 of file LLM_nwc_yarp.cpp.

◆ deleteConversation()

bool LLM_nwc_yarp::deleteConversation ( )
overridevirtual

Delete the conversation and clear the system context from any internally stored context.

Returns
true/false

Implements yarp::dev::ILLM.

Definition at line 82 of file LLM_nwc_yarp.cpp.

◆ getConversation()

bool LLM_nwc_yarp::getConversation ( std::vector< yarp::dev::LLM_Message > &  conversation)
overridevirtual

Retrieves the whole conversation.

Parameters
conversationthe conversation
Returns
true/false

Implements yarp::dev::ILLM.

Definition at line 71 of file LLM_nwc_yarp.cpp.

◆ open()

bool LLM_nwc_yarp::open ( yarp::os::Searchable config)
overridevirtual

Open the DeviceDriver.

Parameters
configis a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).
Returns
true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 16 of file LLM_nwc_yarp.cpp.

◆ readPrompt()

bool LLM_nwc_yarp::readPrompt ( std::string &  oPrompt)
overridevirtual

Retrieves the provided prompt.

Parameters
promptthe stored prompt
Returns
true/false

Implements yarp::dev::ILLM.

Definition at line 55 of file LLM_nwc_yarp.cpp.

◆ setPrompt()

bool LLM_nwc_yarp::setPrompt ( const std::string &  prompt)
overridevirtual

Performs a question.

Parameters
promptprovides a prompt to the LLM
Returns
true/false

Implements yarp::dev::ILLM.

Definition at line 50 of file LLM_nwc_yarp.cpp.

Member Data Documentation

◆ m_LLM_RPC

yarp::dev::llm::ILLMMsgs LLM_nwc_yarp::m_LLM_RPC
protected

Definition at line 26 of file LLM_nwc_yarp.h.

◆ m_rpc_port_to_LLM_server

yarp::os::Port LLM_nwc_yarp::m_rpc_port_to_LLM_server
protected

Definition at line 29 of file LLM_nwc_yarp.h.


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