API Reference
classes
Agent

@coasys/ad4m / Exports / Agent

Class: Agent

AD4M's representation of an Agent

AD4M Agents are build around DIDs, which are used to identify and authenticate the Agent. Conceptually, an Agent is regarded as something that can speak and that can listen.

Agents speak by creating Expressions in AD4M Languages which are signed by the Agent's DID key, And they also speak (broadcast) by putting semantic statements into their public "Agent Perspective". They listen (can receive messages) through their "direct message Language".

These three aspects are represented by the three fields of this class.

This class is used as format for the Expressions in the Agent language. Since AD4M treats DID URIs as addresses for the Agent Language, DIDs are resolved to Expressions that are objects of this class. Thus, this is how agents see (other) agents.

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new Agent(did, perspective?)

Parameters

NameType
didstring
perspective?Perspective

Defined in

core/src/agent/Agent.ts:38 (opens in a new tab)

Properties

did

• did: string

The DID of the Agent All epxressions authored by them are signed with the keys mentioned in the DID document behind this DID URI.

Defined in

core/src/agent/Agent.ts:26 (opens in a new tab)


directMessageLanguage

• Optional directMessageLanguage: string

Address of the Language by which the Agent will receive DMs

Defined in

core/src/agent/Agent.ts:36 (opens in a new tab)


perspective

• Optional perspective: Perspective

The Perspective that holds the public-facing semantics/statements of the Agent Holds and shares a Perspective that links all information this agent wants to offer as public-facing semantics. This should be used for any kind of user profile information.

Defined in

core/src/agent/Agent.ts:33 (opens in a new tab)

Methods

fromWire

▸ Static fromWire(wire): Agent

Build an Agent (with its perspective's query helpers) from the executor's wire shape.

Parameters

NameType
wireAgent

Returns

Agent

Defined in

core/src/agent/Agent.ts:48 (opens in a new tab)