ChatXAIResponses

Internal method that handles batching and configuration for a runnable It takes a function, input values, and optional configuration, and returns a promise that resolves to the output values.

Filter out large/inappropriate fields from invocation params for tracing metadata. Removes fields like tools, functions, messages, response_format that can be large.

Create a unique cache key for a specific call to a specific language model.

Get the identifying parameters of the LLM.

Makes a request to the xAI Responses API.

Makes a streaming request to the xAI Responses API.

Stream chat model events using the new content-block-centric protocol.

Override this method to provide native event streaming from the provider SDK. The default implementation bridges from _streamResponseChunks by synthesizing lifecycle events from ChatGenerationChunk objects.

Event lifecycle

MessageStart
  -> ContentBlockStart(index, contentBlock)
    -> ContentBlockDelta(index, delta) ...
  -> ContentBlockFinish(index, contentBlock)
-> MessageFinish(reason, usage?)

Content blocks may interleave (e.g., parallel tool calls). The only invariant: a block's start precedes its deltas, and its deltas precede its finish.

Default streaming implementation. Subclasses should override this method if they support streaming output.

Helper method to transform an Iterator of Input values into an Iterator of Output values, with callbacks. Use this to implement stream() or transform() in Runnable subclasses.

Assigns new fields to the dict output of this runnable. Returns a new runnable.

Convert a runnable to a tool. Return a new instance of RunnableToolLike which contains the runnable, name, description and schema.

Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.

Bind tool-like objects to this chat model.

Generates chat based on the input messages.

Generates a prompt based on the input prompt values.

Wraps getLsParams() and always appends ls_integration. This ensures the integration tag is present even when partner packages fully override getLsParams().

Get the number of tokens in the content.

Get the parameters used to invoke the model

Invokes the chat model with a single input.

Pick keys from the dict output of this runnable. Returns a new runnable.

Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

Stream output in chunks.

Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

Bind config to a Runnable, returning a new Runnable.

Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.

Bind lifecycle listeners to a Runnable, returning a new Runnable. The Run object contains information about the run, including its id, type, input, output, error, startTime, endTime, and any tags or metadata added to the run.

Add retry logic to an existing runnable.

The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

Implemented as a static method to support loading logic.