langchain.js
    Preparing search index...

    Class ChatXAIResponses<CallOptions>

    xAI Responses API chat model integration.

    This class provides access to xAI's Responses API, which offers enhanced capabilities including built-in tools, reasoning, and search.

    import { ChatXAIResponses } from "@langchain/xai";

    const llm = new ChatXAIResponses({
      model: "grok-3",
      temperature: 0.7,
    });

    const result = await llm.invoke("What is the capital of France?");
    console.log(result.content);

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    apiKey baseURL lc_namespace lc_serializable maxOutputTokens? model reasoning? searchParameters? store? streaming temperature? tools? topP? user?

    Accessors

    lc_aliases lc_secrets

    Methods

    _generate _llmType _makeRequest _makeStreamingRequest _streamResponseChunks getLsParams invocationParams toJSON lc_name

    Constructors

    Properties

    apiKey: string
    baseURL: string
    lc_namespace: string[] = ...
    lc_serializable: boolean = true
    maxOutputTokens?: number
    model: string
    reasoning?: XAIResponsesReasoning
    searchParameters?: XAIResponsesSearchParameters
    store?: boolean
    streaming: boolean
    temperature?: number
    tools?: XAIResponsesTool[]
    topP?: number
    user?: string

    Accessors

    • get lc_aliases(): undefined | { [key: string]: string }

      Returns undefined | { [key: string]: string }

    • get lc_secrets(): undefined | { [key: string]: string }

      Returns undefined | { [key: string]: string }

    Methods

    _generate

    • _generate(
          messages: BaseMessage[],
          options: unknown,
          runManager?: any,
      ): Promise<ChatResult>

      Parameters

      • messages: BaseMessage[]
      • options: unknown
      • OptionalrunManager: any

      Returns Promise<ChatResult>

    _llmType

    • _llmType(): string

      Returns string

    Protected_makeRequest

    Protected_makeStreamingRequest

    _streamResponseChunks

    • _streamResponseChunks(
          messages: BaseMessage[],
          options: unknown,
          runManager?: any,
      ): AsyncGenerator<ChatGenerationChunk>

      Parameters

      • messages: BaseMessage[]
      • options: unknown
      • OptionalrunManager: any

      Returns AsyncGenerator<ChatGenerationChunk>

    • Parameters

      • options: unknown

      Returns LangSmithParams

    • Returns Serialized

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods