Class XAIService
public class XAIService : OpenAICompatibleService, IAIService, IFunctionRegisterable
- Inheritance
-
XAIService
- Implements
- Inherited Members
- Extension Methods
Constructors
XAIService(string, HttpClient)
public XAIService(string apiKey, HttpClient httpClient)
Parameters
apiKeystringhttpClientHttpClient
XAIService(string, string, HttpClient)
Creates a XAIService with a specific model.
public XAIService(string apiKey, string model, HttpClient httpClient)
Parameters
apiKeystringmodelstringhttpClientHttpClient
Properties
Provider
The AI provider for this service
public override string Provider { get; }
Property Value
ReasoningEffort
Reasoning effort for configurable Grok models. Auto leaves the provider default intact. Grok 4.3 accepts None, Low, Medium, and High; Grok 4.5 accepts Low, Medium, and High.
public GrokReasoning ReasoningEffort { get; set; }
Property Value
Methods
ApplyProviderSpecificRequestProfile(AIRequestProfile)
protected override Action ApplyProviderSpecificRequestProfile(AIRequestProfile profile)
Parameters
profileAIRequestProfile
Returns
CreateFunctionMessageRequest()
Creates HTTP request with function definitions
protected override HttpRequestMessage CreateFunctionMessageRequest()
Returns
CreateMessageRequest()
Creates the HTTP request message for the AI service
protected override HttpRequestMessage CreateMessageRequest()
Returns
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 override StreamingContent? CreateStreamParseFailure(string jsonData, Exception exception, StreamDiagnostics diagnostics)
Parameters
jsonDatastringexceptionExceptiondiagnosticsStreamDiagnostics
Returns
ExtractFunctionCalls(string)
Extracts every function call from one API response.
protected override (string content, FunctionCallBatch functionCalls) ExtractFunctionCalls(string response)
Parameters
responsestring
Returns
ExtractResponseContent(string)
Extracts the response content from the API response
protected override string ExtractResponseContent(string responseContent)
Parameters
responseContentstring
Returns
GetCompletionAsync(Message)
public override Task<string> GetCompletionAsync(Message message)
Parameters
messageMessage
Returns
GetCompletionWithCoTAsync(string)
Gets completion with Chain of Thought prompting
public Task<string> GetCompletionWithCoTAsync(string prompt)
Parameters
promptstring
Returns
GetCompletionWithImageAsync(string, string)
xAI Grok supports vision (image inputs)
public override Task<string> GetCompletionWithImageAsync(string prompt, string imagePath)
Parameters
Returns
GetInputTokenCountAsync()
Gets the token count for the current conversation
public override Task<uint> GetInputTokenCountAsync()
Returns
GetInputTokenCountAsync(string)
Gets the token count for a specific prompt
public override Task<uint> GetInputTokenCountAsync(string prompt)
Parameters
promptstring
Returns
GetModelMaxOutputTokens()
Returns the maximum output tokens allowed for the current model. Override in each service to provide model-specific limits.
protected override uint GetModelMaxOutputTokens()
Returns
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 override OpenAICompatibleService.OpenAIStreamChunk ParseStreamChunk(string jsonData, StreamOptions options)
Parameters
jsonDatastringoptionsStreamOptions
Returns
StreamParseJson(string)
Parses streaming JSON data
protected override string StreamParseJson(string jsonData)
Parameters
jsonDatastring
Returns
UseGrok4FastModel()
Switches to Grok 4.3 for fast general-purpose workloads.
public XAIService UseGrok4FastModel()
Returns
UseGrok4Model()
Switches to the current Grok flagship reasoning model (grok-4.5).
public XAIService UseGrok4Model()
Returns
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 override StreamingContent? ValidateStreamTermination(bool doneMarkerReceived, bool completionEventReceived, StreamDiagnostics diagnostics)
Parameters
doneMarkerReceivedboolcompletionEventReceivedbooldiagnosticsStreamDiagnostics
Returns
WithCodeGenerationMode(string)
Sets Grok-specific parameters for code generation
public XAIService WithCodeGenerationMode(string language = "python")
Parameters
languagestring
Returns
WithGrokParameters(GrokReasoning)
Sets the model-specific Grok reasoning effort.
public XAIService WithGrokParameters(GrokReasoning reasoningEffort = GrokReasoning.High)
Parameters
reasoningEffortGrokReasoning