yarp::dev::ILLM Class Reference

ILLM interface. More...

#include <yarp/dev/ILLM.h>

Inheritance diagram for yarp::dev::ILLM:

Public Member Functions
virtual	~ILLM ()
	Destructor.
virtual yarp::dev::ReturnValue	setPrompt (const std::string &prompt)=0
	Performs a question.
virtual yarp::dev::ReturnValue	readPrompt (std::string &oPrompt)=0
	Retrieves the provided prompt.
virtual yarp::dev::ReturnValue	ask (const std::string &question, yarp::dev::LLM_Message &answer)=0
	Performs a question.
virtual yarp::dev::ReturnValue	getConversation (std::vector< yarp::dev::LLM_Message > &conversation)=0
	Retrieves the whole conversation.
virtual yarp::dev::ReturnValue	deleteConversation ()=0
	Delete the conversation and clear the system context from any internally stored context.
virtual yarp::dev::ReturnValue	refreshConversation ()=0
	Refresh the conversation.

Detailed Description

ILLM interface.

Provides methods to interact with a LLM.

Definition at line 25 of file ILLM.h.

Constructor & Destructor Documentation

~ILLM()

yarp::dev::ILLM::~ILLM ( )

virtualdefault

Destructor.

Member Function Documentation

ask()

virtual yarp::dev::ReturnValue yarp::dev::ILLM::ask ( const std::string &  question, yarp::dev::LLM_Message &  answer  )

pure virtual

Performs a question.

Parameters

question	the text of the question provided by the user
answer	the returned answer

Returns

true/false

Implemented in GPTDevice, FakeLLMDevice, and LLM_nwc_yarp.

deleteConversation()

virtual yarp::dev::ReturnValue yarp::dev::ILLM::deleteConversation ( )

pure virtual

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

Returns

true/false

Implemented in GPTDevice, FakeLLMDevice, and LLM_nwc_yarp.

getConversation()

virtual yarp::dev::ReturnValue yarp::dev::ILLM::getConversation ( std::vector< yarp::dev::LLM_Message > &  conversation )

pure virtual

Retrieves the whole conversation.

Parameters

conversation

the conversation

Returns

true/false

Implemented in GPTDevice, FakeLLMDevice, and LLM_nwc_yarp.

readPrompt()

virtual yarp::dev::ReturnValue yarp::dev::ILLM::readPrompt ( std::string &  oPrompt )

pure virtual

Retrieves the provided prompt.

Parameters

prompt

the stored prompt

Returns

true/false

Implemented in FakeLLMDevice, GPTDevice, and LLM_nwc_yarp.

refreshConversation()

virtual yarp::dev::ReturnValue yarp::dev::ILLM::refreshConversation ( )

pure virtual

Refresh the conversation.

Returns

true/false

Implemented in GPTDevice, FakeLLMDevice, and LLM_nwc_yarp.

setPrompt()

virtual yarp::dev::ReturnValue yarp::dev::ILLM::setPrompt ( const std::string &  prompt )

pure virtual

Performs a question.

Parameters

prompt

provides a prompt to the LLM

Returns

true/false

Implemented in GPTDevice, FakeLLMDevice, and LLM_nwc_yarp.

---

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

• src/libYARP_dev/src/yarp/dev/ILLM.h
• src/libYARP_dev/src/yarp/dev/ILLM.cpp