From 77be609c4a6e9c97fd13b05fb5d8fc6d05c32584 Mon Sep 17 00:00:00 2001
From: Linar Abzaltdinov <abzaltdinov@gmail.com>
Date: Tue, 13 May 2025 19:37:53 +0300
Subject: [PATCH] updated docs for new OpenSearch vector-store properties
 (#3140)

Signed-off-by: Linar Abzaltdinov <abzaltdinov@gmail.com>
---
 .../autoconfigure/OpenSearchVectorStoreProperties.java      | 5 ++++-
 .../antora/modules/ROOT/pages/api/vectordbs/opensearch.adoc | 6 ++++++
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/auto-configurations/vector-stores/spring-ai-autoconfigure-vector-store-opensearch/src/main/java/org/springframework/ai/vectorstore/opensearch/autoconfigure/OpenSearchVectorStoreProperties.java b/auto-configurations/vector-stores/spring-ai-autoconfigure-vector-store-opensearch/src/main/java/org/springframework/ai/vectorstore/opensearch/autoconfigure/OpenSearchVectorStoreProperties.java
index 20147382d..71a57f063 100644
--- a/auto-configurations/vector-stores/spring-ai-autoconfigure-vector-store-opensearch/src/main/java/org/springframework/ai/vectorstore/opensearch/autoconfigure/OpenSearchVectorStoreProperties.java
+++ b/auto-configurations/vector-stores/spring-ai-autoconfigure-vector-store-opensearch/src/main/java/org/springframework/ai/vectorstore/opensearch/autoconfigure/OpenSearchVectorStoreProperties.java
@@ -46,10 +46,13 @@ public class OpenSearchVectorStoreProperties extends CommonVectorStoreProperties
 	private String sslBundle;
 
 	/**
-	 *
+	 * Time to wait until connection established. 0 - infinity.
 	 */
 	private Duration connectionTimeout;
 
+	/**
+	 * Time to wait for response from the opposite endpoint. 0 - infinity.
+	 */
 	private Duration readTimeout;
 
 	private Aws aws = new Aws();
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 ceff602a9..21f2bf4f1 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
@@ -103,6 +103,9 @@ spring:
         index-name: spring-ai-document-index
         initialize-schema: true
         similarity-function: cosinesimil
+        read-timeout: <time to wait for response>
+        connect-timeout: <time to wait until connection established>
+        ssl-bundle: <name of SSL bundle>
         aws:  # Only for Amazon OpenSearch Service
           host: <aws opensearch host>
           service-name: <aws service name>
@@ -123,6 +126,9 @@ Properties starting with `spring.ai.vectorstore.opensearch.*` are used to config
 |`spring.ai.vectorstore.opensearch.index-name`| Name of the index to store vectors | `spring-ai-document-index`
 |`spring.ai.vectorstore.opensearch.initialize-schema`| Whether to initialize the required schema | `false`
 |`spring.ai.vectorstore.opensearch.similarity-function`| The similarity function to use | `cosinesimil`
+|`spring.ai.vectorstore.opensearch.read-timeout`| Time to wait for response from the opposite endpoint. 0 - infinity. | -
+|`spring.ai.vectorstore.opensearch.connect-timeout`| Time to wait until connection established. 0 - infinity. | -
+|`spring.ai.vectorstore.opensearch.ssl-bundle`| Name of the SSL Bundle to use in case of SSL connection | -
 |`spring.ai.vectorstore.opensearch.aws.host`| Hostname of the OpenSearch instance | -
 |`spring.ai.vectorstore.opensearch.aws.service-name`| AWS service name | -
 |`spring.ai.vectorstore.opensearch.aws.access-key`| AWS access key | -