core_ai\aiactions\base Class Reference

Inheritance diagram for core_ai\aiactions\base:

Public Member Functions
	__construct (protected int int $contextid,)
	Constructor for the class.
	get_configuration (string $name)
	Get a configuration option.
	store (response_base $response)
	Responsible for storing any action specific data in the database.

Static Public Member Functions
static	get_basename ()
	Get the basename of the class.
static	get_description ()
	Get the action description.
static	get_name ()
	Get the action name.
static	get_response_classname ()
	Get the class name of the response object.
static	get_system_instruction ()
	Get the system instruction for the action.

Protected Member Functions
	get_tablename ()
	Return the correct table name for the action.

Protected Attributes
int readonly int	$timecreated
	Timestamp the action object was created.

Constructor & Destructor Documentation

__construct()

core_ai\aiactions\base::__construct

(

protected int int

$contextid

)

Constructor for the class.

Parameters

int

$contextid

The context ID where the action was created.

Parameters

$contextid

The context ID the action was created in

Member Function Documentation

get_basename()

static core_ai\aiactions\base::get_basename ( )

static

Get the basename of the class.

This is used to generate the action name and description.

Return values

string

The basename of the class.

get_configuration()

core_ai\aiactions\base::get_configuration

(

string

$name

)

Get a configuration option.

Parameters

string

$name

The name of the configuration option to get.

Return values

mixed

The value of the configuration option.

get_description()

static core_ai\aiactions\base::get_description ( )

static

Get the action description.

Defaults to the action description string.

Return values

string

get_name()

static core_ai\aiactions\base::get_name ( )

static

Get the action name.

Defaults to the action name string.

Return values

string

get_response_classname()

static core_ai\aiactions\base::get_response_classname ( )

static

Get the class name of the response object.

Return values

string

The class name of the response object.

get_system_instruction()

static core_ai\aiactions\base::get_system_instruction ( )

static

Get the system instruction for the action.

Return values

string

The system instruction for the action.

get_tablename()

core_ai\aiactions\base::get_tablename ( )

protected

Return the correct table name for the action.

Return values

string

The correct table name for the action.

store()

core_ai\aiactions\base::store ( response_base $response )

abstract

Responsible for storing any action specific data in the database.

Parameters

response_base

$response

The response object to store.

Return values

int	The id of the stored action.

Reimplemented in core_ai\aiactions\explain_text, core_ai\aiactions\generate_image, core_ai\aiactions\generate_text, and core_ai\aiactions\summarise_text.

---

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

• ai/classes/aiactions/base.php