https://github.com/pablosanchi/ibm-watsonxai-spring-ai-example
Example of IBM watsonx.ai with Spring AI
https://github.com/pablosanchi/ibm-watsonxai-spring-ai-example
embeddings generative-ai ibm java spring-ai watsonx-ai
Last synced: about 2 months ago
JSON representation
Example of IBM watsonx.ai with Spring AI
- Host: GitHub
- URL: https://github.com/pablosanchi/ibm-watsonxai-spring-ai-example
- Owner: PabloSanchi
- Created: 2024-03-16T12:32:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-25T21:24:23.000Z (about 1 year ago)
- Last Synced: 2024-08-25T23:10:45.580Z (about 1 year ago)
- Topics: embeddings, generative-ai, ibm, java, spring-ai, watsonx-ai
- Language: Java
- Homepage: https://docs.spring.io/spring-ai/reference/1.0-SNAPSHOT/api/chat/watsonx-ai-chat.html
- Size: 84 KB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Watsonx AI Integration
## Overview
This project demonstrates how to integrate IBM's Watsonx AI models into a Spring Boot application. The application provides endpoints for generating chat responses and text embeddings using the Watsonx AI chat and embedding models. As a contributor to the Spring AI module, I have implemented these integrations to enable seamless interactions with Watsonx AI.
## Features
- **Chat API**: Get responses from the Watsonx AI chat model based on input text.
- **Streaming Chat API**: Stream responses from the Watsonx AI chat model in real-time.
- **Embedding API**: Get text embeddings using the Watsonx AI embedding model.
## Notes
- Embedding models: [CLICK HERE](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models-embed.html?context=wx&audience=wdp)
- Chat models: [CLICK HERE](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-api-model-ids.html?context=wx&audience=wdp)
## Getting Started
1. **Clone the Repository**
```sh
git clone https://github.com/PabloSanchi/IBM-WatsonxAI-Spring-AI-Example
```
2. **Change Directory**
```sh
cd IBM-WatsonxAI-Spring-AI-Example
```
3. **Configure Watsonx AI**: Ensure you have your Watsonx AI credentials set up in your application properties or environment variables.
Example shcema:
```properties
spring:
ai:
watsonx:
ai:
base-url: ${WATSONX_BASE_URL}
stream-endpoint: ${WATSONX_STREAM_ENDPOINT}
text-endpoint: ${WATSONX_TEXT_ENDPOINT}
embedding-endpoint: ${WATSONX_EMBEDDING_ENDPOINT}
project-id: ${WATSONX_PROJECT_ID}
iam-token: ${WATSONX_IAM_TOKEN}
chat:
options:
model: ${WATSONX_CHAT_MODEL}
embedding:
options:
model: ${WATSONX_EMBEDDING_MODEL}
springdoc:
swagger-ui:
path: /swagger.html
```
5. **Run the APP**
6. **Go to the Swagger UI**: test the endpoints http://localhost:8080/swagger-ui/index.html
## Build
To build the project, run the following command:
```sh
./mvnw clean install
```
To run the project linter and formatter, run the following command:
```sh
./mvnw spring-javaformat:apply
```
## Incoming updates to spring ai watsonxai integration:
- Retry template instead of fixed retry policy
- Add new watsonx ai options (HAP)
- \[NOT FINAL\] Add Instana observability, see this [gh issue](https://github.com/spring-projects/spring-ai/issues/953)