Class ChatCompletionRequest

Namespace

Glitch9.AIDevKit.ChatCompletions

Task for generating text using an LLM model. Supports instructions and role-based prompts.

public class ChatCompletionRequest : ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatCompletion>, ILanguageModelRequest, IGenerativeRequest, ISequentialRequest

Inheritance

object

FluentApiRequest<ChatCompletionRequest, ChatCompletion>

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatCompletion>

ChatCompletionRequest

Implements

ILanguageModelRequest

IGenerativeRequest

ISequentialRequest

Inherited Members

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatCompletion>.Messages

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatCompletion>.Stop

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatCompletion>.OutputModalities

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatCompletion>.SetStopSequences(params string[])

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatCompletion>.SetOutputModalities(Modalities)

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatCompletion>.SetResponseFormat(ResponseFormat)

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatCompletion>.SetResponseFormat(Type)

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatCompletion>.AddMessageRange(IEnumerable<Message>)

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatCompletion>.CreateStreamAsyncInternal()

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatCompletion>.GetMessages()

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.ModelType

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.Instructions

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.StartingMessage

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.TopP

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.TopK

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.Temperature

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.TopLogprobs

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.LogitBias

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.Logprobs

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.PresencePenalty

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.FrequencyPenalty

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.MaxOutputTokens

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.ReasoningOptions

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.StreamOptions

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SafetySettings

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.Tools

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.ToolChoice

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.ParallelToolCalls

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.ContainerId

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.ResponseFormat

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetInstructions(string)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetStartingMessage(string)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetSafetySettings(List<SafetySetting>)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetTools(params Tool[])

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetTools(IEnumerable<Tool>)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetToolChoice(ToolChoice)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetTemperature(Temperature)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetTopP(TopP)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetTopK(TopK)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetPresencePenalty(PresencePenalty)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetFrequencyPenalty(FrequencyPenalty)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetLogitBias(Dictionary<string, double>)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetLogprobs(Logprobs)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetMaxOutputTokens(TokenCount)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetReasoning(ReasoningOptions)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetReasoning(ReasoningEffort, ReasoningOptions.SummaryLevel?)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetReasoning(ReasoningEffort, TokenCount, bool)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetReasoning(ReasoningFormat)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.SetReasoning(TokenCount)

LanguageModelRequest<ChatCompletionRequest, Message, ChatCompletion>.AddMessage(params Message[])

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.ModelType

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.Api

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.Prompt

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.Model

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.SaveOutputs

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.RecordId

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.OutputFileNote

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.RecordHistory

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.ArchiveHistory

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.MeasureLatency

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.OnLatencyMeasured

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.RequestedAt

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.Seed

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.N

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.MaxN

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.OnRecordCreated

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.RecordMergeOptions

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.SetModel(Api, string)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.SetModel(Model)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.SetCount(int)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.SetSeed(long)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.SetOutputPath(string, string)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.SetRecordHistoryOptions(bool?, bool?, string, Message)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.SetMeasureLatency(Action<double>)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.SetMeasureLatency(bool, Action<double>)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.SetRecordMergeOptions(AIRequestRecord, Func<AIRequestRecord, AIRequestRecord, AIRequestRecord>)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.SetRecordMergeOptions(RecordMergeOptions)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.SetGeneratorWindowSettings(string, string, bool, Action<double>)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.ExecuteAsync(CancellationToken)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.ExecuteAsyncT<T>(CancellationToken)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.CreateStreamAsync()

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.CreateStreamAsyncInternal()

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.ProcessPostRequestTasks(IGeneratedOutput)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.ResolveOutputPath(string)

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.GetPromptToRecord()

GenerativeRequest<ChatCompletionRequest, Message, ChatCompletion, string, INoopStreamEvent<ChatCompletion>>.GetRequestParameters()

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.Api

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.Type

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.IsWrapperTask

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.Options

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.OutputPath

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.Sender

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.LogLevel

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.RequestMimeType

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.ResponseMimeType

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.IsCanceled

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.Stream

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.Listener

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.SafetyIdentifier

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.ServiceTier

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.Metadata

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.SetSender(string)

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.SetLogLevel(TraceLevel)

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.SetOutputPath(string)

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.SetRequestMimeType(MimeType)

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.SetResponseMimeType(MimeType)

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.SetStream(bool)

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.SetListener(IListener)

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.SetMetadata(ServerDictionary)

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.SetSafetyIdentifier(string)

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.ExecuteAsync(CancellationToken)

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.StreamAsync(IListener, CancellationToken)

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.ExecuteAsyncInternal()

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.ResolveOutputPath(string)

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.ExecuteSequenceAsync<T>(CancellationToken)

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.Cancel()

FluentApiRequest<ChatCompletionRequest, ChatCompletion>.Dispose()

Extension Methods

FluentApiRequestBuilderExt.EnsureStreaming<T>(T)

PerplexityMapper_Input.ToPerplexityRequest(ILanguageModelRequest, bool)

Constructors

ChatCompletionRequest()

public ChatCompletionRequest()

ChatCompletionRequest(Message)

public ChatCompletionRequest(Message prompt)

Parameters

prompt Message

Properties

Type

public override FluentApiRequestType Type { get; }

Property Value

FluentApiRequestType

Methods

ExecuteAsyncInternal()

protected override UniTask<ChatCompletion> ExecuteAsyncInternal()

Returns

UniTask<ChatCompletion>