Skip to content

AgentPrism.Abstractions

328 public types. Select a type for signatures, defaults, remarks, exceptions, and links to related contracts.

Type Kind Purpose
AgentDefinition Class The full definition of an agent. The same type is used whether the agent is declared in code or stored in the database; AgentDefinition.Origin tells the two apart.
AgentDefinitionOrigin Enum Tells where an agent definition came from.
AgentDescriptor Class A summary view of an agent listed in the catalog. It carries everything the user interface needs to draw the agent list, without having to build the agent.
AgentPrismCompilationException Class Thrown when an agent definition cannot be turned into a runnable agent.
AgentPrismContentBlockedException Class Thrown when an AgentPrism.IContentGuard blocks content.
AgentPrismContentFilteredException Class Thrown when a model provider cuts the response short with its safety or content filter.
AgentPrismDiagnosticsReport Class Reports the self-diagnostics of the installation.
AgentPrismEgressOptions Class Shared rules for the target address of outbound network requests.
AgentPrismException Class Base class for every error AgentPrism raises.
AgentPrismExternalCallException Class Thrown when an external caller (over MCP or A2A) asked to invoke an agent from the catalog and the call was refused because it crosses a boundary.
AgentPrismGeneratedToolArguments Class The helper methods called by tool wrappers produced by the source generator while converting JSON arguments to CLR types.
AgentPrismId Class UUID version 7 generator for AgentPrism identifiers (RFC 9562).
AgentPrismInboundTriggerOptions Class Options that constrain inbound triggers.
AgentPrismMcpSecurityOptions Class The security boundary applied to stored MCP server definitions.
AgentPrismModelConcurrencyOptions Class Defines the outgoing concurrency limit applied per model provider.
AgentPrismPreflightOptions Class Defines options for the pre-flight context-window check.
AgentPrismProviderUnavailableException Class Thrown when the circuit breaker has temporarily taken a model provider out of service.
AgentPrismRunOptions Class Run options that let the caller determine a run’s identifier, its place in the tree, and its budget.
AgentPrismSchedulingOptions Class Batch and scheduled run settings.
AgentPrismSessionConflictException Class Thrown for the losing request when two concurrent first requests arrive for the same new session id.
AgentPrismSessionStateKeys Class The stable keys AgentPrism uses in an AgentSession state bag.
AgentPrismTenantProviderOptions Class Options that constrain per-tenant model provider bindings (BYOK).
AgentPrismToolAttribute Class Marks a method as a tool. AddToolsFrom registers only methods carrying this attribute.
AgentPrismToolRegistration Class A single tool registered with dependency injection. AgentPrism builds the tool registry from these registrations.
AgentPrismToolTimeoutException Class Thrown when a tool call does not settle within its configured timeout.
AgentResponseFormat Class The definition of a structured output.
AgentResponseFormatKind Enum The requested format of an agent response.
AgentRunBudget Class A run budget shared across an entire call tree.
AgentSkillDefinition Class A markdown-based skill definition that can be loaded into an agent at run time.
AgentSkillResourceDefinition Class A readable resource carried with an AgentPrism.AgentSkillDefinition.
AgentSkillScriptDefinition Class A server-executable script stored together with an AgentPrism.AgentSkillDefinition.
AgentValidationReport Class The result of a validation that builds an agent definition without saving it and without calling any model.
AmbientRunAttributionScope Class The ambient pass-through for attributing a run that does not run inside an HTTP request to a user and a set of labels.
AmbientTenantScope Class The ambient passing mechanism for running an operation executed in the background (outside an HTTP request) as a specific tenant.
ApiKeyCreationResult Class The result of a key creation operation.
ApiKeyDraft Class A draft for creating an API key.
ApiKeyRecord Class An API key’s database-stored view, which CARRIES no raw VALUE.
ApiKeyScope Enum An authority scope an API key may open.
ApprovalStatus Enum The status of a pending approval request.
ArchiveRow Class The JSON representation of a single row to write to the archive.
AttachmentContent Class The content of a new attachment to be saved into the store.
AttachmentDescriptor Class The metadata of an uploaded attachment.
AttachmentQuery Class The filter used to list attachments.
AuditChainQuery Class The criteria that scope a hash chain verification.
AuditChainStatus Enum The result of walking a tenant’s audit trail hash chain.
AuditChainVerification Class The result of verifying one tenant’s audit trail hash chain.
AuditEntry Class A row in the audit trail that records who changed which entity and when.
AuditQuery Class The criteria that filter an audit trail query.
CanaryDecisionKind Enum Defines the outcome of a canary evaluation.
CanaryEvaluation Class Represents the result of evaluating a canary policy against the current results of the canary and control variants.
CanaryPolicy Class Defines automatic rollback and gradual traffic-increase rules for an experiment canary variant.
ChatHistoryState Class The state the chat history provider stores within a session.
CompactionSettings Class Determines how an agent compacts its conversation history.
CompactionStrategyKind Enum The kind of context compaction strategy that can be bound to an agent definition.
ConfigurationDiagnostic Class Reports whether a configuration key resolves. It does not carry the value.
ContentGuardAction Enum The decision a guard can make.
ContentGuardContext Class The context of an AgentPrism.IContentGuard call.
ContentGuardDirection Enum The direction of a content guard check.
ContentGuardResult Class The result of an AgentPrism.IContentGuard check.
ContextWindowEstimate Class The result of a pre-flight context-window check, computed without calling the model provider.
ConversationBranch Struct A conversation branch’s store-level result.
DataSubjectErasureResult Class The outcome of a data subject erasure request.
DataSubjectExport Class A data subject’s exported content.
DataSubjectScope Class The sessions, runs, and conversations that belong to one data subject.
EvalCase Class A single test case inside an AgentPrism.EvalSuite.
EvalCaseAddResult Class The result of IEvalStore.AddCaseAsync.
EvalCaseDraft Class Carrier for adding a single AgentPrism.EvalCase.
EvalCaseResult Class The result of a single AgentPrism.EvalCase within an AgentPrism.EvalRun.
EvalCaseSource Enum The reason an AgentPrism.EvalCase was promoted from a production run.
EvalRun Class A single execution record and summary of an AgentPrism.EvalSuite.
EvalRunCompletion Class The information needed to finalize a run.
EvalRunQuery Class A query for filtering the run list.
EvalRunStatus Enum The status of an eval run.
EvalSuite Class An evaluation (eval) suite defined for an agent: carries which agent is measured, with which checks.
Experiment Class Represents an A/B experiment that splits traffic between two or more definition versions of the same agent.
ExperimentAssignment Class Represents the experiment variant to which a run request is deterministically assigned.
ExperimentResultsQuery Class Defines a query for experiment results.
ExperimentStatus Enum Defines the lifecycle status of an A/B experiment.
ExperimentVariant Class Defines one experiment variant: its definition version and traffic weight.
ExperimentVariantResult Class Summarizes run results for an experiment variant (calculated in the store).
HarnessSettings Class Settings for the harness capabilities. It mirrors a safe subset of the HarnessAgentOptions structure of Microsoft Agent Framework.
IAgentCatalog Interface The catalog that joins every agent source into a single view. The user interface and the HTTP layer reach agents only through this interface.
IAgentDecorator Interface A decorator applied to every agent resolved from the catalog. AgentPrism adds run recording through this mechanism; a consumer can register its own decorator the.
IAgentDefinitionStore Interface The store for agent definitions kept in the database. Versioning and rollback support are required: every save produces a new version, and old versions are not.
IAgentSkillStore Interface The store for a tenant’s run-time skill definitions.
IAgentSource Interface A source the catalog collects agents from. AgentPrism joins several sources into one catalog: the ones declared in code, the ones stored in the database and.
IApiKeyStore Interface The store for per-tenant API keys.
IArchiveSink Interface The cold-storage extension point rows are written to before deletion.
IAttachmentStorage Interface The extension point that stores attachment content in an external store (S3, Blob).
IAttachmentStore Interface The contract for attachment metadata and for the default (database) content storage.
IAuditActorResolver Interface Resolves the actor (the who) of the current call.
IAuditDecorated Interface Exposes the real store implementation an audit trail decorator wraps.
IAuditLog Interface The audit trail log.
IContentGuard Interface The extension point that inspects content going to and coming from the model.
IConversationBranchStore Interface The store that branches a conversation by copying it.
IDataSubjectResolver Interface Maps a data subject (an end user, in the consumer’s own identity system) to the sessions, runs, and conversations that belong to them.
IDataSubjectStore Interface The data plane that counts, exports, and erases one data subject’s content across the schema.
IdempotencyRequest Class An idempotency reservation request.
IdempotencyReservation Class The result of an IIdempotencyStore.ReserveAsync call.
IdempotencyResponse Class The stored HTTP response.
IdempotencyState Enum The four possible states of an idempotency key.
IEvalStore Interface The store for evaluation (eval) suites, cases, and runs.
IExperimentStore Interface Defines the store for A/B experiments.
IIdempotencyStore Interface The store for idempotency records.
IInboundTriggerStore Interface The store for inbound trigger definitions.
IJobHandler Interface The extension point that provides job execution logic for a specific AgentPrism.JobKind.
IJobScheduleStore Interface The store for schedule definitions.
IJobStore Interface The store for queued jobs and their items.
IMcpOAuthCoordinator Interface The coordinator that manages the OAuth Mode 1 (authorization code) flow for MCP servers.
IMcpPromptClient Interface The client that lists an MCP server’s prompts and resolves their content.
IMcpResourceClient Interface The client that lists and reads an MCP server’s resources.
IMcpResourceContextProviderFactory Interface The factory that builds an AI.AIContextProvider for AgentDefinition.McpResourceUris (Mode A).
IMcpServerStore Interface The store for registered MCP servers.
IMcpToolRefresher Interface Refreshes the tool list of remote MCP servers on demand.
IModelProvider Interface A model provider. Each provider is implemented in its own package (for example, AgentPrism.OpenAI) and registered with DI.
IModelProviderConfigurationDiagnostics Interface Defines optional configuration diagnostics for a model provider.
IModelProviderHealthCheck Interface The optional health-check contract for a model provider.
IModelProviderRegistry Interface The registry that keeps registered model providers by name.
InboundTrigger Class An inbound trigger definition: an external event that starts a queued run.
InboundTriggerPayloadMode Enum How an inbound trigger’s request body becomes the agent/workflow message.
InboundTriggerTargetKind Enum What kind of target an inbound trigger fires.
IPendingApprovalStore Interface The store for pending approval requests.
IQuotaStore Interface The store for quota rules and consumption counters.
IRetentionPolicyStore Interface The control-plane store for retention policies and run history.
IRetentionStore Interface The data plane that counts, batch-deletes, and reads-for-archive over the actual retention data.
IRunAttributionContext Interface Resolves who a run belongs to and what work it was made for.
IRunCancellationRegistry Interface The in-memory registry of runs in progress on this instance; binds an incoming cancellation request to the running run’s Threading.CancellationTokenSource.
IRunErrorClassifier Interface Converts a raw run error into a class and a clustering fingerprint.
IRunEventSink Interface Receives run events as they are written, in addition to AgentPrism.IRunStore.
IRunInputStore Interface Stores a run’s input messages. The source of replay.
IRunJudge Interface The extension point that scores a completed production run.
IRunPricingResolver Interface Computes the cost from a model+usage pair. Pricing order: the model catalog, then the AgentPrism:Pricing configuration.
IRunScoreStore Interface The store for run and message scores (AgentPrism.RunScore).
IRunStore Interface Store for run records and the event stream.
ISessionStore Interface The store for serialized agent sessions.
ISingletonLeaseStore Interface The lease store that keeps a named job running on a single instance across the cluster.
ISkillScriptGrantStore Interface The store for skill script execution grants.
ISpeechSynthesizer Interface A provider that generates speech from text.
ISpeechTranscriber Interface A provider that transcribes speech to text.
ISqlPersistenceDiagnostics Interface Defines optional diagnostics for the active SQL persistence provider.
ITenantContext Interface Resolves the current request’s tenant. In a single-tenant setup, returns a fixed value and requires no additional configuration.
ITenantEgressPolicyStore Interface The store for per-tenant model provider egress policies.
ITenantProviderBindingStore Interface The store for per-tenant model provider bindings (BYOK).
ITenantStore Interface The store for tenant registrations.
IToolApprovalRuleStore Interface The store for persistent approval rules.
IToolAuthorizationHandler Interface Decides whether a tenant/user may call a specific tool.
IToolRegistry Interface The registry of tools registered in code.
ITraceStore Interface The store for persisted spans.
IVectorSearchStore Interface The embedding-based semantic search store.
IVersionedAgentSource Interface An AgentPrism.IAgentSource that can resolve a specific definition version. Only sources that keep a version history implement it (the database source); the code.
IVoiceHealthCheck Interface Checks the voice provider’s reachability.
IVoicePricingReader Interface Reads the configured voice model’s pricing.
IVoiceSessionStore Interface Stores the summary record of real-time voice connections.
IWebhookPublisher Interface The component that publishes an event to its subscriptions.
IWebhookStore Interface The store for webhook subscriptions and delivery history.
IWorkflowCheckpointStore Interface The store for workflow checkpoints.
IWorkflowDefinitionStore Interface The store for workflow definitions stored in the database.
IWorkflowFunctionCatalog Interface The registry of workflow function nodes registered in code.
IWorkflowRunner Interface Reads the workflow catalog and runs workflows.
JobCompletion Class The information needed to finalize a job.
JobContext Class The context available during an AgentPrism.IJobHandler execution.
JobItemRecord Class A single input of a batch job and that input’s processing result.
JobItemResult Class The result of a processed job item. Reported with IJobStore.ReportItemAsync.
JobItemStatus Enum The status of a batch job item.
JobKind Enum What target a job runs.
JobPayload Class Extracts the job item input list from the free-form JSON in JobRecord.Payload/JobSchedule.Payload.
JobQuery Class A filter for querying the job list.
JobRecord Class The summary of a queued job. The header of its items (AgentPrism.JobItemRecord).
JobRetryException Class The exception an AgentPrism.IJobHandler throws to signal that it wants the job retried after a specific delay.
JobSchedule Class The schedule record defining when and how a job runs.
JobStatus Enum The status of a queued job.
McpOAuthAuthorizationMode Enum The MCP OAuth authorization flow.
McpOAuthCompleteResult Class The result of the OAuth callback.
McpOAuthOperationStatus Enum The result status of an OAuth authorization request.
McpOAuthStartResult Class The result of an OAuth start request.
McpOperationStatus Enum The result status of an MCP request.
McpPromptArgumentSummary Class The summary of an MCP prompt argument.
McpPromptContent Class The resolved content of a prompt.
McpPromptListResult Class The result of listing prompts.
McpPromptSummary Class The summary of an MCP prompt.
McpRefreshOutcome Struct The result of an IMcpToolRefresher.RefreshAsync call.
McpResourceContent Class The content of a resource that was read.
McpResourceListResult Class The result of listing resources.
McpResourceSummary Class The summary of an MCP resource.
McpServerDefinition Class A registered remote MCP server. Its tools are discovered at connection time and listed alongside the tools registered in code.
McpTransportMode Enum The way a connection to an MCP server is made.
MemorySettings Class Determines the memory providers bound to an agent.
ModelBinding Class Determines the provider and the model an agent runs with. It carries no credentials; the API key is resolved from configuration.
ModelDescriptor Class A model’s capabilities and limits.
ModelFallback Class One link of a ModelBinding.Fallbacks chain.
ModelProviderCredential Class A resolved, in-memory credential used to call a model provider on behalf of a specific tenant.
ModelProviderDescriptor Class A provider’s definition as shown in the UI.
ModelProviderHealth Class A model provider’s status at the last check.
ModelProviderHealthStatus Enum A provider’s checked reachability status.
ModelProviderSettings Class Helpers that read and validate the ModelBinding.ProviderSettings dictionary.
PendingApproval Class The pending tool approval request of a run that executes from the queue.
PricingSource Enum Reports where a run’s cost pricing came from.
ProviderDiagnostic Class Summarizes diagnostics for a model provider.
QuotaConsumption Class The consumption of a completed run to add to the quota counters.
QuotaDecision Class The result of a quota check.
QuotaDefinition Class A quota rule defined for a tenant or an agent.
QuotaMetric Enum The metric a quota is exceeded by.
QuotaPeriod Enum The interval at which a quota’s counter resets.
QuotaUsageQuery Class A filter for querying quota usage.
QuotaUsageRecord Class A scope’s consumption in the current period.
ReplayToolMismatchException Class Replay could not find a recorded tool result.
ReplayToolMode Enum How tools are handled during replay.
RetentionPolicy Class An age- and volume-based retention rule for a target.
RetentionPreview Class A preview of “how many rows would be deleted if run now” for a target.
RetentionRun Class The history record of a cleanup run.
RetentionTargets Class The fixed table list a retention policy may target.
RunAgentStatistics Class An agent’s run summary.
RunAttributionReader Class Reads an AgentPrism.IRunAttributionContext safely on a recording path.
RunCompletion Class Everything needed to close a run.
RunCost Class Cost of a run. It is computed and written once when the run ends (a price snapshot) — a later change to the price list does not change past values.
RunCostRecalculationResult Class Result of a cost recalculation.
RunError Class Error information for a failed run.
RunErrorClass Enum A run error’s class.
RunErrorClassification Class The result of an AgentPrism.IRunErrorClassifier classification.
RunErrorCluster Class The summary of runs sharing the same fingerprint.
RunErrorStatistics Class An error class’s summary.
RunEvent Class A single event produced during a run. Events are append-only: they are never updated, only added.
RunEventType Enum Event types produced during a run. The user interface maps these directly onto visual elements, so the values must stay stable.
RunInputRecord Class A run’s stored input.
RunJudgeContext Class The context the judge sees.
RunJudgment Class The judge’s verdict.
RunKind Enum Reports what a runs row records.
RunLabels Class The limits a run’s attribution must obey, and the single place they are enforced.
RunLabelStatistics Class A label’s run summary; one entry per distinct key/value pair.
RunModelStatistics Class A model’s run summary. The input to cost computation.
RunQuery Class Query used to filter the run list.
RunReconciliationOptions Class Orphaned-run reconciliation settings.
RunRecord Class Summary of a run. It acts as the header of the event stream.
RunReplayRequest Class A replay request.
RunScore Class A human (or judge) score for a run or for a single message within a run.
RunScoreKind Enum The shape of the value a AgentPrism.RunScore carries.
RunStartInfo Class Everything needed to open a new run.
RunStatistics Class A summary of the runs in a time range.
RunStatisticsQuery Class The filter for a run statistics query.
RunStatus Enum Status of a run.
RunTimeSeriesBucketing Class The shared pure logic for time-series bucket computation. Both InMemoryRunStore and PostgresRunStore use this type, so the bucket limit and rounding rules never.
RunTimeSeriesQuery Class Filter for a time-series query.
RunTrace Class A run’s span tree. The waterfall view is built on top of this.
RunTreeCost Class Total cost of a run tree (the root plus every child run).
RunUsage Class Token usage of a run.
RunUserStatistics Class A user’s run summary.
RunVersionStatistics Class A definition version’s run summary.
SchemaReadyGate Class Delays background services until the SQL schema is ready.
SessionBranchRequest Class A request to branch a conversation from a specific point.
SessionBranchResult Class The result of branching.
SessionQuery Class A filter for querying the session list.
SessionRecord Class A stored session.
SingletonExecutionOptions Class The settings of single-executor election.
SkillScriptGrant Class The record carrying permission to execute a skill script.
SpeakRequest Class A speech synthesis request as an operator action.
SpeakResponse Class The result of speech synthesis.
SpeechAlignment Class One character’s position in the generated audio.
SpeechAudio Class Generated audio.
SpeechRequest Class A text-to-speech generation request.
SpeechTranscript Class The result of speech-to-text conversion.
SpeechTranscriptionOptions Class Speech-to-text conversion settings.
SpeechUsageSource Enum The source of a speech measurement.
SqlPersistenceDiagnosticsSnapshot Class Represents the current connection and migration status of an SQL persistence provider.
SqlPersistenceRegistrationMarker Class Marks a registered SQL persistence provider.
TenantDescriptor Class A registered tenant.
TenantEgressPolicy Class The set of model providers a tenant’s agents are allowed to call (egress policy).
TenantProviderBinding Class Binds a tenant to a model provider’s credential, by name only.
TimeSeriesBucket Enum The bucket width for a time-series query.
TimeSeriesPoint Class A summary of the runs in a time bucket. The result unit of /api/stats/timeseries; empty buckets are also returned (with zero events).
ToolApprovalContext Class The tool call a code-defined approval policy judges. Read-only.
ToolApprovalPolicyDecision Enum The outcome of a code-defined approval policy (AgentPrism.ToolApprovalContext).
ToolApprovalRule Class A persistent approval rule for a tool call the user said “do not ask again” for.
ToolArgumentCondition Class One comparison against a tool call argument: path · operator · value.
ToolArgumentConditionLimits Class The size limits that keep AgentPrism.ToolArgumentCondition a comparison, not a rule engine.
ToolArgumentOperator Enum A comparison operator for a AgentPrism.ToolArgumentCondition.
ToolAuthorizationRequest Class Describes one tool call awaiting an authorization decision.
ToolAuthorizationResult Class The outcome of an authorization decision.
ToolCallUsage Class A single tool call’s non-token measurement and cost.
ToolDescriptor Class The UI-facing definition of a tool registered in code. The agent editor shows a selection from this list; it does not accept free-text input.
ToolEffect Enum Classifies the blast radius of a tool call.
ToolInvocationRecord Class The summary of a single completed tool call.
ToolUsage Class A tool’s usage summary. Shown by the UI’s Tools screen.
ToolUsageQuery Class The filter for a tool usage summary.
ToolUsageUnits Class The known unit names for ToolCallUsage.Unit.
TraceSpan Class A single persisted OpenTelemetry span.
TraceSpanBatch Class A span set belonging to a single trace.
TraceSpanKind Enum A span’s OpenTelemetry kind. Values are stored in the database as smallint; the numbers are stable.
TraceSpanStatus Enum A span’s result status. smallint in the database.
ValidationMessage Class A single finding produced by the validation of an agent definition.
ValidationSeverity Enum The severity of a AgentPrism.ValidationMessage.
VectorChunk Class A single chunk to write.
VectorSearchHit Class A single search result.
VectorSearchRequest Class A semantic search request.
VoiceDescriptor Class The definition of an available voice.
VoiceHealth Class The voice provider’s reachability status.
VoiceSessionEndReason Enum The reason a voice connection closed.
VoiceSessionQuery Class The filter for listing voice session records.
VoiceSessionRecord Class The summary record of a real-time voice connection.
WebhookApprovalSummary Class A pending approval or human-input request’s webhook summary.
WebhookDelivery Class A single delivery record.
WebhookDeliveryQuery Class A filter for querying delivery history.
WebhookDeliveryResult Class The result of a delivery attempt.
WebhookDeliveryStatus Enum The status of a webhook delivery attempt.
WebhookEventPayload Class The JSON body of a webhook request.
WebhookEventPayloadJsonContext Class The source-generated JSON context for WebhookEventPayloadJsonContext.WebhookEventPayload and its subtypes.
WebhookEvents Class The event types AgentPrism can publish.
WebhookJobSummary Class A job’s webhook summary.
WebhookQuotaSummary Class An exceeded quota threshold’s webhook summary.
WebhookRunSummary Class A run’s webhook summary.
WebhookScoreSummary Class A score window threshold’s webhook summary.
WebhookSubscription Class An external system’s event subscription.
WorkflowCheckpointRecord Class Represents a single checkpoint of a workflow run.
WorkflowCheckpointState Class Provides shared constants for checkpoint state.
WorkflowDefinition Class Represents the full definition of a workflow, whether defined through the UI or in code.
WorkflowDescriptor Class Represents a summary view of a workflow listed in the catalog.
WorkflowEdgeKind Enum Represents the kind of an edge.
WorkflowFunctionDescriptor Class Describes a function node registered in code.
WorkflowGraph Class Represents a workflow’s compiled graph: nodes, edges, and external request ports.
WorkflowGraphEdge Class Represents the connection between two nodes.
WorkflowGraphNode Class Represents a node in the graph.
WorkflowKind Enum Represents the built-in workflow patterns that can be defined through the UI.
WorkflowNodeKind Enum Represents the role of a graph node.
WorkflowNodeReference Class Points to a single node entering a workflow’s graph: an agent from the catalog, or a function registered in code.
WorkflowPendingRequest Class Represents human input awaited by a workflow run.
WorkflowRequestForm Enum Defines how the UI presents a pending request.
WorkflowRespondRequest Class Represents a response to a pending request.
WorkflowResumeRequest Class The information needed to resume a workflow from a checkpoint.
WorkflowRunRequest Class The information needed to run a workflow.