Type

The notion of Data Type is central to Agents. Because Agents deal with structured and unstructured data, we need to be able to describe the type of data. The types currently supported by Dataworkz Agents are :

• string: a string of text

• integer: an integer

• boolean: a boolean type that takes values True and False

• decimal: represents floating point numbers or fractional numbers

• Objects with a name that can be composed of other types

A Type has the following properties -

• name such as “string” or “CustomerProfile” or “OrderDetails”

• description that describes the object - e.g. this is the unique id that represents a customer in the system. If you have a limited set of values that the object can take then you can list them here or describe them. E.g. This represents a day of the week OR value can be one of [‘CANCELLED’, ‘COMPLETED’, ‘INPROGRESS]

• fields optional fields that lists other fields for a Type that is an object

To represent a list add [] to the type name - e.g. a list of strings can be represented using string[]

An example of an Object type -

{
	"name": "Customer",
	"description": "The customer object",
	"fields": {
		"name": {
			"type": "string",
			"description": "the name of the customer - in the format <firstname> <lastname>"
		},
		"id": {
			"type": "string",
			"description": "the unique id of the customer in our system"
		},
		"interests": {
			"type": "string[]",
			"description", "A list of interests of this customer"
		}
	}
}