interface ChatXAIInputThe xAI API key to use for requests.
The base URL for the xAI API.
Whether to disable streaming.
If streaming is bypassed, then stream() will defer to
invoke().
The maximum number of concurrent calls that can be made.
Defaults to Infinity, which means no limit.
The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.
The maximum number of tokens that the model can process in a single response. This limits ensures computational efficiency and resource management.
The name of the model to use.
Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.
Version of AIMessage output format to store in message content.
AIMessage.contentBlocks will lazily parse the contents of content into a
standard format. This flag can be used to additionally store the standard format
as the message content, e.g., for serialization purposes.
.contentBlocks).contentBlocks)You can also set LC_OUTPUT_VERSION as an environment variable to "v1" to
enable this by default.
Default search parameters for xAI's Live Search API. When set, these parameters will be applied to all requests unless overridden in the call options.
const llm = new ChatXAI({
model: "grok-beta",
searchParameters: {
mode: "auto",
max_search_results: 5,
}
});Up to 4 sequences where the API will stop generating further tokens. The
returned text will not contain the stop sequence.
Alias for stopSequences
Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
Whether or not to stream responses.
The temperature to use for sampling.