Spring/spring-ai
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix javadoc errors

Browse Source
This commit is contained in:
Ilayaperumal Gopinathan
2024-12-21 00:13:06 +00:00
parent 80317e2de6
commit 1dd9de422d
8 changed files with 67 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
spring-ai-core/src/main/java/org/springframework/ai/vectorstore/SearchRequest.java
View File

@@ -85,7 +85,7 @@ public final class SearchRequest {
* string. Use the {@link Builder#query(String query)} to set/update the embedding
* query text.
* @return Returns new {@link SearchRequest} builder instance.
* @deprecated use {@link Builder#builder().build()} instead.
* @deprecated use {@link Builder#builder()} instead.
*/
@Deprecated(forRemoval = true, since = "1.0.0-M5")
public static Builder defaults() {

4
spring-ai-spring-boot-autoconfigure/src/main/java/org/springframework/ai/autoconfigure/vectorstore/weaviate/WeaviateVectorStoreAutoConfiguration.java
View File

@@ -25,10 +25,8 @@ import io.weaviate.client.v1.auth.exception.AuthException;
import org.springframework.ai.embedding.BatchingStrategy;
import org.springframework.ai.embedding.EmbeddingModel;
import org.springframework.ai.embedding.TokenCountBatchingStrategy;
import org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore;
import org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.WeaviateVectorStoreConfig;
import org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore.WeaviateVectorStoreConfig.MetadataField;
import org.springframework.ai.vectorstore.observation.VectorStoreObservationConvention;
import org.springframework.ai.vectorstore.weaviate.WeaviateVectorStore;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;

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

@@ -18,12 +18,17 @@ package org.springframework.ai.vectorstore.cosmosdb;
import java.util.List;
import com.azure.cosmos.CosmosAsyncClient;
import org.springframework.ai.embedding.EmbeddingModel;
/**
* Configuration properties for a CosmosDB vector store.
*
* @author Theo van Kraay
* @since 1.0.0
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead.
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public class CosmosDBVectorStoreConfig implements AutoCloseable {
@@ -47,7 +52,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
private List<String> metadataFieldsList;
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public int getVectorStoreThroughput() {
@@ -55,7 +61,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public void setVectorStoreThroughput(int vectorStoreThroughput) {
@@ -63,7 +70,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public String getMetadataFields() {
@@ -71,7 +79,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public void setMetadataFields(String metadataFields) {
@@ -80,7 +89,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public List<String> getMetadataFieldsList() {
@@ -88,7 +98,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public String getEndpoint() {
@@ -96,7 +107,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public void setEndpoint(String endpoint) {
@@ -104,7 +116,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public String getKey() {
@@ -112,7 +125,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public void setKey(String key) {
@@ -120,7 +134,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public String getContainerName() {
@@ -128,7 +143,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} )} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public void setContainerName(String containerName) {
@@ -136,7 +152,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public String getDatabaseName() {
@@ -144,7 +161,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public void setDatabaseName(String databaseName) {
@@ -152,7 +170,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public String getPartitionKeyPath() {
@@ -160,7 +179,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public void setPartitionKeyPath(String partitionKeyPath) {
@@ -173,7 +193,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public long getVectorDimensions() {
@@ -181,7 +202,8 @@ public class CosmosDBVectorStoreConfig implements AutoCloseable {
}
/**
* @deprecated Since 1.0.0-M5, use {@link CosmosDBVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use
* {@link CosmosDBVectorStore#builder(CosmosAsyncClient, EmbeddingModel)} instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public void setVectorDimensions(long vectorDimensions) {

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

@@ -48,6 +48,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.ai.cassandra.SchemaUtil;
import org.springframework.ai.embedding.EmbeddingModel;
import org.springframework.lang.Nullable;
/**
@@ -65,7 +66,8 @@ import org.springframework.lang.Nullable;
*
* @author Mick Semb Wever
* @since 1.0.0
* @deprecated since 1.0.0-M5, use {@link CassandraVectorStore#builder()} instead
* @deprecated since 1.0.0-M5, use {@link CassandraVectorStore#builder(EmbeddingModel)}
* instead.
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public final class CassandraVectorStoreConfig implements AutoCloseable {

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

@@ -406,8 +406,7 @@ public class ElasticsearchVectorStore extends AbstractObservationVectorStore imp
/**
* Sets the Elasticsearch REST client.
* @param restClient the Elasticsearch REST client
* @return the builder instance
* @throws IllegalArgumentException if restClient is null
* @param embeddingModel the Embedding Model to be used
*/
public ElasticsearchBuilder(RestClient restClient, EmbeddingModel embeddingModel) {
super(embeddingModel);

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

@@ -603,7 +603,8 @@ public class GemFireVectorStore extends AbstractObservationVectorStore implement
/**
* Configuration class for GemFire Vector Store.
*
* @deprecated Since 1.0.0-M5, use {@link GemFireVectorStore#builder()} instead
* @deprecated Since 1.0.0-M5, use {@link GemFireVectorStore#builder(EmbeddingModel)}
* instead
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public static final class GemFireVectorStoreConfig {

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

@@ -16,6 +16,8 @@
package org.springframework.ai.vectorstore.hanadb;
import org.springframework.ai.embedding.EmbeddingModel;
/**
* The {@code HanaCloudVectorStoreConfig} class represents the configuration for the
* HanaCloudVectorStore. It provides methods to retrieve the table name and the topK
@@ -23,7 +25,8 @@ package org.springframework.ai.vectorstore.hanadb;
*
* @author Rahul Mittal
* @since 1.0.0
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
* @deprecated Since 1.0.0-M5, use
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public final class HanaCloudVectorStoreConfig {
@@ -38,7 +41,8 @@ public final class HanaCloudVectorStoreConfig {
/**
* Creates a new builder for HanaCloudVectorStoreConfig.
* @return a new builder instance
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
* @deprecated Since 1.0.0-M5, use
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public static HanaCloudVectorStoreConfigBuilder builder() {
@@ -46,7 +50,8 @@ public final class HanaCloudVectorStoreConfig {
}
/**
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
* @deprecated Since 1.0.0-M5, use
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public String getTableName() {
@@ -54,7 +59,8 @@ public final class HanaCloudVectorStoreConfig {
}
/**
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
* @deprecated Since 1.0.0-M5, use
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public int getTopK() {
@@ -62,7 +68,8 @@ public final class HanaCloudVectorStoreConfig {
}
/**
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
* @deprecated Since 1.0.0-M5, use
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public static class HanaCloudVectorStoreConfigBuilder {
@@ -72,7 +79,8 @@ public final class HanaCloudVectorStoreConfig {
private int topK;
/**
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
* @deprecated Since 1.0.0-M5, use
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public HanaCloudVectorStoreConfigBuilder tableName(String tableName) {
@@ -81,7 +89,8 @@ public final class HanaCloudVectorStoreConfig {
}
/**
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
* @deprecated Since 1.0.0-M5, use
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public HanaCloudVectorStoreConfigBuilder topK(int topK) {
@@ -90,7 +99,8 @@ public final class HanaCloudVectorStoreConfig {
}
/**
* @deprecated Since 1.0.0-M5, use {@link HanaCloudVectorStore#builder()}
* @deprecated Since 1.0.0-M5, use
* {@link HanaCloudVectorStore#builder(HanaVectorRepository, EmbeddingModel)}
*/
@Deprecated(since = "1.0.0-M5", forRemoval = true)
public HanaCloudVectorStoreConfig build() {

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

@@ -772,8 +772,7 @@ public class OracleVectorStore extends AbstractObservationVectorStore implements
/**
* Sets the JdbcTemplate to be used for database operations.
* @param jdbcTemplate the JdbcTemplate instance
* @return the builder instance
* @throws IllegalArgumentException if jdbcTemplate is null
* @param embeddingModel the Embedding Model to be used
*/
public OracleBuilder(JdbcTemplate jdbcTemplate, EmbeddingModel embeddingModel) {
super(embeddingModel);