Skip to content

Commit 100062a

Browse files
author
awstools
committed
feat(client-bedrock-agent): Adding support for Amazon OpenSearch Managed clusters as a vector database in Knowledge Bases for Amazon Bedrock
1 parent 254cb39 commit 100062a

File tree

7 files changed

+255
-9
lines changed

7 files changed

+255
-9
lines changed

‎clients/client-bedrock-agent/src/commands/CreateKnowledgeBaseCommand.ts‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ export interface CreateKnowledgeBaseCommandOutput extends CreateKnowledgeBaseRes
163163
* },
164164
* },
165165
* storageConfiguration: { // StorageConfiguration
166-
* type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS", // required
166+
* type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER", // required
167167
* opensearchServerlessConfiguration: { // OpenSearchServerlessConfiguration
168168
* collectionArn: "STRING_VALUE", // required
169169
* vectorIndexName: "STRING_VALUE", // required
@@ -173,6 +173,16 @@ export interface CreateKnowledgeBaseCommandOutput extends CreateKnowledgeBaseRes
173173
* metadataField: "STRING_VALUE", // required
174174
* },
175175
* },
176+
* opensearchManagedClusterConfiguration: { // OpenSearchManagedClusterConfiguration
177+
* domainEndpoint: "STRING_VALUE", // required
178+
* domainArn: "STRING_VALUE", // required
179+
* vectorIndexName: "STRING_VALUE", // required
180+
* fieldMapping: { // OpenSearchManagedClusterFieldMapping
181+
* vectorField: "STRING_VALUE", // required
182+
* textField: "STRING_VALUE", // required
183+
* metadataField: "STRING_VALUE", // required
184+
* },
185+
* },
176186
* pineconeConfiguration: { // PineconeConfiguration
177187
* connectionString: "STRING_VALUE", // required
178188
* credentialsSecretArn: "STRING_VALUE", // required
@@ -325,7 +335,7 @@ export interface CreateKnowledgeBaseCommandOutput extends CreateKnowledgeBaseRes
325335
* // },
326336
* // },
327337
* // storageConfiguration: { // StorageConfiguration
328-
* // type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS", // required
338+
* // type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER", // required
329339
* // opensearchServerlessConfiguration: { // OpenSearchServerlessConfiguration
330340
* // collectionArn: "STRING_VALUE", // required
331341
* // vectorIndexName: "STRING_VALUE", // required
@@ -335,6 +345,16 @@ export interface CreateKnowledgeBaseCommandOutput extends CreateKnowledgeBaseRes
335345
* // metadataField: "STRING_VALUE", // required
336346
* // },
337347
* // },
348+
* // opensearchManagedClusterConfiguration: { // OpenSearchManagedClusterConfiguration
349+
* // domainEndpoint: "STRING_VALUE", // required
350+
* // domainArn: "STRING_VALUE", // required
351+
* // vectorIndexName: "STRING_VALUE", // required
352+
* // fieldMapping: { // OpenSearchManagedClusterFieldMapping
353+
* // vectorField: "STRING_VALUE", // required
354+
* // textField: "STRING_VALUE", // required
355+
* // metadataField: "STRING_VALUE", // required
356+
* // },
357+
* // },
338358
* // pineconeConfiguration: { // PineconeConfiguration
339359
* // connectionString: "STRING_VALUE", // required
340360
* // credentialsSecretArn: "STRING_VALUE", // required

‎clients/client-bedrock-agent/src/commands/GetKnowledgeBaseCommand.ts‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ export interface GetKnowledgeBaseCommandOutput extends GetKnowledgeBaseResponse,
138138
* // },
139139
* // },
140140
* // storageConfiguration: { // StorageConfiguration
141-
* // type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS", // required
141+
* // type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER", // required
142142
* // opensearchServerlessConfiguration: { // OpenSearchServerlessConfiguration
143143
* // collectionArn: "STRING_VALUE", // required
144144
* // vectorIndexName: "STRING_VALUE", // required
@@ -148,6 +148,16 @@ export interface GetKnowledgeBaseCommandOutput extends GetKnowledgeBaseResponse,
148148
* // metadataField: "STRING_VALUE", // required
149149
* // },
150150
* // },
151+
* // opensearchManagedClusterConfiguration: { // OpenSearchManagedClusterConfiguration
152+
* // domainEndpoint: "STRING_VALUE", // required
153+
* // domainArn: "STRING_VALUE", // required
154+
* // vectorIndexName: "STRING_VALUE", // required
155+
* // fieldMapping: { // OpenSearchManagedClusterFieldMapping
156+
* // vectorField: "STRING_VALUE", // required
157+
* // textField: "STRING_VALUE", // required
158+
* // metadataField: "STRING_VALUE", // required
159+
* // },
160+
* // },
151161
* // pineconeConfiguration: { // PineconeConfiguration
152162
* // connectionString: "STRING_VALUE", // required
153163
* // credentialsSecretArn: "STRING_VALUE", // required

‎clients/client-bedrock-agent/src/commands/UpdateKnowledgeBaseCommand.ts‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ export interface UpdateKnowledgeBaseCommandOutput extends UpdateKnowledgeBaseRes
151151
* },
152152
* },
153153
* storageConfiguration: { // StorageConfiguration
154-
* type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS", // required
154+
* type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER", // required
155155
* opensearchServerlessConfiguration: { // OpenSearchServerlessConfiguration
156156
* collectionArn: "STRING_VALUE", // required
157157
* vectorIndexName: "STRING_VALUE", // required
@@ -161,6 +161,16 @@ export interface UpdateKnowledgeBaseCommandOutput extends UpdateKnowledgeBaseRes
161161
* metadataField: "STRING_VALUE", // required
162162
* },
163163
* },
164+
* opensearchManagedClusterConfiguration: { // OpenSearchManagedClusterConfiguration
165+
* domainEndpoint: "STRING_VALUE", // required
166+
* domainArn: "STRING_VALUE", // required
167+
* vectorIndexName: "STRING_VALUE", // required
168+
* fieldMapping: { // OpenSearchManagedClusterFieldMapping
169+
* vectorField: "STRING_VALUE", // required
170+
* textField: "STRING_VALUE", // required
171+
* metadataField: "STRING_VALUE", // required
172+
* },
173+
* },
164174
* pineconeConfiguration: { // PineconeConfiguration
165175
* connectionString: "STRING_VALUE", // required
166176
* credentialsSecretArn: "STRING_VALUE", // required
@@ -310,7 +320,7 @@ export interface UpdateKnowledgeBaseCommandOutput extends UpdateKnowledgeBaseRes
310320
* // },
311321
* // },
312322
* // storageConfiguration: { // StorageConfiguration
313-
* // type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS", // required
323+
* // type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER", // required
314324
* // opensearchServerlessConfiguration: { // OpenSearchServerlessConfiguration
315325
* // collectionArn: "STRING_VALUE", // required
316326
* // vectorIndexName: "STRING_VALUE", // required
@@ -320,6 +330,16 @@ export interface UpdateKnowledgeBaseCommandOutput extends UpdateKnowledgeBaseRes
320330
* // metadataField: "STRING_VALUE", // required
321331
* // },
322332
* // },
333+
* // opensearchManagedClusterConfiguration: { // OpenSearchManagedClusterConfiguration
334+
* // domainEndpoint: "STRING_VALUE", // required
335+
* // domainArn: "STRING_VALUE", // required
336+
* // vectorIndexName: "STRING_VALUE", // required
337+
* // fieldMapping: { // OpenSearchManagedClusterFieldMapping
338+
* // vectorField: "STRING_VALUE", // required
339+
* // textField: "STRING_VALUE", // required
340+
* // metadataField: "STRING_VALUE", // required
341+
* // },
342+
* // },
323343
* // pineconeConfiguration: { // PineconeConfiguration
324344
* // connectionString: "STRING_VALUE", // required
325345
* // credentialsSecretArn: "STRING_VALUE", // required

‎clients/client-bedrock-agent/src/models/models_0.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -996,7 +996,7 @@ export interface UpdateAgentActionGroupRequest {
996996
* <p>The configuration settings for a computer use action.</p>
997997
* <important>
998998
* <p>
999-
* Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 and Claude 3.5 Sonnet v2 only. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.
999+
* Computer use is a new Anthropic Claude model capability (in beta) available with Claude 3.7 Sonnet and Claude 3.5 Sonnet v2 only. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html">Configure an Amazon Bedrock Agent to complete tasks with computer use tools</a>.
10001000
* </p>
10011001
* </important>
10021002
* @public
@@ -3893,7 +3893,7 @@ export interface BedrockFoundationModelContextEnrichmentConfiguration {
38933893
enrichmentStrategyConfiguration: EnrichmentStrategyConfiguration | undefined;
38943894

38953895
/**
3896-
* <p>The Amazon Resource Name (ARN) of the foundation model used for context enrichment.</p>
3896+
* <p>The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.</p>
38973897
* @public
38983898
*/
38993899
modelArn: string | undefined;

‎clients/client-bedrock-agent/src/models/models_1.ts‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1396,6 +1396,62 @@ export interface NeptuneAnalyticsConfiguration {
13961396
fieldMapping: NeptuneAnalyticsFieldMapping | undefined;
13971397
}
13981398

1399+
/**
1400+
* <p>Contains the names of the fields to which to map information about the vector store.</p>
1401+
* @public
1402+
*/
1403+
export interface OpenSearchManagedClusterFieldMapping {
1404+
/**
1405+
* <p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>
1406+
* @public
1407+
*/
1408+
vectorField: string | undefined;
1409+
1410+
/**
1411+
* <p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text
1412+
* is split according to the chunking strategy you choose.</p>
1413+
* @public
1414+
*/
1415+
textField: string | undefined;
1416+
1417+
/**
1418+
* <p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>
1419+
* @public
1420+
*/
1421+
metadataField: string | undefined;
1422+
}
1423+
1424+
/**
1425+
* <p>Contains details about the Managed Cluster configuration of the knowledge base in Amazon OpenSearch Service. For more information,
1426+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html">Create a vector index in OpenSearch Managed Cluster</a>.</p>
1427+
* @public
1428+
*/
1429+
export interface OpenSearchManagedClusterConfiguration {
1430+
/**
1431+
* <p>The endpoint URL the OpenSearch domain.</p>
1432+
* @public
1433+
*/
1434+
domainEndpoint: string | undefined;
1435+
1436+
/**
1437+
* <p>The Amazon Resource Name (ARN) of the OpenSearch domain.</p>
1438+
* @public
1439+
*/
1440+
domainArn: string | undefined;
1441+
1442+
/**
1443+
* <p>The name of the vector store.</p>
1444+
* @public
1445+
*/
1446+
vectorIndexName: string | undefined;
1447+
1448+
/**
1449+
* <p>Contains the names of the fields to which to map information about the vector store.</p>
1450+
* @public
1451+
*/
1452+
fieldMapping: OpenSearchManagedClusterFieldMapping | undefined;
1453+
}
1454+
13991455
/**
14001456
* <p>Contains the names of the fields to which to map information about the vector store.</p>
14011457
* @public
@@ -1619,6 +1675,7 @@ export interface RedisEnterpriseCloudConfiguration {
16191675
export const KnowledgeBaseStorageType = {
16201676
MONGO_DB_ATLAS: "MONGO_DB_ATLAS",
16211677
NEPTUNE_ANALYTICS: "NEPTUNE_ANALYTICS",
1678+
OPENSEARCH_MANAGED_CLUSTER: "OPENSEARCH_MANAGED_CLUSTER",
16221679
OPENSEARCH_SERVERLESS: "OPENSEARCH_SERVERLESS",
16231680
PINECONE: "PINECONE",
16241681
RDS: "RDS",
@@ -1647,6 +1704,14 @@ export interface StorageConfiguration {
16471704
*/
16481705
opensearchServerlessConfiguration?: OpenSearchServerlessConfiguration | undefined;
16491706

1707+
/**
1708+
* <p>Contains details about the storage configuration of the knowledge base in OpenSearch Managed
1709+
* Cluster. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html">Create
1710+
* a vector index in Amazon OpenSearch Service</a>.</p>
1711+
* @public
1712+
*/
1713+
opensearchManagedClusterConfiguration?: OpenSearchManagedClusterConfiguration | undefined;
1714+
16501715
/**
16511716
* <p>Contains the storage configuration of the knowledge base in Pinecone.</p>
16521717
* @public
@@ -3164,11 +3229,26 @@ export const NeptuneAnalyticsConfigurationFilterSensitiveLog = (obj: NeptuneAnal
31643229
...(obj.graphArn && { graphArn: SENSITIVE_STRING }),
31653230
});
31663231

3232+
/**
3233+
* @internal
3234+
*/
3235+
export const OpenSearchManagedClusterConfigurationFilterSensitiveLog = (
3236+
obj: OpenSearchManagedClusterConfiguration
3237+
): any => ({
3238+
...obj,
3239+
...(obj.vectorIndexName && { vectorIndexName: SENSITIVE_STRING }),
3240+
});
3241+
31673242
/**
31683243
* @internal
31693244
*/
31703245
export const StorageConfigurationFilterSensitiveLog = (obj: StorageConfiguration): any => ({
31713246
...obj,
3247+
...(obj.opensearchManagedClusterConfiguration && {
3248+
opensearchManagedClusterConfiguration: OpenSearchManagedClusterConfigurationFilterSensitiveLog(
3249+
obj.opensearchManagedClusterConfiguration
3250+
),
3251+
}),
31723252
...(obj.neptuneAnalyticsConfiguration && {
31733253
neptuneAnalyticsConfiguration: NeptuneAnalyticsConfigurationFilterSensitiveLog(obj.neptuneAnalyticsConfiguration),
31743254
}),

‎clients/client-bedrock-agent/src/protocols/Aws_restJson1.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,8 @@ import {
340340
MongoDbAtlasFieldMapping,
341341
NeptuneAnalyticsConfiguration,
342342
NeptuneAnalyticsFieldMapping,
343+
OpenSearchManagedClusterConfiguration,
344+
OpenSearchManagedClusterFieldMapping,
343345
OpenSearchServerlessConfiguration,
344346
OpenSearchServerlessFieldMapping,
345347
PineconeConfiguration,
@@ -4141,6 +4143,10 @@ const se_MetadataAttributeValue = (input: MetadataAttributeValue, context: __Ser
41414143

41424144
// se_NeptuneAnalyticsFieldMapping omitted.
41434145

4146+
// se_OpenSearchManagedClusterConfiguration omitted.
4147+
4148+
// se_OpenSearchManagedClusterFieldMapping omitted.
4149+
41444150
// se_OpenSearchServerlessConfiguration omitted.
41454151

41464152
// se_OpenSearchServerlessFieldMapping omitted.
@@ -5387,6 +5393,10 @@ const de_KnowledgeBaseSummary = (output: any, context: __SerdeContext): Knowledg
53875393

53885394
// de_NeptuneAnalyticsFieldMapping omitted.
53895395

5396+
// de_OpenSearchManagedClusterConfiguration omitted.
5397+
5398+
// de_OpenSearchManagedClusterFieldMapping omitted.
5399+
53905400
// de_OpenSearchServerlessConfiguration omitted.
53915401

53925402
// de_OpenSearchServerlessFieldMapping omitted.

0 commit comments

Comments
 (0)