Struct AgentId

Namespace

Microsoft.AutoGen.Contracts

Assembly

Microsoft.AutoGen.Contracts.dll

public struct AgentId

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

AgentId(AgentType, string)

Initializes a new instance of the AgentId struct from an AgentType.

public AgentId(AgentType type, string key)

Parameters

type AgentType

The agent type.

key string

Agent instance identifier.

AgentId(string, string)

Initializes a new instance of the AgentId struct.

public AgentId(string type, string key)

Parameters

type string

The agent type.

key string

Agent instance identifier.

AgentId((string Type, string Key))

Initializes a new instance of the AgentId struct from a tuple.

public AgentId((string Type, string Key) kvPair)

Parameters

kvPair (string Type, string Key)

A tuple containing the agent type and key.

Fields

Key

Agent instance identifier. Strings may only be composed of alphanumeric letters (a-z) and (0-9), or underscores (_).

public string Key

Field Value

string

Type

An identifier that associates an agent with a specific factory function. Strings may only be composed of alphanumeric letters (a-z) and (0-9), or underscores (_).

public string Type

Field Value

string

Methods

Equals(object?)

Determines whether the specified object is equal to the current AgentId.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if the specified object is equal to the current AgentId; otherwise, false.

FromStr(string)

Convert a string of the format "type/key" into an AgentId.

public static AgentId FromStr(string maybeAgentId)

Parameters

maybeAgentId string

The agent ID string.

Returns

AgentId

An instance of AgentId.

GetHashCode()

Returns a hash code for this AgentId.

public override int GetHashCode()

Returns

int

A hash code for the current instance.

ToString()

Returns the string representation of the AgentId.

public override string ToString()

Returns

string

A string in the format "type/key".

Operators

operator ==(AgentId, AgentId)

public static bool operator ==(AgentId left, AgentId right)

Parameters

left AgentId

right AgentId

Returns

bool

explicit operator AgentId(string)

Explicitly converts a string to an AgentId.

public static explicit operator AgentId(string id)

Parameters

id string

The string representation of an agent ID.

Returns

AgentId

An instance of AgentId.

operator !=(AgentId, AgentId)

public static bool operator !=(AgentId left, AgentId right)

Parameters

left AgentId

right AgentId

Returns

bool