Skip to content

Commit 77be609

Browse files
authored
updated docs for new OpenSearch vector-store properties (#3140)
Signed-off-by: Linar Abzaltdinov <abzaltdinov@gmail.com>
1 parent cfeba7c commit 77be609

File tree

2 files changed

+10
-1
lines changed
  • auto-configurations/vector-stores/spring-ai-autoconfigure-vector-store-opensearch/src/main/java/org/springframework/ai/vectorstore/opensearch/autoconfigure
  • spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs

2 files changed

+10
-1
lines changed

auto-configurations/vector-stores/spring-ai-autoconfigure-vector-store-opensearch/src/main/java/org/springframework/ai/vectorstore/opensearch/autoconfigure/OpenSearchVectorStoreProperties.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,13 @@ public class OpenSearchVectorStoreProperties extends CommonVectorStoreProperties
4646
private String sslBundle;
4747

4848
/**
49-
*
49+
* Time to wait until connection established. 0 - infinity.
5050
*/
5151
private Duration connectionTimeout;
5252

53+
/**
54+
* Time to wait for response from the opposite endpoint. 0 - infinity.
55+
*/
5356
private Duration readTimeout;
5457

5558
private Aws aws = new Aws();

spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs/opensearch.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,9 @@ spring:
103103
index-name: spring-ai-document-index
104104
initialize-schema: true
105105
similarity-function: cosinesimil
106+
read-timeout: <time to wait for response>
107+
connect-timeout: <time to wait until connection established>
108+
ssl-bundle: <name of SSL bundle>
106109
aws: # Only for Amazon OpenSearch Service
107110
host: <aws opensearch host>
108111
service-name: <aws service name>
@@ -123,6 +126,9 @@ Properties starting with `spring.ai.vectorstore.opensearch.*` are used to config
123126
|`spring.ai.vectorstore.opensearch.index-name`| Name of the index to store vectors | `spring-ai-document-index`
124127
|`spring.ai.vectorstore.opensearch.initialize-schema`| Whether to initialize the required schema | `false`
125128
|`spring.ai.vectorstore.opensearch.similarity-function`| The similarity function to use | `cosinesimil`
129+
|`spring.ai.vectorstore.opensearch.read-timeout`| Time to wait for response from the opposite endpoint. 0 - infinity. | -
130+
|`spring.ai.vectorstore.opensearch.connect-timeout`| Time to wait until connection established. 0 - infinity. | -
131+
|`spring.ai.vectorstore.opensearch.ssl-bundle`| Name of the SSL Bundle to use in case of SSL connection | -
126132
|`spring.ai.vectorstore.opensearch.aws.host`| Hostname of the OpenSearch instance | -
127133
|`spring.ai.vectorstore.opensearch.aws.service-name`| AWS service name | -
128134
|`spring.ai.vectorstore.opensearch.aws.access-key`| AWS access key | -

0 commit comments

Comments
 (0)