@aws-sdk/client-bedrock-agent 3.844.0 → 3.846.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +13 -1
- package/dist-es/models/models_1.js +10 -0
- package/dist-types/commands/CreateAgentActionGroupCommand.d.ts +1 -6
- package/dist-types/commands/CreateAgentCommand.d.ts +1 -32
- package/dist-types/commands/CreateDataSourceCommand.d.ts +1 -4
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +13 -34
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +6 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -4
- package/dist-types/commands/UpdateKnowledgeBaseCommand.d.ts +13 -22
- package/dist-types/models/models_0.d.ts +105 -660
- package/dist-types/models/models_1.d.ts +58 -231
- package/dist-types/ts3.4/models/models_1.d.ts +10 -0
- package/package.json +11 -11
package/dist-cjs/index.js
CHANGED
|
@@ -245,6 +245,7 @@ __export(index_exports, {
|
|
|
245
245
|
ResourceNotFoundException: () => ResourceNotFoundException,
|
|
246
246
|
RetrievalFlowNodeServiceConfiguration: () => RetrievalFlowNodeServiceConfiguration,
|
|
247
247
|
S3DataSourceConfigurationFilterSensitiveLog: () => S3DataSourceConfigurationFilterSensitiveLog,
|
|
248
|
+
S3VectorsConfigurationFilterSensitiveLog: () => S3VectorsConfigurationFilterSensitiveLog,
|
|
248
249
|
SalesforceAuthType: () => SalesforceAuthType,
|
|
249
250
|
SalesforceCrawlerConfigurationFilterSensitiveLog: () => SalesforceCrawlerConfigurationFilterSensitiveLog,
|
|
250
251
|
SalesforceDataSourceConfigurationFilterSensitiveLog: () => SalesforceDataSourceConfigurationFilterSensitiveLog,
|
|
@@ -1601,7 +1602,8 @@ var KnowledgeBaseStorageType = {
|
|
|
1601
1602
|
OPENSEARCH_SERVERLESS: "OPENSEARCH_SERVERLESS",
|
|
1602
1603
|
PINECONE: "PINECONE",
|
|
1603
1604
|
RDS: "RDS",
|
|
1604
|
-
REDIS_ENTERPRISE_CLOUD: "REDIS_ENTERPRISE_CLOUD"
|
|
1605
|
+
REDIS_ENTERPRISE_CLOUD: "REDIS_ENTERPRISE_CLOUD",
|
|
1606
|
+
S3_VECTORS: "S3_VECTORS"
|
|
1605
1607
|
};
|
|
1606
1608
|
var KnowledgeBaseStatus = {
|
|
1607
1609
|
ACTIVE: "ACTIVE",
|
|
@@ -1720,6 +1722,12 @@ var OpenSearchManagedClusterConfigurationFilterSensitiveLog = /* @__PURE__ */ __
|
|
|
1720
1722
|
...obj,
|
|
1721
1723
|
...obj.vectorIndexName && { vectorIndexName: import_smithy_client.SENSITIVE_STRING }
|
|
1722
1724
|
}), "OpenSearchManagedClusterConfigurationFilterSensitiveLog");
|
|
1725
|
+
var S3VectorsConfigurationFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
|
|
1726
|
+
...obj,
|
|
1727
|
+
...obj.vectorBucketArn && { vectorBucketArn: import_smithy_client.SENSITIVE_STRING },
|
|
1728
|
+
...obj.indexArn && { indexArn: import_smithy_client.SENSITIVE_STRING },
|
|
1729
|
+
...obj.indexName && { indexName: import_smithy_client.SENSITIVE_STRING }
|
|
1730
|
+
}), "S3VectorsConfigurationFilterSensitiveLog");
|
|
1723
1731
|
var StorageConfigurationFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
|
|
1724
1732
|
...obj,
|
|
1725
1733
|
...obj.opensearchManagedClusterConfiguration && {
|
|
@@ -1729,6 +1737,9 @@ var StorageConfigurationFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
|
|
|
1729
1737
|
},
|
|
1730
1738
|
...obj.neptuneAnalyticsConfiguration && {
|
|
1731
1739
|
neptuneAnalyticsConfiguration: NeptuneAnalyticsConfigurationFilterSensitiveLog(obj.neptuneAnalyticsConfiguration)
|
|
1740
|
+
},
|
|
1741
|
+
...obj.s3VectorsConfiguration && {
|
|
1742
|
+
s3VectorsConfiguration: S3VectorsConfigurationFilterSensitiveLog(obj.s3VectorsConfiguration)
|
|
1732
1743
|
}
|
|
1733
1744
|
}), "StorageConfigurationFilterSensitiveLog");
|
|
1734
1745
|
var CreateKnowledgeBaseRequestFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
|
|
@@ -6789,6 +6800,7 @@ var paginateListPrompts = (0, import_core.createPaginator)(BedrockAgentClient, L
|
|
|
6789
6800
|
KnowledgeBaseConfigurationFilterSensitiveLog,
|
|
6790
6801
|
NeptuneAnalyticsConfigurationFilterSensitiveLog,
|
|
6791
6802
|
OpenSearchManagedClusterConfigurationFilterSensitiveLog,
|
|
6803
|
+
S3VectorsConfigurationFilterSensitiveLog,
|
|
6792
6804
|
StorageConfigurationFilterSensitiveLog,
|
|
6793
6805
|
CreateKnowledgeBaseRequestFilterSensitiveLog,
|
|
6794
6806
|
KnowledgeBaseFilterSensitiveLog,
|
|
@@ -102,6 +102,7 @@ export const KnowledgeBaseStorageType = {
|
|
|
102
102
|
PINECONE: "PINECONE",
|
|
103
103
|
RDS: "RDS",
|
|
104
104
|
REDIS_ENTERPRISE_CLOUD: "REDIS_ENTERPRISE_CLOUD",
|
|
105
|
+
S3_VECTORS: "S3_VECTORS",
|
|
105
106
|
};
|
|
106
107
|
export const KnowledgeBaseStatus = {
|
|
107
108
|
ACTIVE: "ACTIVE",
|
|
@@ -237,6 +238,12 @@ export const OpenSearchManagedClusterConfigurationFilterSensitiveLog = (obj) =>
|
|
|
237
238
|
...obj,
|
|
238
239
|
...(obj.vectorIndexName && { vectorIndexName: SENSITIVE_STRING }),
|
|
239
240
|
});
|
|
241
|
+
export const S3VectorsConfigurationFilterSensitiveLog = (obj) => ({
|
|
242
|
+
...obj,
|
|
243
|
+
...(obj.vectorBucketArn && { vectorBucketArn: SENSITIVE_STRING }),
|
|
244
|
+
...(obj.indexArn && { indexArn: SENSITIVE_STRING }),
|
|
245
|
+
...(obj.indexName && { indexName: SENSITIVE_STRING }),
|
|
246
|
+
});
|
|
240
247
|
export const StorageConfigurationFilterSensitiveLog = (obj) => ({
|
|
241
248
|
...obj,
|
|
242
249
|
...(obj.opensearchManagedClusterConfiguration && {
|
|
@@ -245,6 +252,9 @@ export const StorageConfigurationFilterSensitiveLog = (obj) => ({
|
|
|
245
252
|
...(obj.neptuneAnalyticsConfiguration && {
|
|
246
253
|
neptuneAnalyticsConfiguration: NeptuneAnalyticsConfigurationFilterSensitiveLog(obj.neptuneAnalyticsConfiguration),
|
|
247
254
|
}),
|
|
255
|
+
...(obj.s3VectorsConfiguration && {
|
|
256
|
+
s3VectorsConfiguration: S3VectorsConfigurationFilterSensitiveLog(obj.s3VectorsConfiguration),
|
|
257
|
+
}),
|
|
248
258
|
});
|
|
249
259
|
export const CreateKnowledgeBaseRequestFilterSensitiveLog = (obj) => ({
|
|
250
260
|
...obj,
|
|
@@ -27,12 +27,7 @@ declare const CreateAgentActionGroupCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.</p>
|
|
31
|
-
* <p>To allow your agent to request the user for additional information when trying to complete a task,
|
|
32
|
-
* add an action group with the <code>parentActionGroupSignature</code> field set to <code>AMAZON.UserInput</code>. </p>
|
|
33
|
-
* <p>To allow your agent to generate, run, and troubleshoot code when trying to complete a task,
|
|
34
|
-
* add an action group with the <code>parentActionGroupSignature</code> field set to <code>AMAZON.CodeInterpreter</code>. </p>
|
|
35
|
-
* <p>You must leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html">Observation</a> reprompting the user for more information.</p>
|
|
30
|
+
* <p>Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.</p> <p>To allow your agent to request the user for additional information when trying to complete a task, add an action group with the <code>parentActionGroupSignature</code> field set to <code>AMAZON.UserInput</code>. </p> <p>To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the <code>parentActionGroupSignature</code> field set to <code>AMAZON.CodeInterpreter</code>. </p> <p>You must leave the <code>description</code>, <code>apiSchema</code>, and <code>actionGroupExecutor</code> fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html">Observation</a> reprompting the user for more information.</p>
|
|
36
31
|
* @example
|
|
37
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
33
|
* ```javascript
|
|
@@ -27,38 +27,7 @@ declare const CreateAgentCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.</p>
|
|
31
|
-
* <ul>
|
|
32
|
-
* <li>
|
|
33
|
-
* <p>Specify the following fields for security purposes.</p>
|
|
34
|
-
* <ul>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>
|
|
37
|
-
* <code>agentResourceRoleArn</code> – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.</p>
|
|
38
|
-
* </li>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>(Optional) <code>customerEncryptionKeyArn</code> – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.</p>
|
|
41
|
-
* </li>
|
|
42
|
-
* <li>
|
|
43
|
-
* <p>(Optional) <code>idleSessionTTLinSeconds</code> – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent <code>InvokeAgent</code> request begins a new session.</p>
|
|
44
|
-
* </li>
|
|
45
|
-
* </ul>
|
|
46
|
-
* </li>
|
|
47
|
-
* <li>
|
|
48
|
-
* <p>To enable your agent to retain conversational context across multiple sessions, include a <code>memoryConfiguration</code> object.
|
|
49
|
-
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-configure-memory.html">Configure memory</a>.</p>
|
|
50
|
-
* </li>
|
|
51
|
-
* <li>
|
|
52
|
-
* <p>To override the default prompt behavior for agent orchestration and to use advanced prompts, include a <code>promptOverrideConfiguration</code> object.
|
|
53
|
-
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p>
|
|
54
|
-
* </li>
|
|
55
|
-
* <li>
|
|
56
|
-
* <p>If your agent fails to be created, the response returns a list of <code>failureReasons</code> alongside a list of <code>recommendedActions</code> for you to troubleshoot.</p>
|
|
57
|
-
* </li>
|
|
58
|
-
* <li>
|
|
59
|
-
* <p>The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.</p>
|
|
60
|
-
* </li>
|
|
61
|
-
* </ul>
|
|
30
|
+
* <p>Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.</p> <ul> <li> <p>Specify the following fields for security purposes.</p> <ul> <li> <p> <code>agentResourceRoleArn</code> – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.</p> </li> <li> <p>(Optional) <code>customerEncryptionKeyArn</code> – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.</p> </li> <li> <p>(Optional) <code>idleSessionTTLinSeconds</code> – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent <code>InvokeAgent</code> request begins a new session.</p> </li> </ul> </li> <li> <p>To enable your agent to retain conversational context across multiple sessions, include a <code>memoryConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-configure-memory.html">Configure memory</a>.</p> </li> <li> <p>To override the default prompt behavior for agent orchestration and to use advanced prompts, include a <code>promptOverrideConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html">Advanced prompts</a>.</p> </li> <li> <p>If your agent fails to be created, the response returns a list of <code>failureReasons</code> alongside a list of <code>recommendedActions</code> for you to troubleshoot.</p> </li> <li> <p>The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.</p> </li> </ul>
|
|
62
31
|
* @example
|
|
63
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
64
33
|
* ```javascript
|
|
@@ -27,10 +27,7 @@ declare const CreateDataSourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the <code>dataSourceConfiguration</code> field.</p>
|
|
31
|
-
* <important>
|
|
32
|
-
* <p>You can't change the <code>chunkingConfiguration</code> after you create the data source connector.</p>
|
|
33
|
-
* </important>
|
|
30
|
+
* <p>Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the <code>dataSourceConfiguration</code> field.</p> <important> <p>You can't change the <code>chunkingConfiguration</code> after you create the data source connector.</p> </important>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -27,38 +27,7 @@ declare const CreateKnowledgeBaseCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowlege-base-prereq.html">Set up a knowledge base</a>.</p>
|
|
31
|
-
* <note>
|
|
32
|
-
* <p>If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-create">Create a knowledge base</a>.</p>
|
|
33
|
-
* </note>
|
|
34
|
-
* <ul>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>Provide the <code>name</code> and an optional <code>description</code>.</p>
|
|
37
|
-
* </li>
|
|
38
|
-
* <li>
|
|
39
|
-
* <p>Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the <code>roleArn</code> field.</p>
|
|
40
|
-
* </li>
|
|
41
|
-
* <li>
|
|
42
|
-
* <p>Provide the embedding model to use in the <code>embeddingModelArn</code> field in the <code>knowledgeBaseConfiguration</code> object.</p>
|
|
43
|
-
* </li>
|
|
44
|
-
* <li>
|
|
45
|
-
* <p>Provide the configuration for your vector store in the <code>storageConfiguration</code> object.</p>
|
|
46
|
-
* <ul>
|
|
47
|
-
* <li>
|
|
48
|
-
* <p>For an Amazon OpenSearch Service database, use the <code>opensearchServerlessConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html">Create a vector store in Amazon OpenSearch Service</a>.</p>
|
|
49
|
-
* </li>
|
|
50
|
-
* <li>
|
|
51
|
-
* <p>For an Amazon Aurora database, use the <code>RdsConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html">Create a vector store in Amazon Aurora</a>.</p>
|
|
52
|
-
* </li>
|
|
53
|
-
* <li>
|
|
54
|
-
* <p>For a Pinecone database, use the <code>pineconeConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html">Create a vector store in Pinecone</a>.</p>
|
|
55
|
-
* </li>
|
|
56
|
-
* <li>
|
|
57
|
-
* <p>For a Redis Enterprise Cloud database, use the <code>redisEnterpriseCloudConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-redis.html">Create a vector store in Redis Enterprise Cloud</a>.</p>
|
|
58
|
-
* </li>
|
|
59
|
-
* </ul>
|
|
60
|
-
* </li>
|
|
61
|
-
* </ul>
|
|
30
|
+
* <p>Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowlege-base-prereq.html">Set up a knowledge base</a>.</p> <note> <p>If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-create">Create a knowledge base</a>.</p> </note> <ul> <li> <p>Provide the <code>name</code> and an optional <code>description</code>.</p> </li> <li> <p>Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the <code>roleArn</code> field.</p> </li> <li> <p>Provide the embedding model to use in the <code>embeddingModelArn</code> field in the <code>knowledgeBaseConfiguration</code> object.</p> </li> <li> <p>Provide the configuration for your vector store in the <code>storageConfiguration</code> object.</p> <ul> <li> <p>For an Amazon OpenSearch Service database, use the <code>opensearchServerlessConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html">Create a vector store in Amazon OpenSearch Service</a>.</p> </li> <li> <p>For an Amazon Aurora database, use the <code>RdsConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html">Create a vector store in Amazon Aurora</a>.</p> </li> <li> <p>For a Pinecone database, use the <code>pineconeConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html">Create a vector store in Pinecone</a>.</p> </li> <li> <p>For a Redis Enterprise Cloud database, use the <code>redisEnterpriseCloudConfiguration</code> object. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-redis.html">Create a vector store in Redis Enterprise Cloud</a>.</p> </li> </ul> </li> </ul>
|
|
62
31
|
* @example
|
|
63
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
64
33
|
* ```javascript
|
|
@@ -157,7 +126,7 @@ declare const CreateKnowledgeBaseCommand_base: {
|
|
|
157
126
|
* },
|
|
158
127
|
* },
|
|
159
128
|
* storageConfiguration: { // StorageConfiguration
|
|
160
|
-
* type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER", // required
|
|
129
|
+
* type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER" || "S3_VECTORS", // required
|
|
161
130
|
* opensearchServerlessConfiguration: { // OpenSearchServerlessConfiguration
|
|
162
131
|
* collectionArn: "STRING_VALUE", // required
|
|
163
132
|
* vectorIndexName: "STRING_VALUE", // required
|
|
@@ -230,6 +199,11 @@ declare const CreateKnowledgeBaseCommand_base: {
|
|
|
230
199
|
* metadataField: "STRING_VALUE", // required
|
|
231
200
|
* },
|
|
232
201
|
* },
|
|
202
|
+
* s3VectorsConfiguration: { // S3VectorsConfiguration
|
|
203
|
+
* vectorBucketArn: "STRING_VALUE",
|
|
204
|
+
* indexArn: "STRING_VALUE",
|
|
205
|
+
* indexName: "STRING_VALUE",
|
|
206
|
+
* },
|
|
233
207
|
* },
|
|
234
208
|
* tags: { // TagsMap
|
|
235
209
|
* "<keys>": "STRING_VALUE",
|
|
@@ -331,7 +305,7 @@ declare const CreateKnowledgeBaseCommand_base: {
|
|
|
331
305
|
* // },
|
|
332
306
|
* // },
|
|
333
307
|
* // storageConfiguration: { // StorageConfiguration
|
|
334
|
-
* // type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER", // required
|
|
308
|
+
* // type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER" || "S3_VECTORS", // required
|
|
335
309
|
* // opensearchServerlessConfiguration: { // OpenSearchServerlessConfiguration
|
|
336
310
|
* // collectionArn: "STRING_VALUE", // required
|
|
337
311
|
* // vectorIndexName: "STRING_VALUE", // required
|
|
@@ -404,6 +378,11 @@ declare const CreateKnowledgeBaseCommand_base: {
|
|
|
404
378
|
* // metadataField: "STRING_VALUE", // required
|
|
405
379
|
* // },
|
|
406
380
|
* // },
|
|
381
|
+
* // s3VectorsConfiguration: { // S3VectorsConfiguration
|
|
382
|
+
* // vectorBucketArn: "STRING_VALUE",
|
|
383
|
+
* // indexArn: "STRING_VALUE",
|
|
384
|
+
* // indexName: "STRING_VALUE",
|
|
385
|
+
* // },
|
|
407
386
|
* // },
|
|
408
387
|
* // status: "CREATING" || "ACTIVE" || "DELETING" || "UPDATING" || "FAILED" || "DELETE_UNSUCCESSFUL", // required
|
|
409
388
|
* // createdAt: new Date("TIMESTAMP"), // required
|
|
@@ -133,7 +133,7 @@ declare const GetKnowledgeBaseCommand_base: {
|
|
|
133
133
|
* // },
|
|
134
134
|
* // },
|
|
135
135
|
* // storageConfiguration: { // StorageConfiguration
|
|
136
|
-
* // type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER", // required
|
|
136
|
+
* // type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER" || "S3_VECTORS", // required
|
|
137
137
|
* // opensearchServerlessConfiguration: { // OpenSearchServerlessConfiguration
|
|
138
138
|
* // collectionArn: "STRING_VALUE", // required
|
|
139
139
|
* // vectorIndexName: "STRING_VALUE", // required
|
|
@@ -206,6 +206,11 @@ declare const GetKnowledgeBaseCommand_base: {
|
|
|
206
206
|
* // metadataField: "STRING_VALUE", // required
|
|
207
207
|
* // },
|
|
208
208
|
* // },
|
|
209
|
+
* // s3VectorsConfiguration: { // S3VectorsConfiguration
|
|
210
|
+
* // vectorBucketArn: "STRING_VALUE",
|
|
211
|
+
* // indexArn: "STRING_VALUE",
|
|
212
|
+
* // indexName: "STRING_VALUE",
|
|
213
|
+
* // },
|
|
209
214
|
* // },
|
|
210
215
|
* // status: "CREATING" || "ACTIVE" || "DELETING" || "UPDATING" || "FAILED" || "DELETE_UNSUCCESSFUL", // required
|
|
211
216
|
* // createdAt: new Date("TIMESTAMP"), // required
|
|
@@ -27,7 +27,7 @@ declare const TagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Associate tags with a resource. For more information, see
|
|
30
|
+
* <p>Associate tags with a resource. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Tagging resources</a> in the Amazon Bedrock User Guide.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,10 +27,7 @@ declare const UpdateDataSourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates the configurations for a data source connector.</p>
|
|
31
|
-
* <important>
|
|
32
|
-
* <p>You can't change the <code>chunkingConfiguration</code> after you create the data source connector. Specify the existing <code>chunkingConfiguration</code>.</p>
|
|
33
|
-
* </important>
|
|
30
|
+
* <p>Updates the configurations for a data source connector.</p> <important> <p>You can't change the <code>chunkingConfiguration</code> after you create the data source connector. Specify the existing <code>chunkingConfiguration</code>.</p> </important>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -27,26 +27,7 @@ declare const UpdateKnowledgeBaseCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.</p>
|
|
31
|
-
* <p>You can change the following fields:</p>
|
|
32
|
-
* <ul>
|
|
33
|
-
* <li>
|
|
34
|
-
* <p>
|
|
35
|
-
* <code>name</code>
|
|
36
|
-
* </p>
|
|
37
|
-
* </li>
|
|
38
|
-
* <li>
|
|
39
|
-
* <p>
|
|
40
|
-
* <code>description</code>
|
|
41
|
-
* </p>
|
|
42
|
-
* </li>
|
|
43
|
-
* <li>
|
|
44
|
-
* <p>
|
|
45
|
-
* <code>roleArn</code>
|
|
46
|
-
* </p>
|
|
47
|
-
* </li>
|
|
48
|
-
* </ul>
|
|
49
|
-
* <p>You can't change the <code>knowledgeBaseConfiguration</code> or <code>storageConfiguration</code> fields, so you must specify the same configurations as when you created the knowledge base. You can send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetKnowledgeBase.html">GetKnowledgeBase</a> request and copy the same configurations.</p>
|
|
30
|
+
* <p>Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.</p> <p>You can change the following fields:</p> <ul> <li> <p> <code>name</code> </p> </li> <li> <p> <code>description</code> </p> </li> <li> <p> <code>roleArn</code> </p> </li> </ul> <p>You can't change the <code>knowledgeBaseConfiguration</code> or <code>storageConfiguration</code> fields, so you must specify the same configurations as when you created the knowledge base. You can send a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetKnowledgeBase.html">GetKnowledgeBase</a> request and copy the same configurations.</p>
|
|
50
31
|
* @example
|
|
51
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
52
33
|
* ```javascript
|
|
@@ -145,7 +126,7 @@ declare const UpdateKnowledgeBaseCommand_base: {
|
|
|
145
126
|
* },
|
|
146
127
|
* },
|
|
147
128
|
* storageConfiguration: { // StorageConfiguration
|
|
148
|
-
* type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER", // required
|
|
129
|
+
* type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER" || "S3_VECTORS", // required
|
|
149
130
|
* opensearchServerlessConfiguration: { // OpenSearchServerlessConfiguration
|
|
150
131
|
* collectionArn: "STRING_VALUE", // required
|
|
151
132
|
* vectorIndexName: "STRING_VALUE", // required
|
|
@@ -218,6 +199,11 @@ declare const UpdateKnowledgeBaseCommand_base: {
|
|
|
218
199
|
* metadataField: "STRING_VALUE", // required
|
|
219
200
|
* },
|
|
220
201
|
* },
|
|
202
|
+
* s3VectorsConfiguration: { // S3VectorsConfiguration
|
|
203
|
+
* vectorBucketArn: "STRING_VALUE",
|
|
204
|
+
* indexArn: "STRING_VALUE",
|
|
205
|
+
* indexName: "STRING_VALUE",
|
|
206
|
+
* },
|
|
221
207
|
* },
|
|
222
208
|
* };
|
|
223
209
|
* const command = new UpdateKnowledgeBaseCommand(input);
|
|
@@ -316,7 +302,7 @@ declare const UpdateKnowledgeBaseCommand_base: {
|
|
|
316
302
|
* // },
|
|
317
303
|
* // },
|
|
318
304
|
* // storageConfiguration: { // StorageConfiguration
|
|
319
|
-
* // type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER", // required
|
|
305
|
+
* // type: "OPENSEARCH_SERVERLESS" || "PINECONE" || "REDIS_ENTERPRISE_CLOUD" || "RDS" || "MONGO_DB_ATLAS" || "NEPTUNE_ANALYTICS" || "OPENSEARCH_MANAGED_CLUSTER" || "S3_VECTORS", // required
|
|
320
306
|
* // opensearchServerlessConfiguration: { // OpenSearchServerlessConfiguration
|
|
321
307
|
* // collectionArn: "STRING_VALUE", // required
|
|
322
308
|
* // vectorIndexName: "STRING_VALUE", // required
|
|
@@ -389,6 +375,11 @@ declare const UpdateKnowledgeBaseCommand_base: {
|
|
|
389
375
|
* // metadataField: "STRING_VALUE", // required
|
|
390
376
|
* // },
|
|
391
377
|
* // },
|
|
378
|
+
* // s3VectorsConfiguration: { // S3VectorsConfiguration
|
|
379
|
+
* // vectorBucketArn: "STRING_VALUE",
|
|
380
|
+
* // indexArn: "STRING_VALUE",
|
|
381
|
+
* // indexName: "STRING_VALUE",
|
|
382
|
+
* // },
|
|
392
383
|
* // },
|
|
393
384
|
* // status: "CREATING" || "ACTIVE" || "DELETING" || "UPDATING" || "FAILED" || "DELETE_UNSUCCESSFUL", // required
|
|
394
385
|
* // createdAt: new Date("TIMESTAMP"), // required
|