Class ChatCompletionRequest

Request for generating chat completions from an LLM model.

Inheritance

object

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>

StreamingGenerativeRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>, ITextRequestOptions>

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatChoice>

ChatCompletionRequest

Implements

IStreamingGenerativeRequest<Delta<ITextChunk>, ChatChoice>

IGenerativeTextRequest

IGenerativeRequest

Inherited Members

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatChoice>.RequestType

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatChoice>.Messages

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatChoice>.OutputModalities

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatChoice>.SetOutputModalities(params Modality[])

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

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

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.ModelType

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.Instructions

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.StartingMessage

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.TopP

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.TopK

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.Temperature

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.TopLogprobs

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.LogitBias

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.Logprobs

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.PresencePenalty

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.FrequencyPenalty

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.MaxTokens

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.ReasoningOptions

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.StreamOptions

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SafetySettings

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.RequestMetadata

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.Tools

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.ToolChoice

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.ParallelToolCalls

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.ResponseFormat

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.Stop

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.WebSearchOptions

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetInstructions(string)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetStartingMessage(string)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetSafetySettings(List<SafetySetting>)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetTools(params Tool[])

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetTools(IEnumerable<Tool>)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetToolChoice(ToolChoice)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetTemperature(Temperature)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetTopP(TopP)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetTopK(TopK)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetPresencePenalty(PresencePenalty)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetFrequencyPenalty(FrequencyPenalty)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetLogitBias(Dictionary<string, double>)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetLogprobs(bool)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetMaxOutputTokens(TokenCount)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetReasoningOptions(ReasoningOptions)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetReasoning(ReasoningEffort, ReasoningSummaryLevel?)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetReasoning(ReasoningEffort, TokenCount, bool)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetReasoning(ReasoningFormat)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetReasoning(TokenCount)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetResponseFormat(ResponseFormat)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetResponseFormat(Type)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetStopSequences(params string[])

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetRequestMetadata(ServerDictionary)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.SetWebSearchOptions(WebSearchSettings)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.AddMessage(params Message[])

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.AddMessageRange(IEnumerable<Message>)

GenerativeTextRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>>.GetMessages()

StreamingGenerativeRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>, ITextRequestOptions>.StreamAsync(CancellationToken)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.ModelType

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.Api

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.Prompt

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.Model

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.N

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.Seed

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.MeasureLatency

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.OnLatencyMeasured

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.RequestedAt

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.RecordOptions

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.RecordedContext

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.SetModel(Api, string)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.SetModel(ModelBase)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.SetCount(int)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.SetN(int)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.SetSeed(long)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.SetRecordOptions(bool?, bool?, string, string, GenerationRecord, RecordMerger, Action<GenerationRecord>)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.SetRecordOptions(GenerationRecordOptions)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.SetMeasureLatency(Action<double>)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.SetMeasureLatency(bool, Action<double>)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.SetPlaygroundSettings(string, string, string, bool, Action<double>, Action<GenerationRecord>)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.ExecuteAsync(CancellationToken)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.ExecuteAsyncT<T>(CancellationToken)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.ProcessPostRequestTasks<T>(Generated<T>)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.ProcessPostRequestTasks(IResult)

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.GetPrompt()

GenerativeRequest<ChatCompletionRequest, Message, ChatChoice, ITextRequestOptions>.GetPromptStringToRecord()

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.Api

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.RequestType

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.HttpOptions

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.DownloadOptions

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.Sender

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.LogOptions

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.ContentType

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.ResponseType

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.IsCanceled

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.Stream

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.SafetyIdentifier

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.ServiceTier

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.Metadata

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.ProviderOptions

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.Options

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.SetSender(string)

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.SetLogOptions(CurlLogOptions)

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.SetOutputPath(string)

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.SetOutputPath(string, string)

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.SetOutputDirectory(string)

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.SetDownloadOptions(DownloadOptions)

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.SetRequestMimeType(MimeType)

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.SetResponseMimeType(MimeType)

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.SetStream(bool)

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.SetMetadata(ServerDictionary)

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.SetSafetyIdentifier(string)

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.SetProviderOptions(ITextRequestOptions)

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.SetSpecificOptions(ITextRequestOptions)

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.GetConfig<T>()

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.ExecuteAsync(CancellationToken)

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.Cancel()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Glitch9.AIDevKit

Assembly: Glitch9.AIDevKit.dll

Syntax

[JsonConverter(typeof(ChatCompletionRequestConverter))]
public sealed class ChatCompletionRequest : ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatChoice>, IStreamingGenerativeRequest<Delta<ITextChunk>, ChatChoice>, IGenerativeTextRequest, IGenerativeRequest

Constructors

ChatCompletionRequest()

Declaration

public ChatCompletionRequest()

ChatCompletionRequest(Message)

Declaration

public ChatCompletionRequest(Message prompt)

Parameters

Type	Name	Description
Message	prompt

Properties

RequestType

The endpoint type for this

Declaration

public override RequestType RequestType { get; }

Property Value

Type	Description
RequestType

Overrides

ChatCompletionRequestBase<ChatCompletionRequest, Message, ChatChoice>.RequestType

Methods

ExecuteAsyncInternal()

Executes the actual task logic. Must be implemented in derived classes.

Declaration

protected override UniTask<Generated<ChatChoice>> ExecuteAsyncInternal()

Returns

Type	Description
UniTask<Generated<ChatChoice>>

Overrides

UnifiedApiRequestBase<ChatCompletionRequest, Generated<ChatChoice>, ITextRequestOptions>.ExecuteAsyncInternal()

StreamAsyncInternal()

Declaration

protected override IGenerativeStream<Delta<ITextChunk>, ChatChoice> StreamAsyncInternal()

Returns

Type	Description
IGenerativeStream<Delta<ITextChunk>, ChatChoice>

Overrides

StreamingGenerativeRequest<ChatCompletionRequest, Message, ChatChoice, Delta<ITextChunk>, ITextRequestOptions>.StreamAsyncInternal()

Implements

IStreamingGenerativeRequest<TEvent, TAsset>

IGenerativeTextRequest

IGenerativeRequest

Extension Methods

ArrayExtensions.ToArrayOrEmpty<T>(T)

ArrayExtensions.ToArrayOrNull<T>(T)

EventExtensions.ToDelta<T>(T, string, int, string, bool)

EventExtensions.ToDone<T>(T, string, int, string)

EventExtensions.ToEvent<T>(T)

EventExtensions.UpcastDelta<T1, T2>(T1, string, int, string, bool)

FallbackExtensions.IsOr<TParent, TChild>(TParent, TChild)

ResponseCastingExtensions.GetResult<T>(T)

SystemExtensions.GetName(object)