Skip to content

Commit ae6a24f

Browse files
committed
Added more references, changed erroneus statemements, sentences changed
1 parent 3255fd0 commit ae6a24f

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

tutorial/markdown/java/spring-ai.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,8 @@ length: 10 Mins
2222
---
2323

2424
## About This Tutorial
25-
This tutorial will show how to use a Couchbase database cluster as a Spring AI embedding storage.
26-
27-
## Example Source code
25+
This tutorial is your quick and easy guide to getting started with Spring AI and Couchbase as a Vector Store. Let's dive in and explore how these powerful tools can work together to enhance your applications.
26+
### Example Source code
2827
Example source code for this tutorial can be obtained from [Spring AI demo application with Couchbase Vector Store](https://github.com/couchbase-examples/couchbase-spring-ai-demo).
2928
To do this, clone the repository using git:
3029
```shell
@@ -34,6 +33,7 @@ cd couchbase-spring-ai-demo
3433

3534
### What is Spring AI?
3635

36+
3737
Spring AI is an extension of the Spring Framework that simplifies the integration of AI capabilities into Spring applications. It provides abstractions and integrations for working with various AI services and models, making it easier for developers to incorporate AI functionality without having to manage low-level implementation details.
3838

3939
Key features of Spring AI include:
@@ -42,7 +42,7 @@ Key features of Spring AI include:
4242
- **Vector stores**: Abstractions for storing and retrieving vector embeddings
4343
- **Document processing**: Utilities for working with unstructured data
4444

45-
### Why Use Spring AI?
45+
##### Why Use Spring AI?
4646

4747
Spring AI brings several benefits to Java developers:
4848
1. **Familiar programming model**: Uses Spring's dependency injection and configuration
@@ -51,10 +51,14 @@ Spring AI brings several benefits to Java developers:
5151
4. **Simplified development**: Reduces boilerplate code for AI integrations
5252

5353

54+
- [Spring AI](https://docs.spring.io/spring-ai/reference/index.html)
55+
- [Spring AI Github Page](https://github.com/spring-projects/spring-ai)
56+
57+
5458
## Couchbase Embedding Store
5559
Couchbase spring-ai integration stores each embedding in a separate document and uses an FTS vector index to perform
56-
queries against stored vectors. Currently, it supports storing embeddings and their metadata, as well as removing
57-
embeddings.
60+
queries against stored vectors.
61+
- [Couchbase Integration with Spring AI Documentation](https://docs.spring.io/spring-ai/reference/api/vectordbs/couchbase.html)
5862

5963
## Project Structure
6064

@@ -73,9 +77,9 @@ src/main/resources/
7377

7478
### Prerequisites
7579
- [Couchbase Capella](https://docs.couchbase.com/cloud/get-started/create-account.html) account or locally installed [Couchbase Server](/tutorial-couchbase-installation-options)
76-
- Java 21
80+
- Java 17
7781
- Maven
78-
- Couchbase Server running locally
82+
- Couchbase Server
7983
- OpenAI API key
8084

8185
### Configuration Details
@@ -200,6 +204,11 @@ return (List)results.stream()
200204

201205
## Using the Application
202206

207+
This is basically a Spring Boot project with two endpoints `tutorial/load` and `tutorial/search`.
208+
In order to run this application, use the following command:
209+
`./mvnw spring-boot:run`
210+
211+
203212
### Loading Data
204213

205214
1. Start the application

0 commit comments

Comments
 (0)