Skip to content

Commit f6447f4

Browse files
tzolovtzolov
committed
Clean obsolate README files
1 parent 12d3ae4 commit f6447f4

File tree

11 files changed

+21
-138
lines changed

11 files changed

+21
-138
lines changed

‎spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chatclient.adoc

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -198,14 +198,6 @@ image::spring-ai-chat-completions-clients.jpg[align="center", width="800px"]
198198
//
199199
// TBD
200200

201-
== API Docs (OUTDATED!!!)
202-
203-
You can find the Javadoc https://docs.spring.io/spring-ai/docs/current-SNAPSHOT/[here].
204-
205-
== Feedback and Contributions
206-
207-
The project's https://github.com/spring-projects/spring-ai/discussions[GitHub discussions] is a great place to send feedback.
208-
209201
// == Related Resources
210202
//
211203
// TBD

‎spring-ai-docs/src/main/antora/modules/ROOT/pages/api/index.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ The <<generic-model-api>> can help you understand the basic constructs used impl
1212
* xref:api/vectordbs.adoc[Vector Database API]
1313
* xref:api/[Image Generation API](WIP)
1414

15+
== API Docs
16+
17+
You can find the Javadoc https://docs.spring.io/spring-ai/docs/current-SNAPSHOT/[here].
18+
19+
== Feedback and Contributions
20+
21+
The project's https://github.com/spring-projects/spring-ai/discussions[GitHub discussions] is a great place to send feedback.
22+
1523
== Spring AI Generic Model API [[generic-model-api]]
1624

1725
image::spring-ai-generic-model-api.jpg[width=900, align="center"]

‎vector-stores/spring-ai-azure/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[Azure AI Search Vector Store Documentation](https://docs.spring.io/spring-ai/reference/api/vectordbs/azure.html)

‎vector-stores/spring-ai-chroma/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[Chroma Vector Store Documentation](https://docs.spring.io/spring-ai/reference/api/vectordbs/chroma.html)

‎vector-stores/spring-ai-milvus-store/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[Milvus Vector Store Documentation](https://docs.spring.io/spring-ai/reference/api/vectordbs/milvus.html)

‎vector-stores/spring-ai-neo4j-store/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[Neo4j Vector Store Documentation](https://docs.spring.io/spring-ai/reference/api/vectordbs/neo4j.html)

‎vector-stores/spring-ai-pgvector-store/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[PGvector Vector Store Documentation](https://docs.spring.io/spring-ai/reference/api/vectordbs/pgvector.html)

‎vector-stores/spring-ai-pinecone/README.md

Lines changed: 1 addition & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -1,125 +1 @@
1-
# Pinecone Vector Store
2-
3-
This readme walks you through setting up the Pinecone `VectorStore` to store document embeddings and perform similarity searches.
4-
5-
## What is Pinecone?
6-
7-
[Pinecone](https://www.pinecone.io/) is a popular cloud-based vector database, which allows you to store and search vectors efficiently.
8-
9-
## Prerequisites
10-
11-
1. Pinecone Account: Before you start, sign up for a [Pinecone account](https://app.pinecone.io/).
12-
2. Pinecone Project: Once registered, create a new project, an index, and generate an API key. You'll need these details for configuration.
13-
3. OpenAI Account: Create an account at [OpenAI Signup](https://platform.openai.com/signup) and generate the token at [API Keys](https://platform.openai.com/account/api-keys)
14-
15-
## Configuration
16-
17-
To set up `PineconeVectorStore`, gather the following details from your Pinecone account:
18-
19-
* Pinecone API Key
20-
* Pinecone Environment
21-
* Pinecone Project ID
22-
* Pinecone Index Name
23-
* Pinecone Namespace
24-
25-
> **Note**
26-
> This information is available to you in the Pinecone UI portal.
27-
28-
29-
When setting up embeddings, select a vector dimension of `1536`. This matches the dimensionality of OpenAI's model `text-embedding-ada-002`, which we'll be using for this guide.
30-
31-
Additionally, you'll need to provide your OpenAI API Key. Set it as an environment variable like so:
32-
33-
```bash
34-
export SPRING_AI_OPENAI_API_KEY='Your_OpenAI_API_Key'
35-
```
36-
37-
## Repository
38-
39-
To acquire Spring AI artifacts, declare the Spring Snapshot repository:
40-
41-
```xml
42-
<repository>
43-
<id>spring-snapshots</id>
44-
<name>Spring Snapshots</name>
45-
<url>https://repo.spring.io/snapshot</url>
46-
<releases>
47-
<enabled>false</enabled>
48-
</releases>
49-
</repository>
50-
```
51-
52-
## Dependencies
53-
54-
Add these dependencies to your project:
55-
56-
1. OpenAI: Required for calculating embeddings.
57-
58-
```xml
59-
<dependency>
60-
<groupId>org.springframework.experimental.ai</groupId>
61-
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
62-
<version>0.8.0-SNAPSHOT</version>
63-
</dependency>
64-
```
65-
66-
2. Pinecone
67-
68-
```xml
69-
<dependency>
70-
<groupId>org.springframework.experimental.ai</groupId>
71-
<artifactId>spring-ai-pinecone</artifactId>
72-
<version>0.8.0-SNAPSHOT</version>
73-
</dependency>
74-
```
75-
76-
## Sample Code
77-
78-
To configure Pinecone in your application, you can use the following setup:
79-
80-
```java
81-
@Bean
82-
public PineconeVectorStoreConfig pineconeVectorStoreConfig() {
83-
84-
return PineconeVectorStoreConfig.builder()
85-
.withApiKey(<PINECONE_API_KEY>)
86-
.withEnvironment("gcp-starter")
87-
.withProjectId("89309e6")
88-
.withIndexName("spring-ai-test-index")
89-
.withNamespace("") // the free tier doesn't support namespaces.
90-
.build();
91-
}
92-
```
93-
94-
Integrate with OpenAI's embeddings by adding the Spring Boot OpenAI starter to your project.
95-
This provides you with an implementation of the Embeddings client:
96-
97-
```java
98-
@Bean
99-
public VectorStore vectorStore(PineconeVectorStoreConfig config, EmbeddingClient embeddingClient) {
100-
return new PineconeVectorStore(config, embeddingClient);
101-
}
102-
```
103-
104-
In your main code, create some documents:
105-
106-
```java
107-
List<Document> documents = List.of(
108-
new Document("Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!! Spring AI rocks!!", Map.of("meta1", "meta1")),
109-
new Document("The World is Big and Salvation Lurks Around the Corner"),
110-
new Document("You walk forward facing the past and you turn back toward the future.", Map.of("meta2", "meta2")));
111-
```
112-
113-
Add the documents to Pinecone:
114-
115-
```java
116-
vectorStore.add(List.of(document));
117-
```
118-
119-
And finally, retrieve documents similar to a query:
120-
121-
```java
122-
List<Document> results = vectorStore.similaritySearch(SearchRequest.query("Spring").withTopK(5));
123-
```
124-
125-
If all goes well, you should retrieve the document containing the text "Spring AI rocks!!".
1+
[Pinecone Vector Store Documentation](https://docs.spring.io/spring-ai/reference/api/vectordbs/pinecone.html)

‎vector-stores/spring-ai-redis/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[Redis Vector Store Documentation](https://docs.spring.io/spring-ai/reference/api/vectordbs/redis.html)

‎vector-stores/spring-ai-redis/pom.xml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515
<url>https://github.com/spring-projects/spring-ai</url>
1616

1717
<scm>
18-
<url>https://github.com/spring-projects-experimental/spring-ai</url>
19-
<connection>git://github.com/spring-projects-experimental/spring-ai.git</connection>
20-
<developerConnection>git@github.com:spring-projects-experimental/spring-ai.git</developerConnection>
18+
<url>https://github.com/spring-projects/spring-ai</url>
19+
<connection>git://github.com/spring-projects/spring-ai.git</connection>
20+
<developerConnection>git@github.com:spring-projects/spring-ai.git</developerConnection>
2121
</scm>
22-
22+
2323
<properties>
2424
<testcontainers-redis.version>2.0.1</testcontainers-redis.version>
2525
<jedis.version>5.1.0</jedis.version>
@@ -39,7 +39,7 @@
3939
<artifactId>jedis</artifactId>
4040
<version>${jedis.version}</version>
4141
</dependency>
42-
42+
4343
<!-- TESTING -->
4444
<dependency>
4545
<groupId>org.springframework.ai</groupId>

0 commit comments

Comments
 (0)