Search Results for

    Show / Hide Table of Contents

    Class ChatCompletionRequestBase<TSelf, TInput, TAsset>

    Inheritance
    object
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>
    StreamingGenerativeRequest<TSelf, TInput, TAsset, Delta<ITextChunk>, ITextRequestOptions>
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>
    ChatCompletionRequestBase<TSelf, TInput, TAsset>
    ChatCompletionRequest
    StructuredOutputRequestBase<TSelf, TAsset>
    Implements
    IStreamingGenerativeRequest<Delta<ITextChunk>, TAsset>
    IGenerativeTextRequest
    IGenerativeRequest
    Inherited Members
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.ModelType
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.Instructions
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.StartingMessage
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.TopP
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.TopK
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.Temperature
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.TopLogprobs
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.LogitBias
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.Logprobs
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.PresencePenalty
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.FrequencyPenalty
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.MaxTokens
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.ReasoningOptions
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.StreamOptions
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SafetySettings
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.RequestMetadata
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.Tools
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.ToolChoice
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.ParallelToolCalls
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.ResponseFormat
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.Stop
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.WebSearchOptions
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetInstructions(string)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetStartingMessage(string)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetSafetySettings(List<SafetySetting>)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetTools(params Tool[])
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetTools(IEnumerable<Tool>)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetToolChoice(ToolChoice)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetTemperature(Temperature)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetTopP(TopP)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetTopK(TopK)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetPresencePenalty(PresencePenalty)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetFrequencyPenalty(FrequencyPenalty)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetLogitBias(Dictionary<string, double>)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetLogprobs(bool)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetMaxOutputTokens(TokenCount)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetReasoningOptions(ReasoningOptions)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetReasoning(ReasoningEffort, ReasoningSummaryLevel?)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetReasoning(ReasoningEffort, TokenCount, bool)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetReasoning(ReasoningFormat)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetReasoning(TokenCount)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetResponseFormat(ResponseFormat)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetResponseFormat(Type)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetStopSequences(params string[])
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetRequestMetadata(ServerDictionary)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.SetWebSearchOptions(WebSearchSettings)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.AddMessage(params Message[])
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.AddMessageRange(IEnumerable<Message>)
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.GetMessages()
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.ValidateRequest()
    StreamingGenerativeRequest<TSelf, TInput, TAsset, Delta<ITextChunk>, ITextRequestOptions>.StreamAsync(CancellationToken)
    StreamingGenerativeRequest<TSelf, TInput, TAsset, Delta<ITextChunk>, ITextRequestOptions>.StreamAsyncInternal()
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.FileNameKey
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.FallbackModel
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.ModelType
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.Api
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.Prompt
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.Model
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.N
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.Seed
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.MeasureLatency
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.OnLatencyMeasured
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.RequestedAt
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.RecordOptions
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.RecordedContext
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.SetModel(Api, string)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.SetModel(ModelBase)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.SetCount(int)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.SetN(int)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.SetSeed(long)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.SetRecordOptions(bool?, bool?, string, string, GenerationRecord, RecordMerger, Action<GenerationRecord>)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.SetRecordOptions(GenerationRecordOptions)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.SetMeasureLatency(Action<double>)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.SetMeasureLatency(bool, Action<double>)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.SetPlaygroundSettings(string, string, string, bool, Action<double>, Action<GenerationRecord>)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.ExecuteAsync(CancellationToken)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.ExecuteAsyncT<T>(CancellationToken)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.ProcessPostRequestTasks<T>(Generated<T>)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.ProcessPostRequestTasks(IResult)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.GetPrompt()
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.GetPromptStringToRecord()
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.ResolveDownloadOptions(DownloadOptions)
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.ValidateRequest()
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.GenerateDefaultFileName()
    GenerativeRequest<TSelf, TInput, TAsset, ITextRequestOptions>.PrepareRequestAsync()
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.m_Api
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.Api
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.RequestType
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.HttpOptions
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.DownloadOptions
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.Sender
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.LogOptions
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.ContentType
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.ResponseType
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.IsCanceled
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.Stream
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SafetyIdentifier
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.ServiceTier
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.Metadata
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.ProviderOptions
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.Options
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SetSender(string)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SetLogOptions(CurlLogOptions)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SetOutputPath(string)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SetOutputPath(string, string)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SetOutputDirectory(string)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SetDownloadOptions(DownloadOptions)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SetRequestMimeType(MimeType)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SetResponseMimeType(MimeType)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SetStream(bool)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SetMetadata(ServerDictionary)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SetSafetyIdentifier(string)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SetProviderOptions(ITextRequestOptions)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SetSpecificOptions(ITextRequestOptions)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.ValidateRequest()
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.GetConfig<T>()
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.SetApi(Api)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.ExecuteAsync(CancellationToken)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.Cancel()
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.ExecuteAsyncInternal()
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.ResolveDownloadOptions(DownloadOptions)
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.GenerateDefaultFileName()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Glitch9.AIDevKit
    Assembly: Glitch9.AIDevKit.dll
    Syntax
    public abstract class ChatCompletionRequestBase<TSelf, TInput, TAsset> : GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>, IStreamingGenerativeRequest<Delta<ITextChunk>, TAsset>, IGenerativeTextRequest, IGenerativeRequest where TSelf : ChatCompletionRequestBase<TSelf, TInput, TAsset> where TInput : IPrompt where TAsset : class
    Type Parameters
    Name Description
    TSelf
    TInput
    TAsset

    Constructors

    | Edit this page View Source

    ChatCompletionRequestBase()

    Declaration
    protected ChatCompletionRequestBase()
    | Edit this page View Source

    ChatCompletionRequestBase(TInput)

    Declaration
    protected ChatCompletionRequestBase(TInput prompt)
    Parameters
    Type Name Description
    TInput prompt

    Properties

    | Edit this page View Source

    Messages

    Context messages for chat-based models.

    Declaration
    public List<Message> Messages { get; set; }
    Property Value
    Type Description
    List<Message>
    | Edit this page View Source

    OutputModalities

    For multi-modal models, specifies the desired output Modality (e.g., text, image, audio).

    Declaration
    public Modality[] OutputModalities { get; set; }
    Property Value
    Type Description
    Modality[]
    Remarks

    Not all providers support this parameter. Check your provider's documentation for details.

    | Edit this page View Source

    RequestType

    The endpoint type for this

    Declaration
    public override RequestType RequestType { get; }
    Property Value
    Type Description
    RequestType
    Overrides
    UnifiedApiRequestBase<TSelf, Generated<TAsset>, ITextRequestOptions>.RequestType

    Methods

    | Edit this page View Source

    AddMessageRange(IEnumerable<Message>)

    Declaration
    public override TSelf AddMessageRange(IEnumerable<Message> messages)
    Parameters
    Type Name Description
    IEnumerable<Message> messages
    Returns
    Type Description
    TSelf
    Overrides
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.AddMessageRange(IEnumerable<Message>)
    | Edit this page View Source

    GetMessages()

    Declaration
    public override List<Message> GetMessages()
    Returns
    Type Description
    List<Message>
    Overrides
    GenerativeTextRequest<TSelf, TInput, TAsset, Delta<ITextChunk>>.GetMessages()
    | Edit this page View Source

    SetOutputModalities(params Modality[])

    Sets the desired output Modality for multi-modal models (e.g., text, image, audio).

    Declaration
    public TSelf SetOutputModalities(params Modality[] modalities)
    Parameters
    Type Name Description
    Modality[] modalities
    Returns
    Type Description
    TSelf
    Remarks

    Not all providers support this parameter. Check your provider's documentation for details.

    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)
    • Edit this page
    • View Source
    In this article
    Back to top AI DevKit Documentation