AI Service resource types

Overview

The AI Service emits events when certain actions are taken in the system. The Notification Service can listen to these events and perform additional actions. For example, in the Notification Service, event triggers are set up which listen to events and determine when to send a notification.

Events are linked to resources. The actual type of the resource is indicated by the resource.type property. The other properties shown for a given resource depend on the type.

This page lists the resource types which are specific to the Datasources Service, and the events which are common to all services.

Event filtering

In an event type trigger, filtering on the properties of an incoming event is supported.

An event filter is of the form:

{  "filter": {    <property...>: <wildcard>  }}

For example, to match create events from the Item Service, the event filter would look like the code listing below.

{  "filter": {    "event": "resource.ResourceCreated",    "resource.type": "itemsvc.*"  }}

Common events

This section lists the events which are common to all services.

resource.ResourceCreated

A resource created event is emitted when a resource is created.

Property	Type
uuid	UUID
resource
user
_id	string
timestamp	timestamp
requestId	string

Example event

{    "event": "resource.ResourceCreated",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

resource.ResourceUpdated

A resource updated event is emitted when a resource is changed.

Property	Type
uuid	UUID
resource
user
_id	string
timestamp	timestamp
requestId	string

Example event

{    "event": "resource.ResourceUpdated",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

resource.ResourceSoftDeleted

A resource soft deleted event is emitted if a resource is marked for deletion but not yet permanently deleted.

Typically, a resource.ResourceHardDeleted event will follow a resource.ResourceSoftDeleted event. However, not all services support soft delete and in this case, only a resource.ResourceHardDeleted is emitted.

Property	Type
uuid	UUID
resource
user
_id	string
timestamp	timestamp
requestId	string

Example event

{    "event": "resource.ResourceSoftDeleted",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

resource.ResourceHardDeleted

A resource hard deleted event is emitted if a resource is deleted permanently. This means is it either deleted with ?purge=true or otherwise deleted in a way that means it cannot be recovered.

Property	Type
uuid	UUID
resource
user
_id	string
timestamp	timestamp
requestId	string

Example event

{    "event": "resource.ResourceHardDeleted",    "uuid": "8f2792c7-b01a-4493-ba5a-d0588a4aad8e",    "resource": {        "type": "custom.Resource",        ...    }    "user": {        "id": "00b82755-b5e6-4c8b-a4cf-66bb4f697f17"    },    "requestId": "abe50236-cf30-435f-b7fc-c05cb8f0f320"
 }

AI Service resource types

This section lists the resource types which are specific to the AI Service.

aisvc.Agent

Object	Property	Type
resource
	id	string
	namespaces	string[]
before
	namespaces	string[]
	name	string
	description	string
	background	string
	user_type	string
	type	string
	config	object
	tools	string[]
	knowledgebases	string[]
	agent_class	string
after
	namespaces	string[]
	name	string
	description	string
	background	string
	user_type	string
	type	string
	config	object
	tools	string[]
	knowledgebases	string[]
	agent_class	string

aisvc.Team

Object	Property	Type
resource
	id	string
	namespaces	string[]
before
	namespaces	string[]
	name	string
	agents	array
	flow	array
	permissionProfileId	string
after
	namespaces	string[]
	name	string
	agents	array
	flow	array
	permissionProfileId	string

aisvc.Tool

Object	Property	Type
resource
	id	string
	namespaces	string[]
before
	namespaces	string[]
	name	string
	description	string
	user_type	string
	tool_class	string
	type	string
after
	namespaces	string[]
	name	string
	description	string
	user_type	string
	tool_class	string
	type	string

aisvc.KnowledgeBase

Object	Property	Type
resource
	id	string
	namespaces	string[]
before
	namespaces	string[]
	user_type	string
	name	string
	vectorized_status	string
	file_id	string
	file_version_id	string
after
	namespaces	string[]
	user_type	string
	name	string
	vectorized_status	string
	file_id	string
	file_version_id	string

aisvc.McpTool

Object	Property	Type
resource
	id	string
	namespaces	string[]
before
	namespaces	string[]
	name	string
	description	string
	script	object
	schema	object
after
	namespaces	string[]
	name	string
	description	string
	script	object
	schema	object

aisvc.McpToolFilter

Object	Property	Type
resource
	id	string
	namespaces	string[]
before
	namespaces	string[]
	name	string
	description	string
	user_type	string
	criteria	object
after
	namespaces	string[]
	name	string
	description	string
	user_type	string
	criteria	object

aisvc.ExternalMcpServerConfig

Object	Property	Type
resource
	id	string
	namespaces	string[]
before
	namespaces	string[]
	name	string
	description	string
	user_type	string
	transport	string
	connection	object
after
	namespaces	string[]
	name	string
	description	string
	user_type	string
	transport	string
	connection	object