Class OpenAICompatibleService

Namespace

Mythosia.AI.Services.Base

Assembly

Mythosia.AI.dll

Base class for providers that follow the OpenAI-compatible streaming format (SSE with "data:" prefix, "[DONE]" terminator, choices/delta structure). Used by ChatGPT, Grok, Qwen, and other compatible providers. Providers override ParseStreamChunk(string, StreamOptions) to handle provider-specific parsing.

public abstract class OpenAICompatibleService : AIService, IAIService, IFunctionRegisterable

Inheritance

object

AIService

OpenAICompatibleService

Implements

IAIService

IFunctionRegisterable

Derived

QwenService

OpenAIService

XAIService

Inherited Members

AIService.ApiKey

AIService.HttpClient

AIService._chatRequests

AIService._structuredOutputSchemaJson

AIService.RunAgentAsync(string, int, AIRequestContext)

AIService.RunAgentStreamAsync(string, int, StreamOptions, AIRequestContext, CancellationToken)

AIService.GetModelMaxOutputTokens()

AIService.GetEffectiveMaxTokens()

AIService.ResolveRequestTimeoutSeconds(FunctionCallingPolicy)

AIService.CreateRequestTimeoutCts(FunctionCallingPolicy, CancellationToken)

AIService.AddNewChat(ChatBlock)

AIService.AddNewChat()

AIService.SetActivateChat(string)

AIService.ChangeModel(string)

AIService.GetLatestMessages()

AIService.EnsureUserFirstMessage(List<Message>)

AIService.GetLatestMessagesWithFunctionFallback()

AIService.GetCompletionAsync(string, AIRequestProfile, AIRequestContext)

AIService.GetCompletionAsync(Message)

AIService.GetCompletionAsync(Message, AIRequestProfile, AIRequestContext)

AIService.GetCompletionWithImageAsync(string, string)

AIService.GetCompletionWithImageUrlAsync(string, string)

AIService.CopyFrom(AIService)

AIService.ApplyRequestProfile(AIRequestProfile)

AIService.ApplyProviderSpecificRequestProfile(AIRequestProfile)

AIService.ApplyRequestContext(AIRequestContext)

AIService.GetEffectiveSystemMessageWithRequestContext()

AIService.CreateMessageRequest()

AIService.ExtractResponseContent(string)

AIService.StreamParseJson(string)

AIService.GetInputTokenCountAsync()

AIService.GetInputTokenCountAsync(string)

AIService.ProcessFunctionCallAsync(FunctionCall)

AIService.ProcessFunctionCallsAsync(FunctionCallBatch, FunctionCallingPolicy, CancellationToken)

AIService.ProcessFunctionCallsSequentiallyAsync(FunctionCallBatch, FunctionCallingPolicy, CancellationToken)

AIService.ProcessFunctionCallsInParallelAsync(FunctionCallBatch, FunctionCallingPolicy, CancellationToken)

AIService.AddFunctionCallBatchToHistory(string, FunctionCallBatch, Dictionary<string, object>)

AIService.AddFunctionResultBatchToHistory(FunctionCallResultBatch, Dictionary<string, object>)

AIService.CreateFunctionMessageRequest()

AIService.ExtractFunctionCalls(string)

AIService.ReadSseLinesAsync(HttpResponseMessage, StreamDiagnostics, CancellationToken)

AIService.QuickAskAsync(string, string, string)

AIService.QuickAskWithImageAsync(string, string, string, string)

AIService.StreamAsync(string, CancellationToken)

AIService.StreamAsync(Message, AIRequestContext, CancellationToken)

AIService.StreamAsync(string, StreamOptions, CancellationToken)

AIService.StreamAsync(Message, StreamOptions, AIRequestContext, CancellationToken)

AIService.StreamCoreAsync(Message, StreamOptions, CancellationToken)

AIService.CreateRoundUsageContent(int, bool, TokenUsage)

AIService.CopyTokenUsage(TokenUsage)

AIService.StreamOnceAsync(string, CancellationToken)

AIService.StreamOnceAsync(Message, CancellationToken)

AIService.StreamCompletionAsync(string, Action<string>)

AIService.StreamCompletionAsync(string, Func<string, Task>)

AIService.BeginStream(string)

AIService.GetCompletionAsync<T>(string)

AIService.GetStructuredOutputInstruction()

AIService.ApplySummaryPolicyIfNeededAsync()

AIService.DefaultPolicy

AIService.CurrentPolicy

AIService.SystemMessageProvider

AIService.ChatRequests

AIService.ActivateChat

AIService.StatelessMode

AIService.FunctionsDisabled

AIService.Provider

AIService.Model

AIService.SystemMessage

AIService.TopP

AIService.Temperature

AIService.FrequencyPenalty

AIService.PresencePenalty

AIService.MaxTokens

AIService.Stream

AIService.ContextRecoveryMaxRetries

AIService.Functions

AIService.EnableFunctions

AIService.FunctionCallMode

AIService.ForceFunctionName

AIService.ShouldUseFunctions

AIService.StructuredOutputMaxRetries

AIService.ConversationPolicy

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

AIServiceExtensions.AskOnceAsync(AIService, Message)

AIServiceExtensions.AskOnceAsync(AIService, string)

AIServiceExtensions.AskOnceWithImageAsync(AIService, string, string)

AIServiceExtensions.BeginMessage(AIService)

AIServiceExtensions.GetCompletionWithContextAsync(AIService, string, int)

AIServiceExtensions.GetConversationSummary(AIService)

AIServiceExtensions.GetLastAssistantResponse(AIService)

AIServiceExtensions.RetryLastMessageAsync(AIService)

AIServiceExtensions.StartNewConversation(AIService)

AIServiceExtensions.StartNewConversation(AIService, string)

AIServiceExtensions.SwitchModel(AIService, string)

AIServiceExtensions.WithComplexPolicy(AIService)

AIServiceExtensions.WithFastPolicy(AIService)

AIServiceExtensions.WithMaxRounds(AIService, int)

AIServiceExtensions.WithMaxTokens(AIService, uint)

AIServiceExtensions.WithNoRetryStructuredOutput(AIService)

AIServiceExtensions.WithPolicy(AIService, FunctionCallingPolicy)

AIServiceExtensions.WithStatelessMode(AIService, bool)

AIServiceExtensions.WithStrictStructuredOutput(AIService)

AIServiceExtensions.WithStructuredOutputPolicy(AIService, StructuredOutputPolicy)

AIServiceExtensions.WithSystemMessage(AIService, string)

AIServiceExtensions.WithSystemMessageProvider(AIService, Func<AIRequestContext?>)

AIServiceExtensions.WithSystemMessageProvider(AIService, Func<CancellationToken, ValueTask<AIRequestContext?>>)

AIServiceExtensions.WithTemperature(AIService, float)

AIServiceExtensions.WithTimeout(AIService, int)

FunctionExtensions.AskWithoutFunctionsAsync(AIService, string)

FunctionExtensions.WithFunction(AIService, FunctionDefinition)

FunctionExtensions.WithFunction(AIService, string, string, Func<string>)

FunctionExtensions.WithFunctionAsync(AIService, string, string, Func<Task<string>>)

FunctionExtensions.WithFunctionAsync<T>(AIService, string, string, (string name, string description, bool required), Func<T, Task<string>>)

FunctionExtensions.WithFunctionAsync<T1, T2>(AIService, string, string, (string name, string description, bool required), (string name, string description, bool required), Func<T1, T2, Task<string>>)

FunctionExtensions.WithFunctionAsync<T1, T2, T3>(AIService, string, string, (string name, string description, bool required), (string name, string description, bool required), (string name, string description, bool required), Func<T1, T2, T3, Task<string>>)

FunctionExtensions.WithFunction<T>(AIService, string, string, (string name, string description, bool required), Func<T, string>)

FunctionExtensions.WithFunction<T1, T2>(AIService, string, string, (string name, string description, bool required), (string name, string description, bool required), Func<T1, T2, string>)

FunctionExtensions.WithFunction<T1, T2, T3>(AIService, string, string, (string name, string description, bool required), (string name, string description, bool required), (string name, string description, bool required), Func<T1, T2, T3, string>)

FunctionExtensions.WithFunctionsEnabled(AIService, bool)

FunctionExtensions.WithFunctions<T>(AIService, T)

FunctionExtensions.WithStaticFunctions<T>(AIService)

FunctionExtensions.WithoutFunctions(AIService, bool)

AIServiceExtensions.WithStreamDiagnostics<T>(T, Action<StreamDiagnosticsBuilder>)

Constructors

OpenAICompatibleService(string?, string, HttpClient)

protected OpenAICompatibleService(string? apiKey, string baseUrl, HttpClient httpClient)

Parameters

apiKey string

baseUrl string

httpClient HttpClient

Fields

RequiresProviderCallIdMetadataKey

protected const string RequiresProviderCallIdMetadataKey = "requires_provider_call_id"

Field Value

string

StreamIndexExplicitMetadataKey

protected const string StreamIndexExplicitMetadataKey = "stream_index_explicit"

Field Value

string

StreamItemIdMetadataKey

protected const string StreamItemIdMetadataKey = "stream_item_id"

Field Value

string

Methods

CreateStreamParseFailure(string, Exception, StreamDiagnostics)

Lets providers turn a malformed SSE data event into an explicit terminal error. Returning null preserves the tolerant behavior used by legacy compatible providers.

protected virtual StreamingContent? CreateStreamParseFailure(string jsonData, Exception exception, StreamDiagnostics diagnostics)

Parameters

jsonData string

exception Exception

diagnostics StreamDiagnostics

Returns

StreamingContent

EnrichStreamAssistantMessage(Message)

Allows a provider to attach state collected while streaming before the assistant message is added to the conversation history.

protected virtual void EnrichStreamAssistantMessage(Message assistantMessage)

Parameters

assistantMessage Message

OnStreamRoundFailed()

Lets providers discard state collected during a failed streaming round.

protected virtual void OnStreamRoundFailed()

OnStreamRoundStarting()

Allows a provider to reset state scoped to a single streaming round.

protected virtual void OnStreamRoundStarting()

ParseOpenAICompatibleUsage(JsonElement)

Parses OpenAI-compatible usage JSON (handles both prompt_tokens/input_tokens variants).

protected static TokenUsage? ParseOpenAICompatibleUsage(JsonElement usage)

Parameters

usage JsonElement

Returns

TokenUsage

ParseStreamChunk(string, StreamOptions)

Parses a single SSE JSON chunk into a provider-neutral stream chunk. Each provider overrides this to handle its specific JSON format.

protected abstract OpenAICompatibleService.OpenAIStreamChunk ParseStreamChunk(string jsonData, StreamOptions options)

Parameters

jsonData string

options StreamOptions

Returns

OpenAICompatibleService.OpenAIStreamChunk

StreamCompletionAsync(Message, Func<string, Task>)

public override Task StreamCompletionAsync(Message message, Func<string, Task> messageReceivedAsync)

Parameters

message Message

messageReceivedAsync Func<string, Task>

Returns

Task

StreamRoundAsync(StreamOptions, bool, FunctionCallingPolicy, CancellationToken)

Executes a single streaming round: sends an HTTP request, reads the SSE stream, yields chunks, and handles function execution if detected. Yield a FunctionResult to signal the template to continue to the next round; otherwise the stream ends.

protected override IAsyncEnumerable<StreamingContent> StreamRoundAsync(StreamOptions options, bool useFunctions, FunctionCallingPolicy policy, CancellationToken cancellationToken)

Parameters

options StreamOptions

useFunctions bool

policy FunctionCallingPolicy

cancellationToken CancellationToken

Returns

IAsyncEnumerable<StreamingContent>

ValidateStreamTermination(bool, bool, StreamDiagnostics)

Lets providers require an explicit successful terminal event before committing a streamed assistant message or executing a collected function call.

protected virtual StreamingContent? ValidateStreamTermination(bool doneMarkerReceived, bool completionEventReceived, StreamDiagnostics diagnostics)

Parameters

doneMarkerReceived bool

completionEventReceived bool

diagnostics StreamDiagnostics

Returns

StreamingContent