@n8n/n8n-nodes-langchain/dist/node-definitions/nodes/n8n-nodes-langchain/lmChatXAiGrok/v1.ts

/**
 * xAI Grok Chat Model Node - Version 1
 * For advanced usage with an AI chain
 */


export interface LcLmChatXAiGrokV1Params {
/**
 * The model which will generate the completion. <a href="https://docs.x.ai/docs/models">Learn more</a>.
 * @builderHint Default to the latest flagship Grok (grok-4.20-0309-reasoning, or grok-4.20-multi-agent-0309 for agent workloads). Avoid grok-4, grok-2, and grok-1 variants.
 * @default grok-2-vision-1212
 */
    model?: string | Expression<string>;
/**
 * Additional options to add
 * @default {}
 */
    options?: {
    /** Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim
     * @default 0
     */
    frequencyPenalty?: number | Expression<number>;
    /** The maximum number of tokens to generate in the completion. Most models have a context length of 2048 tokens (except for the newest models, which support 32,768).
     * @default -1
     */
    maxTokens?: number | Expression<number>;
    /** Response Format
     * @default text
     */
    responseFormat?: 'text' | 'json_object' | Expression<string>;
    /** Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics
     * @default 0
     */
    presencePenalty?: number | Expression<number>;
    /** Controls randomness: Lowering results in less random completions. As the temperature approaches zero, the model will become deterministic and repetitive.
     * @default 0.7
     */
    temperature?: number | Expression<number>;
    /** Maximum amount of time a request is allowed to take in milliseconds
     * @default 360000
     */
    timeout?: number | Expression<number>;
    /** Maximum number of retries to attempt
     * @default 2
     */
    maxRetries?: number | Expression<number>;
    /** Controls diversity via nucleus sampling: 0.5 means half of all likelihood-weighted options are considered. We generally recommend altering this or temperature but not both.
     * @default 1
     */
    topP?: number | Expression<number>;
    /** Whether to give your xAI API requests higher scheduling priority (Priority Processing)
     * @default false
     */
    priority?: boolean | Expression<boolean>;
    /** Effort the model spends thinking before responding
     * @default low
     */
    reasoning?: 'none' | 'low' | 'medium' | 'high' | Expression<string>;
  };
}

export interface LcLmChatXAiGrokV1Credentials {
  xAiApi: CredentialReference;
}

interface LcLmChatXAiGrokV1NodeBase {
  type: '@n8n/n8n-nodes-langchain.lmChatXAiGrok';
  version: 1;
}

export type LcLmChatXAiGrokV1ParamsNode = LcLmChatXAiGrokV1NodeBase & {
  config: NodeConfig<LcLmChatXAiGrokV1Params> & { credentials?: LcLmChatXAiGrokV1Credentials };
};

export type LcLmChatXAiGrokV1Node = LcLmChatXAiGrokV1ParamsNode;