Class ChatWatsonx<CallOptions>

Constructors

constructor

new ChatWatsonx<
    CallOptions extends
        | Without<
            | Without<WatsonxCallOptionsChat, WatsonxCallOptionsDeployedChat> & WatsonxCallOptionsDeployedChat
            | Without<WatsonxCallOptionsDeployedChat, WatsonxCallOptionsChat> & WatsonxCallOptionsChat,
            WatsonxCallOptionsGatewayChat,
        > & WatsonxCallOptionsGatewayChat
        | (
            Without<WatsonxCallOptionsGatewayChat, (Without<WatsonxCallOptionsChat, WatsonxCallOptionsDeployedChat> & WatsonxCallOptionsDeployedChat) | (Without<...> & WatsonxCallOptionsChat)> & ((Without<...> & WatsonxCallOptionsDeployedChat) | (Without<...> & WatsonxCallOptionsChat))
        ) = | Without<
        | Without<WatsonxCallOptionsChat, WatsonxCallOptionsDeployedChat> & WatsonxCallOptionsDeployedChat
        | Without<WatsonxCallOptionsDeployedChat, WatsonxCallOptionsChat> & WatsonxCallOptionsChat,
        WatsonxCallOptionsGatewayChat,
    > & WatsonxCallOptionsGatewayChat
    | (
        Without<WatsonxCallOptionsGatewayChat, (Without<WatsonxCallOptionsChat, WatsonxCallOptionsDeployedChat> & WatsonxCallOptionsDeployedChat) | (Without<...> & WatsonxCallOptionsChat)> & ((Without<...> & WatsonxCallOptionsDeployedChat) | (Without<...> & WatsonxCallOptionsChat))
    ),
>(
    fields: ChatWatsonxConstructorInput,
): ChatWatsonx<CallOptions>
Type Parameters
- CallOptions extends
      | Without<
          | Without<WatsonxCallOptionsChat, WatsonxCallOptionsDeployedChat> & WatsonxCallOptionsDeployedChat
          | Without<WatsonxCallOptionsDeployedChat, WatsonxCallOptionsChat> & WatsonxCallOptionsChat,
          WatsonxCallOptionsGatewayChat,
      > & WatsonxCallOptionsGatewayChat
      | (
          Without<WatsonxCallOptionsGatewayChat, (Without<WatsonxCallOptionsChat, WatsonxCallOptionsDeployedChat> & WatsonxCallOptionsDeployedChat) | (Without<...> & WatsonxCallOptionsChat)> & ((Without<...> & WatsonxCallOptionsDeployedChat) | (Without<...> & WatsonxCallOptionsChat))
      ) =
      | Without<
          | Without<WatsonxCallOptionsChat, WatsonxCallOptionsDeployedChat> & WatsonxCallOptionsDeployedChat
          | Without<WatsonxCallOptionsDeployedChat, WatsonxCallOptionsChat> & WatsonxCallOptionsChat,
          WatsonxCallOptionsGatewayChat,
      > & WatsonxCallOptionsGatewayChat
      | (
          Without<WatsonxCallOptionsGatewayChat, (Without<WatsonxCallOptionsChat, WatsonxCallOptionsDeployedChat> & WatsonxCallOptionsDeployedChat) | (Without<...> & WatsonxCallOptionsChat)> & ((Without<...> & WatsonxCallOptionsDeployedChat) | (Without<...> & WatsonxCallOptionsChat))
      )
Parameters
- fields: ChatWatsonxConstructorInput
Returns ChatWatsonx<CallOptions>
Overrides BaseChatModel<CallOptions>.constructor
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:663

Properties

`Optional`frequencyPenalty

frequencyPenalty?: number

`Protected` `Optional`gateway

gateway?: Gateway

`Optional`idOrName

idOrName?: string

`Optional`includeReasoning

includeReasoning?: boolean

lc_serializable

lc_serializable: boolean = true

`Optional`logprobs

logprobs?: boolean

`Optional`maxCompletionTokens

maxCompletionTokens?: number

`Optional`maxConcurrency

maxConcurrency?: number

maxRetries

maxRetries: number = 0

`Optional`maxTokens

maxTokens?: number

`Optional`model

model?: string

modelGateway

modelGateway: boolean = false

`Optional`modelGatewayKwargs

modelGatewayKwargs?: WatsonxGatewayChatKwargs

`Optional`n

n?: number

`Optional`presencePenalty

presencePenalty?: number

`Optional`projectId

projectId?: string

`Optional`reasoningEffort

reasoningEffort?: "low" | "medium" | "high"

`Optional`responseFormat

responseFormat?: TextChatResponseFormat

`Protected` `Optional`service

service?: WatsonxAiMlVml_v1

serviceUrl

serviceUrl: string

`Optional`spaceId

spaceId?: string

streaming

streaming: boolean = false

`Optional`temperature

temperature?: number

`Optional`timeLimit

timeLimit?: number

`Optional`topLogprobs

topLogprobs?: number

`Optional`topP

topP?: number

version

version: string = "2024-05-31"

`Optional`watsonxCallbacks

watsonxCallbacks?: RequestCallbacks<any>

Accessors

lc_aliases

get lc_aliases(): { [key: string]: string }
Returns { [key: string]: string }
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:472

lc_secrets

get lc_secrets(): { [key: string]: string }
Returns { [key: string]: string }
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:458

Methods

_generate

_generate(
    messages: BaseMessage[],
    options: unknown,
    runManager?: any,
): Promise<ChatResult>
Parameters
- messages: BaseMessage[]
- options: unknown
- OptionalrunManager: any
Returns Promise<ChatResult>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:880

_llmType

_llmType(): string
Returns string
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:736

_streamResponseChunks

_streamResponseChunks(
    messages: BaseMessage[],
    options: unknown,
    _runManager?: any,
): AsyncGenerator<ChatGenerationChunk>
Parameters
- messages: BaseMessage[]
- options: unknown
- Optional_runManager: any
Returns AsyncGenerator<ChatGenerationChunk>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:1005

bindTools

bindTools(
tools: any[],
kwargs?: Partial<CallOptions>,
): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>
Parameters
- tools: any[]
- Optionalkwargs: Partial<CallOptions>
Returns Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:791

completionWithRetry

completionWithRetry<T>(callback: () => T, options?: unknown): Promise<any>
Type Parameters
- T
Parameters
- callback: () => T
- Optionaloptions: unknown
Returns Promise<any>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:831

getLsParams

getLsParams(options: unknown): LangSmithParams
Parameters
- options: unknown
Returns LangSmithParams
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:486

invocationCallbacks

invocationCallbacks(options: unknown): any
Parameters
- options: unknown
Returns any
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:787

invocationParams

invocationParams(
    options: unknown,
): {
    frequencyPenalty: any;
    logprobs: any;
    maxCompletionTokens: any;
    maxTokens: any;
    n: any;
    presencePenalty: any;
    reasoningEffort: any;
    responseFormat: any;
    temperature: any;
    topLogprobs: any;
    topP: any;
}
Parameters
- options: unknown
Returns {
    frequencyPenalty: any;
    logprobs: any;
    maxCompletionTokens: any;
    maxTokens: any;
    n: any;
    presencePenalty: any;
    reasoningEffort: any;
    responseFormat: any;
    temperature: any;
    topLogprobs: any;
    topP: any;
}
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:740

scopeId

scopeId(
    options?: unknown,
):
    | { idOrName: string }
    | { modelId: string; projectId: string }
    | { modelId: string; spaceId: string }
    | { modelId: string }
    | { model: string }
Parameters
- Optionaloptions: unknown
Returns
    | { idOrName: string }
    | { modelId: string; projectId: string }
    | { modelId: string; spaceId: string }
    | { modelId: string }
    | { model: string }
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:801

withStructuredOutput

withStructuredOutput<
    RunOutput extends Record<string, any> = Record<string, any>,
>(
    outputSchema: any,
    config?: any,
): Runnable<BaseLanguageModelInput, RunOutput>
Type Parameters
- RunOutput extends Record<string, any> = Record<string, any>
Parameters
- outputSchema: any
- Optionalconfig: any
Returns Runnable<BaseLanguageModelInput, RunOutput>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:1151
withStructuredOutput<
    RunOutput extends Record<string, any> = Record<string, any>,
>(
    outputSchema: any,
    config?: any,
): Runnable<BaseLanguageModelInput, { parsed: RunOutput; raw: BaseMessage }>
Type Parameters
- RunOutput extends Record<string, any> = Record<string, any>
Parameters
- outputSchema: any
- Optionalconfig: any
Returns Runnable<BaseLanguageModelInput, { parsed: RunOutput; raw: BaseMessage }>
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:1162

`Static`lc_name

lc_name(): string
Returns string
- Defined in remotes/langchain-ai/langchainjs/main/libs/langchain-community/src/chat_models/ibm.ts:452

Class ChatWatsonx<CallOptions>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ChatWatsonx<CallOptions>

Properties

OptionalfrequencyPenalty

Protected Optionalgateway

OptionalidOrName

OptionalincludeReasoning

lc_serializable

Optionallogprobs

OptionalmaxCompletionTokens

OptionalmaxConcurrency

maxRetries

OptionalmaxTokens

Optionalmodel

modelGateway

OptionalmodelGatewayKwargs

Optionaln

OptionalpresencePenalty

OptionalprojectId

OptionalreasoningEffort

OptionalresponseFormat

Protected Optionalservice

serviceUrl

OptionalspaceId

streaming

Optionaltemperature

OptionaltimeLimit

OptionaltopLogprobs

OptionaltopP

version

OptionalwatsonxCallbacks

Accessors

lc_aliases

Returns { [key: string]: string }

lc_secrets

Returns { [key: string]: string }

Methods

_generate

Parameters

Returns Promise<ChatResult>

_llmType

Returns string

_streamResponseChunks

Parameters

Returns AsyncGenerator<ChatGenerationChunk>

bindTools

Parameters

Returns Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>

completionWithRetry

Type Parameters

Parameters

Returns Promise<any>

getLsParams

Parameters

Returns LangSmithParams

invocationCallbacks

Parameters

Returns any

invocationParams

Parameters

Returns { frequencyPenalty: any; logprobs: any; maxCompletionTokens: any; maxTokens: any; n: any; presencePenalty: any; reasoningEffort: any; responseFormat: any; temperature: any; topLogprobs: any; topP: any;}

scopeId

Parameters

Returns | { idOrName: string } | { modelId: string; projectId: string } | { modelId: string; spaceId: string } | { modelId: string } | { model: string }

withStructuredOutput

Type Parameters

Parameters

Returns Runnable<BaseLanguageModelInput, RunOutput>

`Optional`frequencyPenalty

`Protected` `Optional`gateway

`Optional`idOrName

`Optional`includeReasoning

`Optional`logprobs

`Optional`maxCompletionTokens

`Optional`maxConcurrency

`Optional`maxTokens

`Optional`model

`Optional`modelGatewayKwargs

`Optional`n

`Optional`presencePenalty

`Optional`projectId

`Optional`reasoningEffort

`Optional`responseFormat

`Protected` `Optional`service

`Optional`spaceId

`Optional`temperature

`Optional`timeLimit

`Optional`topLogprobs

`Optional`topP

`Optional`watsonxCallbacks

Returns {
frequencyPenalty: any;
logprobs: any;
maxCompletionTokens: any;
maxTokens: any;
n: any;
presencePenalty: any;
reasoningEffort: any;
responseFormat: any;
temperature: any;
topLogprobs: any;
topP: any;
}

Returns
| { idOrName: string }
| { modelId: string; projectId: string }
| { modelId: string; spaceId: string }
| { modelId: string }
| { model: string }

`Static`lc_name