Class Identification

Represents identification information for an agent or conversant

Example

const identification = new Identification({
  speakerUri: 'tag:example.com,2025:agent1',
  serviceUrl: 'https://example.com/agent',
  organization: 'Example Corp',
  conversationalName: 'Assistant',
  synopsis: 'Helpful AI assistant'
});

Implements

JsonSerializable

Index

Constructors

constructor

new Identification(options: IdentificationOptions): Identification
Creates a new Identification instance
Parameters
- options: IdentificationOptions
  Identification configuration options
Returns Identification
Throws
Error if required fields are missing or invalid
- Defined in envelope.ts:107

Properties

`Optional` `Readonly`conversationalName

conversationalName?: string

`Optional` `Readonly`department

department?: string

`Optional` `Readonly`organization

organization?: string

`Optional` `Readonly`role

role?: string

`Readonly`serviceUrl

serviceUrl: string

`Readonly`speakerUri

speakerUri: string

`Optional` `Readonly`synopsis

synopsis?: string

Methods

toJSON

toJSON(): string
Convert to JSON string

Returns string
Implementation of JsonSerializable.toJSON
- Defined in envelope.ts:138

toObject

toObject(): Record<string, unknown>
Convert to plain object

Returns Record<string, unknown>
Implementation of JsonSerializable.toObject
- Defined in envelope.ts:123

`Static`fromObject

fromObject(data: Record<string, unknown>): Identification
Parameters
- data: Record<string, unknown>
Returns Identification
- Defined in envelope.ts:142

Class Identification

Example

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Identification

Throws

Properties

`Optional` `Readonly`conversationalName

`Optional` `Readonly`department

`Optional` `Readonly`organization

`Optional` `Readonly`role

`Readonly`serviceUrl

`Readonly`speakerUri

`Optional` `Readonly`synopsis

Methods

toJSON

Returns string

toObject

Returns Record<string, unknown>

`Static`fromObject

Parameters

Returns Identification

Settings

On This Page

Class Identification

Example

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Identification

Throws

Properties

Optional ReadonlyconversationalName

Optional Readonlydepartment

Optional Readonlyorganization

Optional Readonlyrole

ReadonlyserviceUrl

ReadonlyspeakerUri

Optional Readonlysynopsis

Methods

toJSON

Returns string

toObject

Returns Record<string, unknown>

StaticfromObject

Parameters

Returns Identification

Settings

On This Page

`Optional` `Readonly`conversationalName

`Optional` `Readonly`department

`Optional` `Readonly`organization

`Optional` `Readonly`role

`Readonly`serviceUrl

`Readonly`speakerUri

`Optional` `Readonly`synopsis

`Static`fromObject