Skip to content

Commit 1dd9de4

Browse files
ilayaperumalgilayaperumalg
committed
Fix javadoc errors
1 parent 80317e2 commit 1dd9de4

File tree

8 files changed

+67
-36
lines changed

8 files changed

+67
-36
lines changed

‎spring-ai-core/src/main/java/org/springframework/ai/vectorstore/SearchRequest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ public static SearchRequest query(String query) {
8585
* string. Use the {@link Builder#query(String query)} to set/update the embedding
8686
* query text.
8787
* @return Returns new {@link SearchRequest} builder instance.
88-
* @deprecated use {@link Builder#builder().build()} instead.
88+
* @deprecated use {@link Builder#builder()} instead.
8989
*/
9090
@Deprecated(forRemoval = true, since = "1.0.0-M5")
9191
public static Builder defaults() {

‎spring-ai-spring-boot-autoconfigure/src/main/java/org/springframework/ai/autoconfigure/vectorstore/weaviate/WeaviateVectorStoreAutoConfiguration.java‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,8 @@
2525
import org.springframework.ai.embedding.BatchingStrategy;
2626
import org.springframework.ai.embedding.EmbeddingModel;
2727
import org.springframework.ai.embedding.TokenCountBatchingStrategy;
28-
import org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore;
29-
import org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.WeaviateVectorStoreConfig;
30-
import org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.WeaviateVectorStoreConfig.MetadataField;
3128
import org.springframework.ai.vectorstore.observation.VectorStoreObservationConvention;
29+
import org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore;
3230
import org.springframework.beans.factory.ObjectProvider;
3331
import org.springframework.boot.autoconfigure.AutoConfiguration;
3432
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;

‎vector-stores/spring-ai-azure-cosmos-db-store/src/main/java/org/springframework/ai/vectorstore/cosmosdb/CosmosDBVectorStoreConfig.java‎

Lines changed: 40 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,17 @@
1818

1919
import java.util.List;
2020

21+
import com.azure.cosmos.CosmosAsyncClient;
22+
23+
import org.springframework.ai.embedding.EmbeddingModel;
24+
2125
/**
2226
* Configuration properties for a CosmosDB vector store.
2327
*
2428
* @author Theo van Kraay
2529
* @since 1.0.0
26-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
30+
* @deprecated Since 1.0.0-M5, use
31+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead.
2732
*/
2833
@Deprecated(since = "1.0.0-M5", forRemoval = true)
2934
public class CosmosDBVectorStoreConfig implements AutoCloseable {
@@ -47,31 +52,35 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
4752
private List<String> metadataFieldsList;
4853

4954
/**
50-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
55+
* @deprecated Since 1.0.0-M5, use
56+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
5157
*/
5258
@Deprecated(since = "1.0.0-M5", forRemoval = true)
5359
public int getVectorStoreThroughput() {
5460
return this.vectorStoreThroughput;
5561
}
5662

5763
/**
58-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
64+
* @deprecated Since 1.0.0-M5, use
65+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
5966
*/
6067
@Deprecated(since = "1.0.0-M5", forRemoval = true)
6168
public void setVectorStoreThroughput(int vectorStoreThroughput) {
6269
this.vectorStoreThroughput = vectorStoreThroughput;
6370
}
6471

6572
/**
66-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
73+
* @deprecated Since 1.0.0-M5, use
74+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
6775
*/
6876
@Deprecated(since = "1.0.0-M5", forRemoval = true)
6977
public String getMetadataFields() {
7078
return this.metadataFields;
7179
}
7280

7381
/**
74-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
82+
* @deprecated Since 1.0.0-M5, use
83+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
7584
*/
7685
@Deprecated(since = "1.0.0-M5", forRemoval = true)
7786
public void setMetadataFields(String metadataFields) {
@@ -80,87 +89,98 @@ public void setMetadataFields(String metadataFields) {
8089
}
8190

8291
/**
83-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
92+
* @deprecated Since 1.0.0-M5, use
93+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
8494
*/
8595
@Deprecated(since = "1.0.0-M5", forRemoval = true)
8696
public List<String> getMetadataFieldsList() {
8797
return this.metadataFieldsList;
8898
}
8999

90100
/**
91-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
101+
* @deprecated Since 1.0.0-M5, use
102+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
92103
*/
93104
@Deprecated(since = "1.0.0-M5", forRemoval = true)
94105
public String getEndpoint() {
95106
return this.endpoint;
96107
}
97108

98109
/**
99-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
110+
* @deprecated Since 1.0.0-M5, use
111+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
100112
*/
101113
@Deprecated(since = "1.0.0-M5", forRemoval = true)
102114
public void setEndpoint(String endpoint) {
103115
this.endpoint = endpoint;
104116
}
105117

106118
/**
107-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
119+
* @deprecated Since 1.0.0-M5, use
120+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
108121
*/
109122
@Deprecated(since = "1.0.0-M5", forRemoval = true)
110123
public String getKey() {
111124
return this.key;
112125
}
113126

114127
/**
115-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
128+
* @deprecated Since 1.0.0-M5, use
129+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
116130
*/
117131
@Deprecated(since = "1.0.0-M5", forRemoval = true)
118132
public void setKey(String key) {
119133
this.key = key;
120134
}
121135

122136
/**
123-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
137+
* @deprecated Since 1.0.0-M5, use
138+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
124139
*/
125140
@Deprecated(since = "1.0.0-M5", forRemoval = true)
126141
public String getContainerName() {
127142
return this.containerName;
128143
}
129144

130145
/**
131-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
146+
* @deprecated Since 1.0.0-M5, use
147+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} )} instead
132148
*/
133149
@Deprecated(since = "1.0.0-M5", forRemoval = true)
134150
public void setContainerName(String containerName) {
135151
this.containerName = containerName;
136152
}
137153

138154
/**
139-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
155+
* @deprecated Since 1.0.0-M5, use
156+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
140157
*/
141158
@Deprecated(since = "1.0.0-M5", forRemoval = true)
142159
public String getDatabaseName() {
143160
return this.databaseName;
144161
}
145162

146163
/**
147-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
164+
* @deprecated Since 1.0.0-M5, use
165+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
148166
*/
149167
@Deprecated(since = "1.0.0-M5", forRemoval = true)
150168
public void setDatabaseName(String databaseName) {
151169
this.databaseName = databaseName;
152170
}
153171

154172
/**
155-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
173+
* @deprecated Since 1.0.0-M5, use
174+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
156175
*/
157176
@Deprecated(since = "1.0.0-M5", forRemoval = true)
158177
public String getPartitionKeyPath() {
159178
return this.partitionKeyPath;
160179
}
161180

162181
/**
163-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
182+
* @deprecated Since 1.0.0-M5, use
183+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
164184
*/
165185
@Deprecated(since = "1.0.0-M5", forRemoval = true)
166186
public void setPartitionKeyPath(String partitionKeyPath) {
@@ -173,15 +193,17 @@ public void close() throws Exception {
173193
}
174194

175195
/**
176-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
196+
* @deprecated Since 1.0.0-M5, use
197+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
177198
*/
178199
@Deprecated(since = "1.0.0-M5", forRemoval = true)
179200
public long getVectorDimensions() {
180201
return this.vectorDimensions;
181202
}
182203

183204
/**
184-
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
205+
* @deprecated Since 1.0.0-M5, use
206+
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
185207
*/
186208
@Deprecated(since = "1.0.0-M5", forRemoval = true)
187209
public void setVectorDimensions(long vectorDimensions) {

‎vector-stores/spring-ai-cassandra-store/src/main/java/org/springframework/ai/vectorstore/cassandra/CassandraVectorStoreConfig.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
import org.slf4j.LoggerFactory;
4949

5050
import org.springframework.ai.cassandra.SchemaUtil;
51+
import org.springframework.ai.embedding.EmbeddingModel;
5152
import org.springframework.lang.Nullable;
5253

5354
/**
@@ -65,7 +66,8 @@
6566
*
6667
* @author Mick Semb Wever
6768
* @since 1.0.0
68-
* @deprecated since 1.0.0-M5, use {@link CassandraVectorStore#builder()} instead
69+
* @deprecated since 1.0.0-M5, use {@link CassandraVectorStore#builder(EmbeddingModel)}
70+
* instead.
6971
*/
7072
@Deprecated(since = "1.0.0-M5", forRemoval = true)
7173
public final class CassandraVectorStoreConfig implements AutoCloseable {

‎vector-stores/spring-ai-elasticsearch-store/src/main/java/org/springframework/ai/vectorstore/elasticsearch/ElasticsearchVectorStore.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -406,8 +406,7 @@ public static class ElasticsearchBuilder extends AbstractVectorStoreBuilder<Elas
406406
/**
407407
* Sets the Elasticsearch REST client.
408408
* @param restClient the Elasticsearch REST client
409-
* @return the builder instance
410-
* @throws IllegalArgumentException if restClient is null
409+
* @param embeddingModel the Embedding Model to be used
411410
*/
412411
public ElasticsearchBuilder(RestClient restClient, EmbeddingModel embeddingModel) {
413412
super(embeddingModel);

‎vector-stores/spring-ai-gemfire-store/src/main/java/org/springframework/ai/vectorstore/gemfire/GemFireVectorStore.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -603,7 +603,8 @@ public void setDeleteData(boolean deleteData) {
603603
/**
604604
* Configuration class for GemFire Vector Store.
605605
*
606-
* @deprecated Since 1.0.0-M5, use {@link GemFireVectorStore#builder()} instead
606+
* @deprecated Since 1.0.0-M5, use {@link GemFireVectorStore#builder(EmbeddingModel)}
607+
* instead
607608
*/
608609
@Deprecated(since = "1.0.0-M5", forRemoval = true)
609610
public static final class GemFireVectorStoreConfig {

‎vector-stores/spring-ai-hanadb-store/src/main/java/org/springframework/ai/vectorstore/hanadb/HanaCloudVectorStoreConfig.java‎

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,17 @@
1616

1717
package org.springframework.ai.vectorstore.hanadb;
1818

19+
import org.springframework.ai.embedding.EmbeddingModel;
20+
1921
/**
2022
* The {@code HanaCloudVectorStoreConfig} class represents the configuration for the
2123
* HanaCloudVectorStore. It provides methods to retrieve the table name and the topK
2224
* value.
2325
*
2426
* @author Rahul Mittal
2527
* @since 1.0.0
26-
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
28+
* @deprecated Since 1.0.0-M5, use
29+
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
2730
*/
2831
@Deprecated(since = "1.0.0-M5", forRemoval = true)
2932
public final class HanaCloudVectorStoreConfig {
@@ -38,31 +41,35 @@ private HanaCloudVectorStoreConfig() {
3841
/**
3942
* Creates a new builder for HanaCloudVectorStoreConfig.
4043
* @return a new builder instance
41-
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
44+
* @deprecated Since 1.0.0-M5, use
45+
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
4246
*/
4347
@Deprecated(since = "1.0.0-M5", forRemoval = true)
4448
public static HanaCloudVectorStoreConfigBuilder builder() {
4549
return new HanaCloudVectorStoreConfigBuilder();
4650
}
4751

4852
/**
49-
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
53+
* @deprecated Since 1.0.0-M5, use
54+
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
5055
*/
5156
@Deprecated(since = "1.0.0-M5", forRemoval = true)
5257
public String getTableName() {
5358
return this.tableName;
5459
}
5560

5661
/**
57-
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
62+
* @deprecated Since 1.0.0-M5, use
63+
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
5864
*/
5965
@Deprecated(since = "1.0.0-M5", forRemoval = true)
6066
public int getTopK() {
6167
return this.topK;
6268
}
6369

6470
/**
65-
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
71+
* @deprecated Since 1.0.0-M5, use
72+
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
6673
*/
6774
@Deprecated(since = "1.0.0-M5", forRemoval = true)
6875
public static class HanaCloudVectorStoreConfigBuilder {
@@ -72,7 +79,8 @@ public static class HanaCloudVectorStoreConfigBuilder {
7279
private int topK;
7380

7481
/**
75-
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
82+
* @deprecated Since 1.0.0-M5, use
83+
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
7684
*/
7785
@Deprecated(since = "1.0.0-M5", forRemoval = true)
7886
public HanaCloudVectorStoreConfigBuilder tableName(String tableName) {
@@ -81,7 +89,8 @@ public HanaCloudVectorStoreConfigBuilder tableName(String tableName) {
8189
}
8290

8391
/**
84-
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
92+
* @deprecated Since 1.0.0-M5, use
93+
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
8594
*/
8695
@Deprecated(since = "1.0.0-M5", forRemoval = true)
8796
public HanaCloudVectorStoreConfigBuilder topK(int topK) {
@@ -90,7 +99,8 @@ public HanaCloudVectorStoreConfigBuilder topK(int topK) {
9099
}
91100

92101
/**
93-
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
102+
* @deprecated Since 1.0.0-M5, use
103+
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
94104
*/
95105
@Deprecated(since = "1.0.0-M5", forRemoval = true)
96106
public HanaCloudVectorStoreConfig build() {

‎vector-stores/spring-ai-oracle-store/src/main/java/org/springframework/ai/vectorstore/oracle/OracleVectorStore.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -772,8 +772,7 @@ public static class OracleBuilder extends AbstractVectorStoreBuilder<OracleBuild
772772
/**
773773
* Sets the JdbcTemplate to be used for database operations.
774774
* @param jdbcTemplate the JdbcTemplate instance
775-
* @return the builder instance
776-
* @throws IllegalArgumentException if jdbcTemplate is null
775+
* @param embeddingModel the Embedding Model to be used
777776
*/
778777
public OracleBuilder(JdbcTemplate jdbcTemplate, EmbeddingModel embeddingModel) {
779778
super(embeddingModel);

0 commit comments

Comments
 (0)