diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/azure-cosmos-db.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/azure-cosmos-db.adoc index 2e1cac5af1c..ad98d35af76 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/azure-cosmos-db.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/azure-cosmos-db.adoc @@ -105,12 +105,12 @@ The following configuration properties are available for the Cosmos DB vector st |=== | Property | Description -| spring.ai.vectorstore.cosmosdb.databaseName | The name of the Cosmos DB database to use. -| spring.ai.vectorstore.cosmosdb.containerName | The name of the Cosmos DB container to use. -| spring.ai.vectorstore.cosmosdb.partitionKeyPath | The path for the partition key. -| spring.ai.vectorstore.cosmosdb.metadataFields | Comma-separated list of metadata fields. -| spring.ai.vectorstore.cosmosdb.vectorStoreThroughput | The throughput for the vector store. -| spring.ai.vectorstore.cosmosdb.vectorDimensions | The number of dimensions for the vectors. +| spring.ai.vectorstore.cosmosdb.database-name | The name of the Cosmos DB database to use. +| spring.ai.vectorstore.cosmosdb.container-name | The name of the Cosmos DB container to use. +| spring.ai.vectorstore.cosmosdb.partition-key-path | The path for the partition key. +| spring.ai.vectorstore.cosmosdb.metadata-fields | Comma-separated list of metadata fields. +| spring.ai.vectorstore.cosmosdb.vector-store-throughput | The throughput for the vector store. +| spring.ai.vectorstore.cosmosdb.vector-dimensions | The number of dimensions for the vectors. | spring.ai.vectorstore.cosmosdb.endpoint | The endpoint for the Cosmos DB. | spring.ai.vectorstore.cosmosdb.key | The key for the Cosmos DB. |=== diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/chroma.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/chroma.adoc index 49cbdd1b5a3..65843a72a7d 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/chroma.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/chroma.adoc @@ -79,7 +79,7 @@ spring.ai.vectorstore.chroma.collection-name= # Chroma Vector Store configuration properties # OpenAI API key if the OpenAI auto-configuration is used. -spring.ai.openai.api.key= +spring.ai.openai.api-key= ---- Please have a look at the list of xref:#_configuration_properties[configuration parameters] for the vector store to learn about the default values and configuration options. diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/neo4j.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/neo4j.adoc index 51cd2d94ff3..a16e36cdc74 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/neo4j.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/neo4j.adoc @@ -62,7 +62,7 @@ spring.neo4j.uri= spring.neo4j.authentication.username= spring.neo4j.authentication.password= # API key if needed, e.g. OpenAI -spring.ai.openai.api.key= +spring.ai.openai.api-key= ---- environment variables, diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/opensearch.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/opensearch.adoc index 66e6e7dfefc..45336efd075 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/opensearch.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/opensearch.adoc @@ -55,17 +55,17 @@ spring: uris: username: password: - indexName: - mappingJson: + index-name: + mapping-json: aws: host: - serviceName: - accessKey: - secretKey: + service-name: + access-key: + secret-key: region: # API key if needed, e.g. OpenAI openai: - apiKey: + api-key: ---- TIP: Check the list of xref:#_configuration_properties[configuration parameters] to learn about the default values and configuration options. @@ -102,7 +102,7 @@ Then use the `spring.ai.vectorstore.opensearch.*` properties to configure the co === Amazon OpenSearch Service -To enable Amazon OpenSearch Service., add the following dependency to your project's Maven `pom.xml` or Gradle `build.gradle` build files: +To enable Amazon OpenSearch Service, add the following dependency to your project's Maven `pom.xml` or Gradle `build.gradle` build files: [tabs] ====== @@ -172,8 +172,8 @@ You can use the following properties in your Spring Boot configuration to custom |`spring.ai.vectorstore.opensearch.uris`| URIs of the OpenSearch cluster endpoints. | - |`spring.ai.vectorstore.opensearch.username`| Username for accessing the OpenSearch cluster. | - |`spring.ai.vectorstore.opensearch.password`| Password for the specified username. | - -|`spring.ai.vectorstore.opensearch.indexName`| Name of the default index to be used within the OpenSearch cluster. | `spring-ai-document-index` -|`spring.ai.vectorstore.opensearch.mappingJson`| JSON string defining the mapping for the index; specifies how documents and their +|`spring.ai.vectorstore.opensearch.index-name`| Name of the default index to be used within the OpenSearch cluster. | `spring-ai-document-index` +|`spring.ai.vectorstore.opensearch.mapping-json`| JSON string defining the mapping for the index; specifies how documents and their fields are stored and indexed. Refer link:https://opensearch.org/docs/latest/search-plugins/vector-search/[here] for some sample configurations | { "properties":{ @@ -184,9 +184,9 @@ fields are stored and indexed. Refer link:https://opensearch.org/docs/latest/sea } } |`spring.ai.vectorstore.opensearch.aws.host`| Hostname of the OpenSearch instance. | - -|`spring.ai.vectorstore.opensearch.aws.serviceName`| AWS service name for the OpenSearch instance. | - -|`spring.ai.vectorstore.opensearch.aws.accessKey`| AWS access key for the OpenSearch instance. | - -|`spring.ai.vectorstore.opensearch.aws.secretKey`| AWS secret key for the OpenSearch instance. | - +|`spring.ai.vectorstore.opensearch.aws.service-name`| AWS service name for the OpenSearch instance. | - +|`spring.ai.vectorstore.opensearch.aws.access-key`| AWS access key for the OpenSearch instance. | - +|`spring.ai.vectorstore.opensearch.aws.secret-key`| AWS secret key for the OpenSearch instance. | - |`spring.ai.vectorstore.opensearch.aws.region`| AWS region for the OpenSearch instance. | - |=== diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pinecone.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pinecone.adoc index 45f5a9253b1..1d0d7568c4b 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pinecone.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pinecone.adoc @@ -74,7 +74,7 @@ spring.ai.vectorstore.pinecone.projectId= spring.ai.vectorstore.pinecone.index-name= # API key if needed, e.g. OpenAI -spring.ai.openai.api.key= +spring.ai.openai.api-key= ---- Please have a look at the list of xref:#_configuration_properties[configuration parameters] for the vector store to learn about the default values and configuration options. diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/qdrant.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/qdrant.adoc index 6df3e7ee1ed..56d52f53493 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/qdrant.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/qdrant.adoc @@ -76,7 +76,7 @@ spring.ai.vectorstore.qdrant.api-key= spring.ai.vectorstore.qdrant.collection-name= # API key if needed, e.g. OpenAI -spring.ai.openai.api.key= +spring.ai.openai.api-key= ---- TIP: Check the list of xref:#qdrant-vectorstore-properties[configuration parameters] to learn about the default values and configuration options. diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/redis.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/redis.adoc index cd6337ba78d..a6d00dfbeec 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/redis.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/redis.adoc @@ -74,7 +74,7 @@ spring.ai.vectorstore.redis.index= spring.ai.vectorstore.redis.prefix= # API key if needed, e.g. OpenAI -spring.ai.openai.api.key= +spring.ai.openai.api-key= ---- Please have a look at the list of xref:#_configuration_properties[configuration parameters] for the vector store to learn about the default values and configuration options. diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/weaviate.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/weaviate.adoc index 5c1ce1be0fc..2fe25d24e30 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/weaviate.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/weaviate.adoc @@ -80,7 +80,7 @@ spring.ai.vectorstore.weaviate.api-key= spring.ai.vectorstore.weaviate.scheme=http # API key if needed, e.g. OpenAI -spring.ai.openai.api.key= +spring.ai.openai.api-key= ---- TIP: Check the list of xref:#weaviate-vectorstore-properties[configuration parameters] to learn about the default values and configuration options.