Class CompletionResponseBase

Namespace

FoundationaLLM.Common.Models.Orchestration.Response

Assembly

FoundationaLLM.Common.dll

Base model for a response from a language model.

public class CompletionResponseBase

Inheritance

object

CompletionResponseBase

Derived

CompletionResponse

LLMCompletionResponse

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

AgentName

The name of the FoundationaLLM agent.

[JsonPropertyName("agent_name")]
public string? AgentName { get; set; }

Property Value

string

AnalysisResults

A list of results from the analysis.

[JsonPropertyName("analysis_results")]
public List<AnalysisResult>? AnalysisResults { get; set; }

Property Value

List<AnalysisResult>

Completion

The completion response from the language model.

[JsonPropertyName("completion")]
public string? Completion { get; set; }

Property Value

string

CompletionTokens

The number of tokens in the completion.

[JsonPropertyName("completion_tokens")]
public int CompletionTokens { get; set; }

Property Value

int

Content

Content returned from the Assistants API.

[JsonPropertyName("content")]
public List<MessageContentItemBase>? Content { get; set; }

Property Value

List<MessageContentItemBase>

ContentArtifacts

The sources used in building the completion response.

[JsonPropertyName("content_artifacts")]
public ContentArtifact[]? ContentArtifacts { get; set; }

Property Value

ContentArtifact[]

Deleted

Deleted flag used for soft delete.

[JsonPropertyName("deleted")]
public bool Deleted { get; set; }

Property Value

bool

Errors

An array of error messages that occurred during the completion operation.

[JsonPropertyName("errors")]
public string[]? Errors { get; set; }

Property Value

string[]

FullPrompt

The full prompt composed by the LLM.

[JsonPropertyName("full_prompt")]
public string? FullPrompt { get; set; }

Property Value

string

IsError

Whether the errors collection actually represent a full error condition or not.

[JsonPropertyName("is_error")]
public bool? IsError { get; set; }

Property Value

bool?

OperationId

The Operation ID identifying the completion request.

[JsonPropertyName("operation_id")]
public string OperationId { get; set; }

Property Value

string

PromptTemplate

The prompt template used by the LLM.

[JsonPropertyName("prompt_template")]
public string? PromptTemplate { get; set; }

Property Value

string

PromptTokens

The number of tokens in the prompt.

[JsonPropertyName("prompt_tokens")]
public int PromptTokens { get; set; }

Property Value

int

TotalCost

The total cost of executing the completion operation.

[JsonPropertyName("total_cost")]
public float TotalCost { get; set; }

Property Value

float

TotalTokens

The total number of tokens.

[JsonPropertyName("total_tokens")]
public int TotalTokens { get; }

Property Value

int

UserPrompt

The user prompt the language model responded to.

[JsonPropertyName("user_prompt")]
public string UserPrompt { get; set; }

Property Value

string

UserPromptRewrite

The user prompt rewrite.

[JsonPropertyName("user_prompt_rewrite")]
public string? UserPromptRewrite { get; set; }

Property Value

string