Class LongRunningOperationContext

Namespace

FoundationaLLM.Common.Models.Orchestration

Assembly

FoundationaLLM.Common.dll

Provides a context for long-running operations.

public class LongRunningOperationContext

Inheritance

object

LongRunningOperationContext

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Properties

AgentMessageId

Gets or sets the identifier of the agent response message sent to the user during the long-running operation.

[JsonProperty("agentMessageId")]
public required string AgentMessageId { get; set; }

Property Value

string

AgentName

Gets or sets the name of the agent that runs the long-running operation.

[JsonProperty("agentName")]
public required string AgentName { get; set; }

Property Value

string

AgentWorkflowMainAIModelAPIEndpoint

The API endpoint URL of the main AI model used by the agent workflow.

[JsonProperty("agentWorkflowMainAIModelAPIEndpoint")]
public string? AgentWorkflowMainAIModelAPIEndpoint { get; set; }

Property Value

string

CompletionPromptId

Gets or sets the identifier of the completion prompt used in the long-running operation.

[JsonProperty("completionPromptId")]
public required string CompletionPromptId { get; set; }

Property Value

string

GatekeeperOptions

Gets or sets a list of Gatekeeper feature names used by the orchestration request.

[JsonProperty("gatekeeperOptions")]
public string[] GatekeeperOptions { get; set; }

Property Value

string[]

GatekeeperOverride

Gets or sets the Gatekeeper override option.

[JsonProperty("gatekeeperOverride")]
[JsonConverter(typeof(StringEnumConverter))]
public AgentGatekeeperOverrideOption GatekeeperOverride { get; set; }

Property Value

AgentGatekeeperOverrideOption

InstanceId

Gets or sets the FoundationaLLM instance identifier.

[JsonProperty("instanceId")]
public required string InstanceId { get; set; }

Property Value

string

OperationId

Gets or sets the identifier of the long-running operation.

[JsonProperty("id")]
public required string OperationId { get; set; }

Property Value

string

Orchestrator

Gets or sets the name of the orchestrator used in the long-running operation.

[JsonProperty("orchestrator")]
public string? Orchestrator { get; set; }

Property Value

string

SemanticCacheSettings

Gets or sets the settings for the semantic cache.

[JsonProperty("semanticCacheSettings")]
public AgentSemanticCacheSettings? SemanticCacheSettings { get; set; }

Property Value

AgentSemanticCacheSettings

SessionId

Gets or sets the identifier of the session in which the long-running operation runs.

[JsonProperty("sessionId")]
public required string SessionId { get; set; }

Property Value

string

StartTime

Gets or sets the start time of the long-running operation.

[JsonProperty("startTime")]
public DateTime StartTime { get; set; }

Property Value

DateTime

StatusUpdateIteration

Gets or sets the iteration number of the long-running operation.

[JsonProperty("statusUpdateIteration")]
public int StatusUpdateIteration { get; set; }

Property Value

int

TTL

Gets or sets the Time to Live (TTL) of the long-running operation.

[JsonProperty("ttl")]
public int TTL { get; set; }

Property Value

int

UPN

Gets or sets the User Principal Name (UPN) of the user who triggered the long-running operation.

[JsonProperty("upn")]
public required string UPN { get; set; }

Property Value

string

UserMessageId

Gets or sets the identifier of the user message that triggered the long-running operation.

[JsonProperty("userMessageId")]
public required string UserMessageId { get; set; }

Property Value

string