XAIConfig class

xAI provider configuration

This class contains all configuration options for the xAI providers. It's extracted from the main provider to improve modularity and reusability.

Constructors

XAIConfig.new({required String apiKey, String baseUrl = 'https://api.x.ai/v1/', String model = 'grok-3', int? maxTokens, double? temperature, String? systemPrompt, Duration? timeout, double? topP, int? topK, List<Tool>? tools, ToolChoice? toolChoice, StructuredOutputFormat? jsonSchema, String? embeddingEncodingFormat, int? embeddingDimensions, SearchParameters? searchParameters, bool? liveSearch, LLMConfig? originalConfig})
const
XAIConfig.fromLLMConfig(LLMConfig config)
Create XAIConfig from unified LLMConfig
factory

Properties

apiKey String
final
baseUrl String
final
embeddingDimensions int?
final
embeddingEncodingFormat String?
final
hashCode int
The hash code for this object.
no setterinherited
isLiveSearchEnabled bool
Check if live search is enabled
no setter
jsonSchema StructuredOutputFormat?
final
liveSearch bool?
Enable or disable live search functionality
final
maxTokens int?
final
model String
final
modelFamily String
Get the model family
no setter
originalConfig LLMConfig?
Get the original LLMConfig for HTTP configuration
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
searchParameters SearchParameters?
final
supportsEmbeddings bool
Check if this model supports embeddings
no setter
supportsReasoning bool
Check if this model supports reasoning/thinking
no setter
supportsSearch bool
Check if this model supports search
no setter
supportsToolCalling bool
Check if this model supports tool calling
no setter
supportsVision bool
Check if this model supports vision
no setter
systemPrompt String?
final
temperature double?
final
timeout Duration?
final
toolChoice ToolChoice?
final
tools List<Tool>?
final
topK int?
final
topP double?
final

Methods

copyWith({String? apiKey, String? baseUrl, String? model, int? maxTokens, double? temperature, String? systemPrompt, Duration? timeout, double? topP, int? topK, List<Tool>? tools, ToolChoice? toolChoice, StructuredOutputFormat? jsonSchema, String? embeddingEncodingFormat, int? embeddingDimensions, SearchParameters? searchParameters, bool? liveSearch}) XAIConfig
getExtension<T>(String key) → T?
Get extension value from original config
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited