Package org.springframework.ai.watsonx.api

Class WatsonxAiApi

java.lang.Object

org.springframework.ai.watsonx.api.WatsonxAiApi

public class WatsonxAiApi
extends Object

Java Client for the watsonx.ai API. https://www.ibm.com/products/watsonx-ai

Since:

1.0.0

Author:

John Jairo Moreno Rojas, Pablo Sanchidrian Herrera

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WATSONX_REQUEST_CANNOT_BE_NULL

Constructor Summary

Constructors

Constructor	Description
WatsonxAiApi(String baseUrl, String streamEndpoint, String textEndpoint, String embeddingEndpoint, String projectId, String IAMToken, org.springframework.web.client.RestClient.Builder restClientBuilder)	Create a new chat api.

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<WatsonxAiEmbeddingResponse>	embeddings(WatsonxAiEmbeddingRequest request)
org.springframework.http.ResponseEntity<WatsonxAiChatResponse>	generate(WatsonxAiChatRequest watsonxAiChatRequest)
reactor.core.publisher.Flux<WatsonxAiChatResponse>	generateStreaming(WatsonxAiChatRequest watsonxAiChatRequest)

Methods inherited from class java.lang.Object

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

Field Details

WATSONX_REQUEST_CANNOT_BE_NULL

public static final String WATSONX_REQUEST_CANNOT_BE_NULL

See Also:

• Constant Field Values

Constructor Details

WatsonxAiApi

public WatsonxAiApi(String baseUrl,
 String streamEndpoint,
 String textEndpoint,
 String embeddingEndpoint,
 String projectId,
 String IAMToken,
 org.springframework.web.client.RestClient.Builder restClientBuilder)

Create a new chat api.

Parameters:

baseUrl - api base URL.

streamEndpoint - streaming generation.

textEndpoint - text generation.

embeddingEndpoint - embedding generation

projectId - watsonx.ai project identifier.

IAMToken - IBM Cloud IAM token.

restClientBuilder - rest client builder.

Method Details

generate

@Retryable(retryFor=java.lang.Exception.class,
           maxAttempts=3,
           backoff=@Backoff(random=true,delay=1200L,maxDelay=7000L,multiplier=2.5))
public org.springframework.http.ResponseEntity<WatsonxAiChatResponse> generate(WatsonxAiChatRequest watsonxAiChatRequest)

generateStreaming

@Retryable(retryFor=java.lang.Exception.class,
           maxAttempts=3,
           backoff=@Backoff(random=true,delay=1200L,maxDelay=7000L,multiplier=2.5))
public reactor.core.publisher.Flux<WatsonxAiChatResponse> generateStreaming(WatsonxAiChatRequest watsonxAiChatRequest)

embeddings

@Retryable(retryFor=java.lang.Exception.class,
           maxAttempts=3,
           backoff=@Backoff(random=true,delay=1200L,maxDelay=7000L,multiplier=2.5))
public org.springframework.http.ResponseEntity<WatsonxAiEmbeddingResponse> embeddings(WatsonxAiEmbeddingRequest request)