AgentRunScope
AgentPrism.Core.dllRepresents the view of a running run that is exposed to the helper components in the run path.
public sealed record AgentRunScope : IEquatable<AgentRunScope>Inheritance
Section titled “Inheritance”Implements
Section titled “Implements”Inherited Members
Section titled “Inherited Members”object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Remarks
Section titled “Remarks”The scope is opened by RunRecordingAgent. A sub-agent invocation builds its own AgentPrismRunOptions object from the values it reads here; this is how tree linkage, depth, and budget are carried through the call chain.
Constructors
Section titled “Constructors”AgentRunScope()
Section titled “ AgentRunScope()”public AgentRunScope()Properties
Section titled “Properties”AgentName
Section titled “ AgentName”Gets the name of the agent running this run.
public string? AgentName { get; init; }Property Value
Section titled “Property Value”AgentVersion
Section titled “ AgentVersion”Gets the definition version this run measures. null if unknown.
public int? AgentVersion { get; init; }Property Value
Section titled “Property Value”int?
Budget
Section titled “ Budget”Gets the budget shared across the tree.
public AgentRunBudget? Budget { get; init; }Property Value
Section titled “Property Value”Gets the depth in the tree. The root run is 0.
public int Depth { get; init; }Property Value
Section titled “Property Value”ExperimentId
Section titled “ ExperimentId”Gets the identity of the experiment this run belongs to. null for a run outside an experiment.
public Guid? ExperimentId { get; init; }Property Value
Section titled “Property Value”Guid?
RootRunId
Section titled “ RootRunId”Gets the identity of the run at the root of the tree. Equal to AgentRunScope.RunId at the root.
public required Guid RootRunId { get; init; }Property Value
Section titled “Property Value”Gets the identity of the running run.
public required Guid RunId { get; init; }Property Value
Section titled “Property Value”SessionId
Section titled “ SessionId”Gets the session the run belongs to. null for a sessionless run.
public string? SessionId { get; init; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”Content that a tool produces and writes to the attachments
table MUST CARRY this field. The retention policy treats an
attachment with an empty session_id field as orphaned
and deletes it after the cutoff date; the content in the transcript is
then lost while the session is still alive. A tool cannot access
AgentSession, so this is the only place it can read the session
identity from.
TenantId
Section titled “ TenantId”Gets the tenant of the run. A sub-run cannot leave this tenant.
public string? TenantId { get; init; }Property Value
Section titled “Property Value”Variant
Section titled “ Variant”Gets the name of the experiment arm this run is assigned to. null for a run outside an experiment.
public string? Variant { get; init; }Property Value
Section titled “Property Value”Writer
Section titled “ Writer”Gets the event writer for this run. A sub-run writes its summary events here.
public RunEventWriter? Writer { get; init; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”The sequence number is produced by a single writer. If a sub-call set up its own writer, the same run would end up with two independent counters and the sequence numbers would collide.
Methods
Section titled “Methods”Equals(object?)
Section titled “ Equals(object?)”public override bool Equals(object? obj)Parameters
Section titled “Parameters”obj object?
Returns
Section titled “Returns”Equals(AgentRunScope?)
Section titled “ Equals(AgentRunScope?)”public bool Equals(AgentRunScope? other)Parameters
Section titled “Parameters”other AgentRunScope?
Returns
Section titled “Returns”GetHashCode()
Section titled “ GetHashCode()”public override int GetHashCode()Returns
Section titled “Returns”ToString()
Section titled “ ToString()”public override string ToString()Returns
Section titled “Returns”Operators
Section titled “Operators”operator ==(AgentRunScope?, AgentRunScope?)
Section titled “ operator ==(AgentRunScope?, AgentRunScope?)”public static bool operator ==(AgentRunScope? left, AgentRunScope? right)Parameters
Section titled “Parameters”left AgentRunScope?
right AgentRunScope?
Returns
Section titled “Returns”operator !=(AgentRunScope?, AgentRunScope?)
Section titled “ operator !=(AgentRunScope?, AgentRunScope?)”public static bool operator !=(AgentRunScope? left, AgentRunScope? right)Parameters
Section titled “Parameters”left AgentRunScope?
right AgentRunScope?