Package org.springframework.ai.watsonx

Class WatsonxAiChatModel

java.lang.Object

org.springframework.ai.watsonx.WatsonxAiChatModel

All Implemented Interfaces:

ChatModel, StreamingChatModel, Model<Prompt,ChatResponse>, StreamingModel<Prompt,ChatResponse>

public class WatsonxAiChatModel
extends Object
implements ChatModel, StreamingChatModel

ChatModel implementation for watsonx.ai.

watsonx.ai allows developers to use large language models within a SaaS service. It supports multiple open-source models as well as IBM created models.

Please refer to the watsonx.ai models for the most up-to-date information about the available models.

Since:

1.0.0

Author:

Pablo Sanchidrian Herrera, John Jario Moreno Rojas, Christian Tzolov

Constructor Summary

Constructors

Constructor	Description
WatsonxAiChatModel(WatsonxAiApi watsonxAiApi)
WatsonxAiChatModel(WatsonxAiApi watsonxAiApi, WatsonxAiChatOptions defaultOptions)

Method Summary

Modifier and Type	Method	Description
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
ChatOptions	getDefaultOptions()
WatsonxAiChatRequest	request(Prompt prompt)
reactor.core.publisher.Flux<ChatResponse>	stream(Prompt prompt)	Executes a method call to the AI model.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.ai.chat.model.ChatModel

call, call

Methods inherited from interface org.springframework.ai.chat.model.StreamingChatModel

stream, stream

Constructor Details

WatsonxAiChatModel

public WatsonxAiChatModel(WatsonxAiApi watsonxAiApi)

WatsonxAiChatModel

public WatsonxAiChatModel(WatsonxAiApi watsonxAiApi,
 WatsonxAiChatOptions defaultOptions)

Method Details

call

public ChatResponse call(Prompt prompt)

Description copied from interface: Model

Executes a method call to the AI model.

Specified by:

call in interface ChatModel

Specified by:

call in interface Model<Prompt,ChatResponse>

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the response from the AI model

stream

public reactor.core.publisher.Flux<ChatResponse> stream(Prompt prompt)

Description copied from interface: StreamingModel

Executes a method call to the AI model.

Specified by:

stream in interface ChatModel

Specified by:

stream in interface StreamingChatModel

Specified by:

stream in interface StreamingModel<Prompt,ChatResponse>

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the streaming response from the AI model

request

public WatsonxAiChatRequest request(Prompt prompt)

getDefaultOptions

public ChatOptions getDefaultOptions()

Specified by:

getDefaultOptions in interface ChatModel