Class LLMCompletionRequest

Namespace

FoundationaLLM.Common.Models.Orchestration.Request

Assembly

FoundationaLLM.Common.dll

The completion request sent by the Orchestration API to any of the downstream orchestrator APIs.

public class LLMCompletionRequest : CompletionRequestBase

Inheritance

object

CompletionRequestBase

LLMCompletionRequest

Inherited Members

CompletionRequestBase.OperationId

CompletionRequestBase.LongRunningOperation

CompletionRequestBase.SessionId

CompletionRequestBase.UserPrompt

CompletionRequestBase.UserPromptRewrite

CompletionRequestBase.MessageHistory

CompletionRequestBase.FileHistory

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

AIModel

The AIModelBase object from the Objects dictionary. Ensure the Validate method is called before accessing this property.

This object is supposed to be added to the Objects dictionary by the instantiator of this request based on the object identifier set on the agent.

[JsonIgnore]
public AIModelBase AIModel { get; }

Property Value

AIModelBase

AIModelEndpointConfiguration

The APIEndpointConfiguration object from the Objects dictionary corresponding to the AIModelBase object from the same dictionary. Ensure the Validate method is called before accessing this property.

This object is supposed to be added to the Objects dictionary by the instantiator of this request based on the object identifier set on the AIModel object associated with the agent.

[JsonIgnore]
public APIEndpointConfiguration AIModelEndpointConfiguration { get; }

Property Value

APIEndpointConfiguration

Agent

The agent that will process the completion request.

[JsonPropertyName("agent")]
public required AgentBase Agent { get; set; }

Property Value

AgentBase

Attachments

A list of AttachmentProperties objects with the properties of the attachments to include with the orchestration request.

[JsonPropertyName("attachments")]
public List<AttachmentProperties> Attachments { get; init; }

Property Value

List<AttachmentProperties>

IndexingProfiles

The list of IndexingProfile objects from the Objects dictionary. Ensure the Validate method is called before accessing this property.

These objects are supposed to be added to the Objects dictionary by the instantiator of this request based on the object identifiers set on the agent's vectorization settings.

[JsonIgnore]
public List<IndexingProfile>? IndexingProfiles { get; }

Property Value

List<IndexingProfile>

Objects

Dictionary of objects (indexed by names) resulting from exploding object identifiers in the Orchestration API.

Can also contain objects that are not the direct result of exploding an object identifier.

The dictionary supports the following keys:

• /instances/{instanceId}/providers/FoundationaLLM.Prompt/prompts/{name}
• /instances/{instanceId}/providers/FoundationaLLM.AIModel/aiModels/{name}
• /instances/{instanceId}/providers/FoundationaLLM.Configuration/apiEndpointConfigurations/{name}
• /instances/{instanceId}/providers/FoundationaLLM.Vectorization/indexingProfiles/{name}
• /instances/{instanceId}/providers/FoundationaLLM.Vectorization/textEmbeddingProfiles/{name}
• AllAgents

[JsonPropertyName("objects")]
public Dictionary<string, object> Objects { get; set; }

Property Value

Dictionary<string, object>

OtherAgentsDescriptions

The dictionary of other agent descriptions from the Objects dictionary. Ensure the Validate method is called before accessing this property.

This object is supposed to be added to the Objects dictionary by the instantiator of this request based on the descriptions of all agents the calling identity has access to, except for the agent associated with the request.

[JsonIgnore]
public Dictionary<string, string> OtherAgentsDescriptions { get; }

Property Value

Dictionary<string, string>

Prompt

The MultipartPrompt object from the Objects dictionary. Ensure the Validate method is called before accessing this property.

This object is supposed to be added to the Objects dictionary by the instantiator of this request based on the object identifier set on the agent.

[JsonIgnore]
public MultipartPrompt Prompt { get; }

Property Value

MultipartPrompt

TextEmbeddingProfile

The TextEmbeddingProfile object from the Objects dictionary. Ensure the Validate method is called before accessing this property.

This object is supposed to be added to the Objects dictionary by the instantiator of this request based on the object identifier set on the agent's vectorization settings.

[JsonIgnore]
public TextEmbeddingProfile? TextEmbeddingProfile { get; }

Property Value

TextEmbeddingProfile

Methods

Validate()

Validates the content of this LLMCompletionRequest.

public void Validate()

Exceptions

OrchestrationException