AgentRunRequest
AgentPrism.AspNetCore.dllRequest for a trial run made from the UI.
public sealed record AgentRunRequest : IEquatable<AgentRunRequest>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()
Constructors
Section titled “Constructors”AgentRunRequest()
Section titled “ AgentRunRequest()”public AgentRunRequest()Properties
Section titled “Properties”Approvals
Section titled “ Approvals”Approval decisions for pending tool calls.
public IReadOnlyList<ToolApprovalDecision> Approvals { get; init; }Property Value
Section titled “Property Value”IReadOnlyList<ToolApprovalDecision>
Remarks
Section titled “Remarks”Approval is the input to the next turn: Microsoft
Agent Framework returns a pending call as
ToolApprovalRequestContent in the response, and the decision is
expected in the messages of the next run. There is therefore no
separate “continue” endpoint.
Decisions are processed only when AgentRunRequest.SessionId is given: the pending request lives in the session history and cannot be found in a sessionless run.
AttachmentIds
Section titled “ AttachmentIds”Identifiers of attachments previously uploaded via POST /api/attachments.
public IReadOnlyList<Guid> AttachmentIds { get; init; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”Each identifier must belong to the calling tenant; otherwise the
request is rejected with 400. Binary content is not carried in
the message, only a small reference
(AI.UriContent) is added.
Culture
Section titled “ Culture”The culture to resolve the agent’s instructions with (see
AgentDefinition.InstructionsByCulture). null uses the
agent’s default instructions.
public string? Culture { get; init; }Property Value
Section titled “Property Value”Remarks
Section titled “Remarks”Read only from this field. The Accept-Language HTTP header is
deliberately not consulted: a browser header silently
changing the content sent to the model would be a surprise, and it
conflicts with’s line that server-facing content is not
translated from ambient request state.
Message
Section titled “ Message”User message. May be left empty only if AgentRunRequest.Approvals is sent.
public string? Message { get; init; }Property Value
Section titled “Property Value”SessionId
Section titled “ SessionId”Session identifier. If not given, the run is sessionless and no history is carried.
public string? SessionId { get; init; }Property Value
Section titled “Property Value”ToolResults
Section titled “ ToolResults”Results of client-side tool calls.
public IReadOnlyList<ClientToolResult> ToolResults { get; init; }Property Value
Section titled “Property Value”IReadOnlyList<ClientToolResult>
Remarks
Section titled “Remarks”A client-side tool (AddClientTool) is registered as a
declaration only; the server never runs it. It produces a pending
call the model is waiting on, and the result is the next
turn’s input — the same pattern AgentRunRequest.Approvals
uses for ToolApprovalRequestContent. There is no separate
“continue” endpoint.
Results are processed only when AgentRunRequest.SessionId is given: the pending call lives in the session history and cannot be found in a sessionless run.
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(AgentRunRequest?)
Section titled “ Equals(AgentRunRequest?)”public bool Equals(AgentRunRequest? other)Parameters
Section titled “Parameters”other AgentRunRequest?
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 ==(AgentRunRequest?, AgentRunRequest?)
Section titled “ operator ==(AgentRunRequest?, AgentRunRequest?)”public static bool operator ==(AgentRunRequest? left, AgentRunRequest? right)Parameters
Section titled “Parameters”left AgentRunRequest?
right AgentRunRequest?
Returns
Section titled “Returns”operator !=(AgentRunRequest?, AgentRunRequest?)
Section titled “ operator !=(AgentRunRequest?, AgentRunRequest?)”public static bool operator !=(AgentRunRequest? left, AgentRunRequest? right)Parameters
Section titled “Parameters”left AgentRunRequest?
right AgentRunRequest?