Search Results for

    Show / Hide Table of Contents

    Class StructuredOutputRequest<T>

    Task for generating structured output (e.g., JSON) using an LLM model.

    Inheritance
    object
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>
    StreamingGenerativeRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>, ITextRequestOptions>
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>
    ChatCompletionRequestBase<StructuredOutputRequest<T>, Prompt, T>
    StructuredOutputRequestBase<StructuredOutputRequest<T>, T>
    StructuredOutputRequest<T>
    Implements
    IStreamingGenerativeRequest<Delta<ITextChunk>, T>
    IGenerativeTextRequest
    IGenerativeRequest
    Inherited Members
    ChatCompletionRequestBase<StructuredOutputRequest<T>, Prompt, T>.RequestType
    ChatCompletionRequestBase<StructuredOutputRequest<T>, Prompt, T>.Messages
    ChatCompletionRequestBase<StructuredOutputRequest<T>, Prompt, T>.OutputModalities
    ChatCompletionRequestBase<StructuredOutputRequest<T>, Prompt, T>.SetOutputModalities(params Modality[])
    ChatCompletionRequestBase<StructuredOutputRequest<T>, Prompt, T>.AddMessageRange(IEnumerable<Message>)
    ChatCompletionRequestBase<StructuredOutputRequest<T>, Prompt, T>.GetMessages()
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.ModelType
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.Instructions
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.StartingMessage
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.TopP
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.TopK
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.Temperature
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.TopLogprobs
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.LogitBias
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.Logprobs
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.PresencePenalty
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.FrequencyPenalty
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.MaxTokens
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.ReasoningOptions
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.StreamOptions
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SafetySettings
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.RequestMetadata
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.Tools
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.ToolChoice
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.ParallelToolCalls
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.ResponseFormat
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.Stop
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.WebSearchOptions
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetInstructions(string)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetStartingMessage(string)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetSafetySettings(List<SafetySetting>)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetTools(params Tool[])
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetTools(IEnumerable<Tool>)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetToolChoice(ToolChoice)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetTemperature(Temperature)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetTopP(TopP)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetTopK(TopK)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetPresencePenalty(PresencePenalty)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetFrequencyPenalty(FrequencyPenalty)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetLogitBias(Dictionary<string, double>)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetLogprobs(bool)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetMaxOutputTokens(TokenCount)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetReasoningOptions(ReasoningOptions)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetReasoning(ReasoningEffort, ReasoningSummaryLevel?)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetReasoning(ReasoningEffort, TokenCount, bool)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetReasoning(ReasoningFormat)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetReasoning(TokenCount)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetResponseFormat(ResponseFormat)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetResponseFormat(Type)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetStopSequences(params string[])
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetRequestMetadata(ServerDictionary)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.SetWebSearchOptions(WebSearchSettings)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.AddMessage(params Message[])
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.AddMessageRange(IEnumerable<Message>)
    GenerativeTextRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>>.GetMessages()
    StreamingGenerativeRequest<StructuredOutputRequest<T>, Prompt, T, Delta<ITextChunk>, ITextRequestOptions>.StreamAsync(CancellationToken)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.ModelType
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.Api
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.Prompt
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.Model
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.N
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.Seed
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.MeasureLatency
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.OnLatencyMeasured
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.RequestedAt
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.RecordOptions
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.RecordedContext
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.SetModel(Api, string)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.SetModel(ModelBase)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.SetCount(int)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.SetN(int)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.SetSeed(long)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.SetRecordOptions(bool?, bool?, string, string, GenerationRecord, RecordMerger, Action<GenerationRecord>)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.SetRecordOptions(GenerationRecordOptions)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.SetMeasureLatency(Action<double>)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.SetMeasureLatency(bool, Action<double>)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.SetPlaygroundSettings(string, string, string, bool, Action<double>, Action<GenerationRecord>)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.ExecuteAsync(CancellationToken)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.ExecuteAsyncT<T>(CancellationToken)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.ProcessPostRequestTasks<T>(Generated<T>)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.ProcessPostRequestTasks(IResult)
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.GetPrompt()
    GenerativeRequest<StructuredOutputRequest<T>, Prompt, T, ITextRequestOptions>.GetPromptStringToRecord()
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.Api
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.RequestType
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.HttpOptions
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.DownloadOptions
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.Sender
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.LogOptions
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.ContentType
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.ResponseType
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.IsCanceled
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.Stream
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.SafetyIdentifier
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.ServiceTier
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.Metadata
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.ProviderOptions
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.Options
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.SetSender(string)
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.SetLogOptions(CurlLogOptions)
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.SetOutputPath(string)
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.SetOutputPath(string, string)
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.SetOutputDirectory(string)
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.SetDownloadOptions(DownloadOptions)
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.SetRequestMimeType(MimeType)
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.SetResponseMimeType(MimeType)
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.SetStream(bool)
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.SetMetadata(ServerDictionary)
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.SetSafetyIdentifier(string)
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.SetProviderOptions(ITextRequestOptions)
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.SetSpecificOptions(ITextRequestOptions)
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.GetConfig<T>()
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.ExecuteAsync(CancellationToken)
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, 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
    public sealed class StructuredOutputRequest<T> : StructuredOutputRequestBase<StructuredOutputRequest<T>, T>, IStreamingGenerativeRequest<Delta<ITextChunk>, T>, IGenerativeTextRequest, IGenerativeRequest where T : class
    Type Parameters
    Name Description
    T

    Constructors

    | Edit this page View Source

    StructuredOutputRequest(Prompt)

    Declaration
    public StructuredOutputRequest(Prompt prompt)
    Parameters
    Type Name Description
    Prompt prompt

    Methods

    | Edit this page View Source

    ExecuteAsyncInternal()

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

    Declaration
    protected override UniTask<Generated<T>> ExecuteAsyncInternal()
    Returns
    Type Description
    UniTask<Generated<T>>
    Overrides
    UnifiedApiRequestBase<StructuredOutputRequest<T>, Generated<T>, ITextRequestOptions>.ExecuteAsyncInternal()

    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