Skip to content

Commit e9b70f4

Browse files
apappascstzolov
authored andcommitted
Updated OpenSearch documentation to reflect correct configuration properties
1 parent 3f85f79 commit e9b70f4

File tree

1 file changed

+21
-14
lines changed
  • spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs

1 file changed

+21
-14
lines changed

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

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -40,20 +40,27 @@ TIP: Refer to the xref:getting-started.adoc#dependency-management[Dependency Man
4040

4141
To connect to OpenSearch and use the `OpenSearchVectorStore`, you need to provide access details for your instance.
4242
A simple configuration can either be provided via Spring Boot's `application.yml`,
43+
4344
[source,yaml]
4445
----
4546
spring:
46-
opensearch:
47-
uris: <opensearch instance URIs>
48-
username: <opensearch username>
49-
password: <opensearch password>
50-
indexName: <opensearch index name>
51-
mappingJson: <JSON mapping for opensearch index>
52-
# API key if needed, e.g. OpenAI
5347
ai:
48+
vectorstore:
49+
opensearch:
50+
uris: <opensearch instance URIs>
51+
username: <opensearch username>
52+
password: <opensearch password>
53+
indexName: <opensearch index name>
54+
mappingJson: <JSON mapping for opensearch index>
55+
aws:
56+
host: <aws opensearch host>
57+
serviceName: <aws service name>
58+
accessKey: <aws access key>
59+
secretKey: <aws secret key>
60+
region: <aws region>
61+
# API key if needed, e.g. OpenAI
5462
openai:
55-
api:
56-
key: <api-key>
63+
apiKey: <api-key>
5764
----
5865
TIP: Check the list of xref:#_configuration_properties[configuration parameters] to learn about the default values and configuration options.
5966

@@ -134,11 +141,11 @@ fields are stored and indexed. |
134141
}
135142
}
136143
}
137-
|`spring.opensearch.aws.host`| Hostname of the OpenSearch instance. | -
138-
|`spring.opensearch.aws.service-name`| AWS service name for the OpenSearch instance. | -
139-
|`spring.opensearch.aws.access-key`| AWS access key for the OpenSearch instance. | -
140-
|`spring.opensearch.aws.secret-key`| AWS secret key for the OpenSearch instance. | -
141-
|`spring.opensearch.aws.region`| AWS region for the OpenSearch instance. | -
144+
|`spring.ai.vectorstore.opensearch.aws.host`| Hostname of the OpenSearch instance. | -
145+
|`spring.ai.vectorstore.opensearch.aws.serviceName`| AWS service name for the OpenSearch instance. | -
146+
|`spring.ai.vectorstore.opensearch.aws.accessKey`| AWS access key for the OpenSearch instance. | -
147+
|`spring.ai.vectorstore.opensearch.aws.secretKey`| AWS secret key for the OpenSearch instance. | -
148+
|`spring.ai.vectorstore.opensearch.aws.region`| AWS region for the OpenSearch instance. | -
142149
|===
143150

144151
=== Customizing OpenSearch Client Configuration

0 commit comments

Comments
 (0)