Class ChatWatsonx<CallOptions>

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>

OptionalfrequencyPenalty

OptionalidOrName

lc_serializable

Optionallogprobs

OptionalmaxCompletionTokens

OptionalmaxConcurrency

maxRetries

OptionalmaxTokens

Optionalmodel

modelGateway

OptionalmodelGatewayKwargs

Optionaln

OptionalpresencePenalty

OptionalprojectId

OptionalresponseFormat

serviceUrl

OptionalspaceId

streaming

Optionaltemperature

OptionaltimeLimit

OptionaltopLogprobs

OptionaltopP

version

OptionalwatsonxCallbacks

lc_aliases

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

  Returns { [key: string]: string }

lc_secrets

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

  Returns { [key: string]: string }

_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

_streamResponseChunks

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

  Parameters

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

  Returns AsyncGenerator<ChatGenerationChunk>

bindTools

• bindTools(
      tools: any[],
      kwargs?: Partial<CallOptions>,
  ): Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>

  Parameters

  • tools: any[]
  • Optionalkwargs: Partial<CallOptions>

  Returns Runnable<BaseLanguageModelInput, AIMessageChunk, CallOptions>

completionWithRetry

• completionWithRetry<T>(callback: () => T, options?: unknown): Promise<any>

  Type Parameters

  • T

  Parameters

  • callback: () => T
  • Optionaloptions: unknown

  Returns Promise<any>

getLsParams

• getLsParams(options: unknown): LangSmithParams

  Parameters

  • options: unknown

  Returns LangSmithParams

invocationCallbacks

• invocationCallbacks(options: unknown): any

  Parameters

  • options: unknown

  Returns any

invocationParams

• invocationParams(
      options: unknown,
  ): {
      frequencyPenalty: any;
      logprobs: any;
      maxCompletionTokens: any;
      maxTokens: any;
      n: any;
      presencePenalty: 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;
      responseFormat: any;
      temperature: any;
      topLogprobs: any;
      topP: any;
  }

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 }

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>

• 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 }>

Staticlc_name

• lc_name(): string

  Returns string