Skip to content

docs: update config using recommended lower-case kebab format for properties #1786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

docs: update config using recommended lower-case kebab format for properties #1786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0674e9
docs: update OpenSearch config using recommended lower-case kebab for…
apappascs Oct 25, 2024
b1b845b
docs: update neo4j, pinecone, qdrant, redis, weaviate
apappascs Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions ...g-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/azure-cosmos-db.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
|===
Expand Down
2 changes: 1 addition & 1 deletion spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/chroma.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ spring.ai.vectorstore.chroma.collection-name=<your collection name>
# Chroma Vector Store configuration properties

# OpenAI API key if the OpenAI auto-configuration is used.
spring.ai.openai.api.key=<OpenAI Api-key>
spring.ai.openai.api-key=<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.
Expand Down
2 changes: 1 addition & 1 deletion spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/neo4j.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ spring.neo4j.uri=<uri_for_your_neo4j_instance>
spring.neo4j.authentication.username=<your_username>
spring.neo4j.authentication.password=<your_password>
# API key if needed, e.g. OpenAI
spring.ai.openai.api.key=<api-key>
spring.ai.openai.api-key=<OpenAI Api-key>
----

environment variables,
Expand Down
24 changes: 12 additions & 12 deletions spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/opensearch.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,17 @@ spring:
uris: <opensearch instance URIs>
username: <opensearch username>
password: <opensearch password>
indexName: <opensearch index name>
mappingJson: <JSON mapping for opensearch index>
index-name: <opensearch index name>
mapping-json: <JSON mapping for opensearch index>
aws:
host: <aws opensearch host>
serviceName: <aws service name>
accessKey: <aws access key>
secretKey: <aws secret key>
service-name: <aws service name>
access-key: <aws access key>
secret-key: <aws secret key>
region: <aws region>
# API key if needed, e.g. OpenAI
openai:
apiKey: <api-key>
api-key: <api-key>
----
TIP: Check the list of xref:#_configuration_properties[configuration parameters] to learn about the default values and configuration options.

Expand Down Expand Up @@ -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]
======
Expand Down Expand Up @@ -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":{
Expand All @@ -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. | -
|===

Expand Down
2 changes: 1 addition & 1 deletion spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/pinecone.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ spring.ai.vectorstore.pinecone.projectId=<your project id>
spring.ai.vectorstore.pinecone.index-name=<your index name>

# API key if needed, e.g. OpenAI
spring.ai.openai.api.key=<api-key>
spring.ai.openai.api-key=<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.
Expand Down
2 changes: 1 addition & 1 deletion spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/qdrant.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ spring.ai.vectorstore.qdrant.api-key=<your api key>
spring.ai.vectorstore.qdrant.collection-name=<The name of the collection to use in Qdrant>

# API key if needed, e.g. OpenAI
spring.ai.openai.api.key=<api-key>
spring.ai.openai.api-key=<OpenAI Api-key>
----

TIP: Check the list of xref:#qdrant-vectorstore-properties[configuration parameters] to learn about the default values and configuration options.
Expand Down
2 changes: 1 addition & 1 deletion spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/redis.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ spring.ai.vectorstore.redis.index=<your index name>
spring.ai.vectorstore.redis.prefix=<your prefix>

# API key if needed, e.g. OpenAI
spring.ai.openai.api.key=<api-key>
spring.ai.openai.api-key=<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.
Expand Down
2 changes: 1 addition & 1 deletion spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/weaviate.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ spring.ai.vectorstore.weaviate.api-key=<your api key>
spring.ai.vectorstore.weaviate.scheme=http

# API key if needed, e.g. OpenAI
spring.ai.openai.api.key=<api-key>
spring.ai.openai.api-key=<OpenAI Api-key>
----

TIP: Check the list of xref:#weaviate-vectorstore-properties[configuration parameters] to learn about the default values and configuration options.
Expand Down