cdk-lambda-subminute 2.0.414 → 2.0.415

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.
@@ -12,490 +12,805 @@ declare class BedrockAgent extends Service {
12
12
  constructor(options?: BedrockAgent.Types.ClientConfiguration)
13
13
  config: Config & BedrockAgent.Types.ClientConfiguration;
14
14
  /**
15
- * Associate a Knowledge Base to an existing Amazon Bedrock Agent
15
+ * Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.
16
16
  */
17
17
  associateAgentKnowledgeBase(params: BedrockAgent.Types.AssociateAgentKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.AssociateAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.AssociateAgentKnowledgeBaseResponse, AWSError>;
18
18
  /**
19
- * Associate a Knowledge Base to an existing Amazon Bedrock Agent
19
+ * Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.
20
20
  */
21
21
  associateAgentKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.AssociateAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.AssociateAgentKnowledgeBaseResponse, AWSError>;
22
22
  /**
23
- * Creates an Amazon Bedrock Agent
23
+ * Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers. Specify the following fields for security purposes. agentResourceRoleArn – The ARN of the role with permissions to create an agent. (Optional) customerEncryptionKeyArn – The ARN of a KMS key to encrypt the creation of the agent. (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session. To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts. If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
24
24
  */
25
25
  createAgent(params: BedrockAgent.Types.CreateAgentRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentResponse) => void): Request<BedrockAgent.Types.CreateAgentResponse, AWSError>;
26
26
  /**
27
- * Creates an Amazon Bedrock Agent
27
+ * Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers. Specify the following fields for security purposes. agentResourceRoleArn – The ARN of the role with permissions to create an agent. (Optional) customerEncryptionKeyArn – The ARN of a KMS key to encrypt the creation of the agent. (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session. To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts. If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
28
28
  */
29
29
  createAgent(callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentResponse) => void): Request<BedrockAgent.Types.CreateAgentResponse, AWSError>;
30
30
  /**
31
- * Creates an Action Group for existing Amazon Bedrock Agent
31
+ * 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. To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor 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 Observation reprompting the user for more information.
32
32
  */
33
33
  createAgentActionGroup(params: BedrockAgent.Types.CreateAgentActionGroupRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentActionGroupResponse) => void): Request<BedrockAgent.Types.CreateAgentActionGroupResponse, AWSError>;
34
34
  /**
35
- * Creates an Action Group for existing Amazon Bedrock Agent
35
+ * 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. To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor 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 Observation reprompting the user for more information.
36
36
  */
37
37
  createAgentActionGroup(callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentActionGroupResponse) => void): Request<BedrockAgent.Types.CreateAgentActionGroupResponse, AWSError>;
38
38
  /**
39
- * Creates an Alias for an existing Amazon Bedrock Agent
39
+ * Creates an alias of an agent that can be used to deploy the agent.
40
40
  */
41
41
  createAgentAlias(params: BedrockAgent.Types.CreateAgentAliasRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentAliasResponse) => void): Request<BedrockAgent.Types.CreateAgentAliasResponse, AWSError>;
42
42
  /**
43
- * Creates an Alias for an existing Amazon Bedrock Agent
43
+ * Creates an alias of an agent that can be used to deploy the agent.
44
44
  */
45
45
  createAgentAlias(callback?: (err: AWSError, data: BedrockAgent.Types.CreateAgentAliasResponse) => void): Request<BedrockAgent.Types.CreateAgentAliasResponse, AWSError>;
46
46
  /**
47
- * Create a new data source
47
+ * Sets up a data source to be added to a knowledge base. You can't change the chunkingConfiguration after you create the data source.
48
48
  */
49
49
  createDataSource(params: BedrockAgent.Types.CreateDataSourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateDataSourceResponse) => void): Request<BedrockAgent.Types.CreateDataSourceResponse, AWSError>;
50
50
  /**
51
- * Create a new data source
51
+ * Sets up a data source to be added to a knowledge base. You can't change the chunkingConfiguration after you create the data source.
52
52
  */
53
53
  createDataSource(callback?: (err: AWSError, data: BedrockAgent.Types.CreateDataSourceResponse) => void): Request<BedrockAgent.Types.CreateDataSourceResponse, AWSError>;
54
54
  /**
55
- * Create a new knowledge base
55
+ * Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion. 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 Create a knowledge base. Provide the name and an optional description. Provide the ARN with permissions to create a knowledge base in the roleArn field. Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object. Provide the configuration for your vector store in the storageConfiguration object. For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service. For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora. For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone. For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
56
56
  */
57
57
  createKnowledgeBase(params: BedrockAgent.Types.CreateKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.CreateKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.CreateKnowledgeBaseResponse, AWSError>;
58
58
  /**
59
- * Create a new knowledge base
59
+ * Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion. 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 Create a knowledge base. Provide the name and an optional description. Provide the ARN with permissions to create a knowledge base in the roleArn field. Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object. Provide the configuration for your vector store in the storageConfiguration object. For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service. For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora. For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone. For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
60
60
  */
61
61
  createKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.CreateKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.CreateKnowledgeBaseResponse, AWSError>;
62
62
  /**
63
- * Deletes an Agent for existing Amazon Bedrock Agent
63
+ * Deletes an agent.
64
64
  */
65
65
  deleteAgent(params: BedrockAgent.Types.DeleteAgentRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentResponse) => void): Request<BedrockAgent.Types.DeleteAgentResponse, AWSError>;
66
66
  /**
67
- * Deletes an Agent for existing Amazon Bedrock Agent
67
+ * Deletes an agent.
68
68
  */
69
69
  deleteAgent(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentResponse) => void): Request<BedrockAgent.Types.DeleteAgentResponse, AWSError>;
70
70
  /**
71
- * Deletes an Action Group for existing Amazon Bedrock Agent.
71
+ * Deletes an action group in an agent.
72
72
  */
73
73
  deleteAgentActionGroup(params: BedrockAgent.Types.DeleteAgentActionGroupRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentActionGroupResponse) => void): Request<BedrockAgent.Types.DeleteAgentActionGroupResponse, AWSError>;
74
74
  /**
75
- * Deletes an Action Group for existing Amazon Bedrock Agent.
75
+ * Deletes an action group in an agent.
76
76
  */
77
77
  deleteAgentActionGroup(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentActionGroupResponse) => void): Request<BedrockAgent.Types.DeleteAgentActionGroupResponse, AWSError>;
78
78
  /**
79
- * Deletes an Alias for a Amazon Bedrock Agent
79
+ * Deletes an alias of an agent.
80
80
  */
81
81
  deleteAgentAlias(params: BedrockAgent.Types.DeleteAgentAliasRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentAliasResponse) => void): Request<BedrockAgent.Types.DeleteAgentAliasResponse, AWSError>;
82
82
  /**
83
- * Deletes an Alias for a Amazon Bedrock Agent
83
+ * Deletes an alias of an agent.
84
84
  */
85
85
  deleteAgentAlias(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentAliasResponse) => void): Request<BedrockAgent.Types.DeleteAgentAliasResponse, AWSError>;
86
86
  /**
87
- * Deletes an Agent version for existing Amazon Bedrock Agent
87
+ * Deletes a version of an agent.
88
88
  */
89
89
  deleteAgentVersion(params: BedrockAgent.Types.DeleteAgentVersionRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentVersionResponse) => void): Request<BedrockAgent.Types.DeleteAgentVersionResponse, AWSError>;
90
90
  /**
91
- * Deletes an Agent version for existing Amazon Bedrock Agent
91
+ * Deletes a version of an agent.
92
92
  */
93
93
  deleteAgentVersion(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteAgentVersionResponse) => void): Request<BedrockAgent.Types.DeleteAgentVersionResponse, AWSError>;
94
94
  /**
95
- * Delete an existing data source
95
+ * Deletes a data source from a knowledge base.
96
96
  */
97
97
  deleteDataSource(params: BedrockAgent.Types.DeleteDataSourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteDataSourceResponse) => void): Request<BedrockAgent.Types.DeleteDataSourceResponse, AWSError>;
98
98
  /**
99
- * Delete an existing data source
99
+ * Deletes a data source from a knowledge base.
100
100
  */
101
101
  deleteDataSource(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteDataSourceResponse) => void): Request<BedrockAgent.Types.DeleteDataSourceResponse, AWSError>;
102
102
  /**
103
- * Delete an existing knowledge base
103
+ * Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
104
104
  */
105
105
  deleteKnowledgeBase(params: BedrockAgent.Types.DeleteKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DeleteKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.DeleteKnowledgeBaseResponse, AWSError>;
106
106
  /**
107
- * Delete an existing knowledge base
107
+ * Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
108
108
  */
109
109
  deleteKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.DeleteKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.DeleteKnowledgeBaseResponse, AWSError>;
110
110
  /**
111
- * Disassociate an existing Knowledge Base from an Amazon Bedrock Agent
111
+ * Disassociates a knowledge base from an agent.
112
112
  */
113
113
  disassociateAgentKnowledgeBase(params: BedrockAgent.Types.DisassociateAgentKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.DisassociateAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.DisassociateAgentKnowledgeBaseResponse, AWSError>;
114
114
  /**
115
- * Disassociate an existing Knowledge Base from an Amazon Bedrock Agent
115
+ * Disassociates a knowledge base from an agent.
116
116
  */
117
117
  disassociateAgentKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.DisassociateAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.DisassociateAgentKnowledgeBaseResponse, AWSError>;
118
118
  /**
119
- * Gets an Agent for existing Amazon Bedrock Agent
119
+ * Gets information about an agent.
120
120
  */
121
121
  getAgent(params: BedrockAgent.Types.GetAgentRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentResponse) => void): Request<BedrockAgent.Types.GetAgentResponse, AWSError>;
122
122
  /**
123
- * Gets an Agent for existing Amazon Bedrock Agent
123
+ * Gets information about an agent.
124
124
  */
125
125
  getAgent(callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentResponse) => void): Request<BedrockAgent.Types.GetAgentResponse, AWSError>;
126
126
  /**
127
- * Gets an Action Group for existing Amazon Bedrock Agent Version
127
+ * Gets information about an action group for an agent.
128
128
  */
129
129
  getAgentActionGroup(params: BedrockAgent.Types.GetAgentActionGroupRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentActionGroupResponse) => void): Request<BedrockAgent.Types.GetAgentActionGroupResponse, AWSError>;
130
130
  /**
131
- * Gets an Action Group for existing Amazon Bedrock Agent Version
131
+ * Gets information about an action group for an agent.
132
132
  */
133
133
  getAgentActionGroup(callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentActionGroupResponse) => void): Request<BedrockAgent.Types.GetAgentActionGroupResponse, AWSError>;
134
134
  /**
135
- * Describes an Alias for a Amazon Bedrock Agent
135
+ * Gets information about an alias of an agent.
136
136
  */
137
137
  getAgentAlias(params: BedrockAgent.Types.GetAgentAliasRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentAliasResponse) => void): Request<BedrockAgent.Types.GetAgentAliasResponse, AWSError>;
138
138
  /**
139
- * Describes an Alias for a Amazon Bedrock Agent
139
+ * Gets information about an alias of an agent.
140
140
  */
141
141
  getAgentAlias(callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentAliasResponse) => void): Request<BedrockAgent.Types.GetAgentAliasResponse, AWSError>;
142
142
  /**
143
- * Gets a knowledge base associated to an existing Amazon Bedrock Agent Version
143
+ * Gets information about a knowledge base associated with an agent.
144
144
  */
145
145
  getAgentKnowledgeBase(params: BedrockAgent.Types.GetAgentKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.GetAgentKnowledgeBaseResponse, AWSError>;
146
146
  /**
147
- * Gets a knowledge base associated to an existing Amazon Bedrock Agent Version
147
+ * Gets information about a knowledge base associated with an agent.
148
148
  */
149
149
  getAgentKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.GetAgentKnowledgeBaseResponse, AWSError>;
150
150
  /**
151
- * Gets an Agent version for existing Amazon Bedrock Agent
151
+ * Gets details about a version of an agent.
152
152
  */
153
153
  getAgentVersion(params: BedrockAgent.Types.GetAgentVersionRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentVersionResponse) => void): Request<BedrockAgent.Types.GetAgentVersionResponse, AWSError>;
154
154
  /**
155
- * Gets an Agent version for existing Amazon Bedrock Agent
155
+ * Gets details about a version of an agent.
156
156
  */
157
157
  getAgentVersion(callback?: (err: AWSError, data: BedrockAgent.Types.GetAgentVersionResponse) => void): Request<BedrockAgent.Types.GetAgentVersionResponse, AWSError>;
158
158
  /**
159
- * Get an existing data source
159
+ * Gets information about a data source.
160
160
  */
161
161
  getDataSource(params: BedrockAgent.Types.GetDataSourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetDataSourceResponse) => void): Request<BedrockAgent.Types.GetDataSourceResponse, AWSError>;
162
162
  /**
163
- * Get an existing data source
163
+ * Gets information about a data source.
164
164
  */
165
165
  getDataSource(callback?: (err: AWSError, data: BedrockAgent.Types.GetDataSourceResponse) => void): Request<BedrockAgent.Types.GetDataSourceResponse, AWSError>;
166
166
  /**
167
- * Get an ingestion job
167
+ * Gets information about a ingestion job, in which a data source is added to a knowledge base.
168
168
  */
169
169
  getIngestionJob(params: BedrockAgent.Types.GetIngestionJobRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetIngestionJobResponse) => void): Request<BedrockAgent.Types.GetIngestionJobResponse, AWSError>;
170
170
  /**
171
- * Get an ingestion job
171
+ * Gets information about a ingestion job, in which a data source is added to a knowledge base.
172
172
  */
173
173
  getIngestionJob(callback?: (err: AWSError, data: BedrockAgent.Types.GetIngestionJobResponse) => void): Request<BedrockAgent.Types.GetIngestionJobResponse, AWSError>;
174
174
  /**
175
- * Get an existing knowledge base
175
+ * Gets information about a knoweldge base.
176
176
  */
177
177
  getKnowledgeBase(params: BedrockAgent.Types.GetKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.GetKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.GetKnowledgeBaseResponse, AWSError>;
178
178
  /**
179
- * Get an existing knowledge base
179
+ * Gets information about a knoweldge base.
180
180
  */
181
181
  getKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.GetKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.GetKnowledgeBaseResponse, AWSError>;
182
182
  /**
183
- * Lists an Action Group for existing Amazon Bedrock Agent Version
183
+ * Lists the action groups for an agent and information about each one.
184
184
  */
185
185
  listAgentActionGroups(params: BedrockAgent.Types.ListAgentActionGroupsRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentActionGroupsResponse) => void): Request<BedrockAgent.Types.ListAgentActionGroupsResponse, AWSError>;
186
186
  /**
187
- * Lists an Action Group for existing Amazon Bedrock Agent Version
187
+ * Lists the action groups for an agent and information about each one.
188
188
  */
189
189
  listAgentActionGroups(callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentActionGroupsResponse) => void): Request<BedrockAgent.Types.ListAgentActionGroupsResponse, AWSError>;
190
190
  /**
191
- * Lists all the Aliases for an Amazon Bedrock Agent
191
+ * Lists the aliases of an agent and information about each one.
192
192
  */
193
193
  listAgentAliases(params: BedrockAgent.Types.ListAgentAliasesRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentAliasesResponse) => void): Request<BedrockAgent.Types.ListAgentAliasesResponse, AWSError>;
194
194
  /**
195
- * Lists all the Aliases for an Amazon Bedrock Agent
195
+ * Lists the aliases of an agent and information about each one.
196
196
  */
197
197
  listAgentAliases(callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentAliasesResponse) => void): Request<BedrockAgent.Types.ListAgentAliasesResponse, AWSError>;
198
198
  /**
199
- * List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version
199
+ * Lists knowledge bases associated with an agent and information about each one.
200
200
  */
201
201
  listAgentKnowledgeBases(params: BedrockAgent.Types.ListAgentKnowledgeBasesRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentKnowledgeBasesResponse) => void): Request<BedrockAgent.Types.ListAgentKnowledgeBasesResponse, AWSError>;
202
202
  /**
203
- * List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version
203
+ * Lists knowledge bases associated with an agent and information about each one.
204
204
  */
205
205
  listAgentKnowledgeBases(callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentKnowledgeBasesResponse) => void): Request<BedrockAgent.Types.ListAgentKnowledgeBasesResponse, AWSError>;
206
206
  /**
207
- * Lists Agent Versions
207
+ * Lists the versions of an agent and information about each version.
208
208
  */
209
209
  listAgentVersions(params: BedrockAgent.Types.ListAgentVersionsRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentVersionsResponse) => void): Request<BedrockAgent.Types.ListAgentVersionsResponse, AWSError>;
210
210
  /**
211
- * Lists Agent Versions
211
+ * Lists the versions of an agent and information about each version.
212
212
  */
213
213
  listAgentVersions(callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentVersionsResponse) => void): Request<BedrockAgent.Types.ListAgentVersionsResponse, AWSError>;
214
214
  /**
215
- * Lists Agents
215
+ * Lists the agents belonging to an account and information about each agent.
216
216
  */
217
217
  listAgents(params: BedrockAgent.Types.ListAgentsRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentsResponse) => void): Request<BedrockAgent.Types.ListAgentsResponse, AWSError>;
218
218
  /**
219
- * Lists Agents
219
+ * Lists the agents belonging to an account and information about each agent.
220
220
  */
221
221
  listAgents(callback?: (err: AWSError, data: BedrockAgent.Types.ListAgentsResponse) => void): Request<BedrockAgent.Types.ListAgentsResponse, AWSError>;
222
222
  /**
223
- * List data sources
223
+ * Lists the data sources in a knowledge base and information about each one.
224
224
  */
225
225
  listDataSources(params: BedrockAgent.Types.ListDataSourcesRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListDataSourcesResponse) => void): Request<BedrockAgent.Types.ListDataSourcesResponse, AWSError>;
226
226
  /**
227
- * List data sources
227
+ * Lists the data sources in a knowledge base and information about each one.
228
228
  */
229
229
  listDataSources(callback?: (err: AWSError, data: BedrockAgent.Types.ListDataSourcesResponse) => void): Request<BedrockAgent.Types.ListDataSourcesResponse, AWSError>;
230
230
  /**
231
- * List ingestion jobs
231
+ * Lists the ingestion jobs for a data source and information about each of them.
232
232
  */
233
233
  listIngestionJobs(params: BedrockAgent.Types.ListIngestionJobsRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListIngestionJobsResponse) => void): Request<BedrockAgent.Types.ListIngestionJobsResponse, AWSError>;
234
234
  /**
235
- * List ingestion jobs
235
+ * Lists the ingestion jobs for a data source and information about each of them.
236
236
  */
237
237
  listIngestionJobs(callback?: (err: AWSError, data: BedrockAgent.Types.ListIngestionJobsResponse) => void): Request<BedrockAgent.Types.ListIngestionJobsResponse, AWSError>;
238
238
  /**
239
- * List Knowledge Bases
239
+ * Lists the knowledge bases in an account and information about each of them.
240
240
  */
241
241
  listKnowledgeBases(params: BedrockAgent.Types.ListKnowledgeBasesRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListKnowledgeBasesResponse) => void): Request<BedrockAgent.Types.ListKnowledgeBasesResponse, AWSError>;
242
242
  /**
243
- * List Knowledge Bases
243
+ * Lists the knowledge bases in an account and information about each of them.
244
244
  */
245
245
  listKnowledgeBases(callback?: (err: AWSError, data: BedrockAgent.Types.ListKnowledgeBasesResponse) => void): Request<BedrockAgent.Types.ListKnowledgeBasesResponse, AWSError>;
246
246
  /**
247
- * List tags for a resource
247
+ * List all the tags for the resource you specify.
248
248
  */
249
249
  listTagsForResource(params: BedrockAgent.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.ListTagsForResourceResponse) => void): Request<BedrockAgent.Types.ListTagsForResourceResponse, AWSError>;
250
250
  /**
251
- * List tags for a resource
251
+ * List all the tags for the resource you specify.
252
252
  */
253
253
  listTagsForResource(callback?: (err: AWSError, data: BedrockAgent.Types.ListTagsForResourceResponse) => void): Request<BedrockAgent.Types.ListTagsForResourceResponse, AWSError>;
254
254
  /**
255
- * Prepares an existing Amazon Bedrock Agent to receive runtime requests
255
+ * Creates a DRAFT version of the agent that can be used for internal testing.
256
256
  */
257
257
  prepareAgent(params: BedrockAgent.Types.PrepareAgentRequest, callback?: (err: AWSError, data: BedrockAgent.Types.PrepareAgentResponse) => void): Request<BedrockAgent.Types.PrepareAgentResponse, AWSError>;
258
258
  /**
259
- * Prepares an existing Amazon Bedrock Agent to receive runtime requests
259
+ * Creates a DRAFT version of the agent that can be used for internal testing.
260
260
  */
261
261
  prepareAgent(callback?: (err: AWSError, data: BedrockAgent.Types.PrepareAgentResponse) => void): Request<BedrockAgent.Types.PrepareAgentResponse, AWSError>;
262
262
  /**
263
- * Start a new ingestion job
263
+ * Begins an ingestion job, in which a data source is added to a knowledge base.
264
264
  */
265
265
  startIngestionJob(params: BedrockAgent.Types.StartIngestionJobRequest, callback?: (err: AWSError, data: BedrockAgent.Types.StartIngestionJobResponse) => void): Request<BedrockAgent.Types.StartIngestionJobResponse, AWSError>;
266
266
  /**
267
- * Start a new ingestion job
267
+ * Begins an ingestion job, in which a data source is added to a knowledge base.
268
268
  */
269
269
  startIngestionJob(callback?: (err: AWSError, data: BedrockAgent.Types.StartIngestionJobResponse) => void): Request<BedrockAgent.Types.StartIngestionJobResponse, AWSError>;
270
270
  /**
271
- * Tag a resource
271
+ * Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
272
272
  */
273
273
  tagResource(params: BedrockAgent.Types.TagResourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.TagResourceResponse) => void): Request<BedrockAgent.Types.TagResourceResponse, AWSError>;
274
274
  /**
275
- * Tag a resource
275
+ * Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
276
276
  */
277
277
  tagResource(callback?: (err: AWSError, data: BedrockAgent.Types.TagResourceResponse) => void): Request<BedrockAgent.Types.TagResourceResponse, AWSError>;
278
278
  /**
279
- * Untag a resource
279
+ * Remove tags from a resource.
280
280
  */
281
281
  untagResource(params: BedrockAgent.Types.UntagResourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UntagResourceResponse) => void): Request<BedrockAgent.Types.UntagResourceResponse, AWSError>;
282
282
  /**
283
- * Untag a resource
283
+ * Remove tags from a resource.
284
284
  */
285
285
  untagResource(callback?: (err: AWSError, data: BedrockAgent.Types.UntagResourceResponse) => void): Request<BedrockAgent.Types.UntagResourceResponse, AWSError>;
286
286
  /**
287
- * Updates an existing Amazon Bedrock Agent
287
+ * Updates the configuration of an agent.
288
288
  */
289
289
  updateAgent(params: BedrockAgent.Types.UpdateAgentRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentResponse) => void): Request<BedrockAgent.Types.UpdateAgentResponse, AWSError>;
290
290
  /**
291
- * Updates an existing Amazon Bedrock Agent
291
+ * Updates the configuration of an agent.
292
292
  */
293
293
  updateAgent(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentResponse) => void): Request<BedrockAgent.Types.UpdateAgentResponse, AWSError>;
294
294
  /**
295
- * Updates an existing Action Group for Amazon Bedrock Agent
295
+ * Updates the configuration for an action group for an agent.
296
296
  */
297
297
  updateAgentActionGroup(params: BedrockAgent.Types.UpdateAgentActionGroupRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentActionGroupResponse) => void): Request<BedrockAgent.Types.UpdateAgentActionGroupResponse, AWSError>;
298
298
  /**
299
- * Updates an existing Action Group for Amazon Bedrock Agent
299
+ * Updates the configuration for an action group for an agent.
300
300
  */
301
301
  updateAgentActionGroup(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentActionGroupResponse) => void): Request<BedrockAgent.Types.UpdateAgentActionGroupResponse, AWSError>;
302
302
  /**
303
- * Updates an existing Alias for an Amazon Bedrock Agent
303
+ * Updates configurations for an alias of an agent.
304
304
  */
305
305
  updateAgentAlias(params: BedrockAgent.Types.UpdateAgentAliasRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentAliasResponse) => void): Request<BedrockAgent.Types.UpdateAgentAliasResponse, AWSError>;
306
306
  /**
307
- * Updates an existing Alias for an Amazon Bedrock Agent
307
+ * Updates configurations for an alias of an agent.
308
308
  */
309
309
  updateAgentAlias(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentAliasResponse) => void): Request<BedrockAgent.Types.UpdateAgentAliasResponse, AWSError>;
310
310
  /**
311
- * Updates an existing Knowledge Base associated to an Amazon Bedrock Agent
311
+ * Updates the configuration for a knowledge base that has been associated with an agent.
312
312
  */
313
313
  updateAgentKnowledgeBase(params: BedrockAgent.Types.UpdateAgentKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.UpdateAgentKnowledgeBaseResponse, AWSError>;
314
314
  /**
315
- * Updates an existing Knowledge Base associated to an Amazon Bedrock Agent
315
+ * Updates the configuration for a knowledge base that has been associated with an agent.
316
316
  */
317
317
  updateAgentKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateAgentKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.UpdateAgentKnowledgeBaseResponse, AWSError>;
318
318
  /**
319
- * Update an existing data source
319
+ * Updates configurations for a data source. You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.
320
320
  */
321
321
  updateDataSource(params: BedrockAgent.Types.UpdateDataSourceRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateDataSourceResponse) => void): Request<BedrockAgent.Types.UpdateDataSourceResponse, AWSError>;
322
322
  /**
323
- * Update an existing data source
323
+ * Updates configurations for a data source. You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.
324
324
  */
325
325
  updateDataSource(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateDataSourceResponse) => void): Request<BedrockAgent.Types.UpdateDataSourceResponse, AWSError>;
326
326
  /**
327
- * Update an existing knowledge base
327
+ * 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. You can change the following fields: name description roleArn You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
328
328
  */
329
329
  updateKnowledgeBase(params: BedrockAgent.Types.UpdateKnowledgeBaseRequest, callback?: (err: AWSError, data: BedrockAgent.Types.UpdateKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.UpdateKnowledgeBaseResponse, AWSError>;
330
330
  /**
331
- * Update an existing knowledge base
331
+ * 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. You can change the following fields: name description roleArn You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
332
332
  */
333
333
  updateKnowledgeBase(callback?: (err: AWSError, data: BedrockAgent.Types.UpdateKnowledgeBaseResponse) => void): Request<BedrockAgent.Types.UpdateKnowledgeBaseResponse, AWSError>;
334
334
  }
335
335
  declare namespace BedrockAgent {
336
336
  export interface APISchema {
337
- s3?: S3Identifier;
337
+ /**
338
+ * The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
339
+ */
338
340
  payload?: Payload;
341
+ /**
342
+ * Contains details about the S3 object containing the OpenAPI schema for the action group. For more information, see Action group OpenAPI schemas.
343
+ */
344
+ s3?: S3Identifier;
339
345
  }
340
346
  export interface ActionGroupExecutor {
347
+ /**
348
+ * The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
349
+ */
341
350
  lambda?: LambdaArn;
342
351
  }
343
352
  export type ActionGroupSignature = "AMAZON.UserInput"|string;
344
353
  export type ActionGroupState = "ENABLED"|"DISABLED"|string;
345
354
  export type ActionGroupSummaries = ActionGroupSummary[];
346
355
  export interface ActionGroupSummary {
356
+ /**
357
+ * The unique identifier of the action group.
358
+ */
347
359
  actionGroupId: Id;
360
+ /**
361
+ * The name of the action group.
362
+ */
348
363
  actionGroupName: Name;
364
+ /**
365
+ * Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
366
+ */
349
367
  actionGroupState: ActionGroupState;
368
+ /**
369
+ * The description of the action group.
370
+ */
350
371
  description?: Description;
372
+ /**
373
+ * The time at which the action group was last updated.
374
+ */
351
375
  updatedAt: DateTimestamp;
352
376
  }
353
377
  export interface Agent {
378
+ /**
379
+ * The ARN of the agent.
380
+ */
381
+ agentArn: AgentArn;
382
+ /**
383
+ * The unique identifier of the agent.
384
+ */
354
385
  agentId: Id;
386
+ /**
387
+ * The name of the agent.
388
+ */
355
389
  agentName: Name;
356
- agentArn: AgentArn;
390
+ /**
391
+ * The ARN of the IAM role with permissions to call API operations on the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.
392
+ */
393
+ agentResourceRoleArn: AgentRoleArn;
394
+ /**
395
+ * The status of the agent and whether it is ready for use. The following statuses are possible: CREATING – The agent is being created. PREPARING – The agent is being prepared. PREPARED – The agent is prepared and ready to be invoked. NOT_PREPARED – The agent has been created but not yet prepared. FAILED – The agent API operation failed. UPDATING – The agent is being updated. DELETING – The agent is being deleted.
396
+ */
397
+ agentStatus: AgentStatus;
398
+ /**
399
+ * The version of the agent.
400
+ */
357
401
  agentVersion: DraftVersion;
402
+ /**
403
+ * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
404
+ */
358
405
  clientToken?: ClientToken;
359
- instruction?: Instruction;
360
- agentStatus: AgentStatus;
361
- foundationModel?: ModelIdentifier;
406
+ /**
407
+ * The time at which the agent was created.
408
+ */
409
+ createdAt: DateTimestamp;
410
+ /**
411
+ * The ARN of the KMS key that encrypts the agent.
412
+ */
413
+ customerEncryptionKeyArn?: KmsKeyArn;
414
+ /**
415
+ * The description of the agent.
416
+ */
362
417
  description?: Description;
418
+ /**
419
+ * Contains reasons that the agent-related API that you invoked failed.
420
+ */
421
+ failureReasons?: FailureReasons;
422
+ /**
423
+ * The foundation model used for orchestration by the agent.
424
+ */
425
+ foundationModel?: ModelIdentifier;
426
+ /**
427
+ * The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent. A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
428
+ */
363
429
  idleSessionTTLInSeconds: SessionTTL;
364
- agentResourceRoleArn: AgentRoleArn;
365
- customerEncryptionKeyArn?: KmsKeyArn;
366
- createdAt: DateTimestamp;
367
- updatedAt: DateTimestamp;
430
+ /**
431
+ * Instructions that tell the agent what it should do and how it should interact with users.
432
+ */
433
+ instruction?: Instruction;
434
+ /**
435
+ * The time at which the agent was last prepared.
436
+ */
368
437
  preparedAt?: DateTimestamp;
369
- failureReasons?: FailureReasons;
370
- recommendedActions?: RecommendedActions;
438
+ /**
439
+ * Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
440
+ */
371
441
  promptOverrideConfiguration?: PromptOverrideConfiguration;
442
+ /**
443
+ * Contains recommended actions to take for the agent-related API that you invoked to succeed.
444
+ */
445
+ recommendedActions?: RecommendedActions;
446
+ /**
447
+ * The time at which the agent was last updated.
448
+ */
449
+ updatedAt: DateTimestamp;
372
450
  }
373
451
  export interface AgentActionGroup {
374
- agentId: Id;
375
- agentVersion: Version;
452
+ /**
453
+ * The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
454
+ */
455
+ actionGroupExecutor?: ActionGroupExecutor;
456
+ /**
457
+ * The unique identifier of the action group.
458
+ */
376
459
  actionGroupId: Id;
460
+ /**
461
+ * The name of the action group.
462
+ */
377
463
  actionGroupName: Name;
464
+ /**
465
+ * Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
466
+ */
467
+ actionGroupState: ActionGroupState;
468
+ /**
469
+ * The unique identifier of the agent to which the action group belongs.
470
+ */
471
+ agentId: Id;
472
+ /**
473
+ * The version of the agent to which the action group belongs.
474
+ */
475
+ agentVersion: Version;
476
+ /**
477
+ * Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
478
+ */
479
+ apiSchema?: APISchema;
480
+ /**
481
+ * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
482
+ */
378
483
  clientToken?: ClientToken;
379
- description?: Description;
484
+ /**
485
+ * The time at which the action group was created.
486
+ */
380
487
  createdAt: DateTimestamp;
381
- updatedAt: DateTimestamp;
488
+ /**
489
+ * The description of the action group.
490
+ */
491
+ description?: Description;
492
+ /**
493
+ * If this field is set as AMAZON.UserInput, the agent can request the user for additional information when trying to complete a task. The description, apiSchema, and actionGroupExecutor fields must be blank for this action group. During orchestration, if the 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 Observation reprompting the user for more information.
494
+ */
382
495
  parentActionSignature?: ActionGroupSignature;
383
- actionGroupExecutor?: ActionGroupExecutor;
384
- apiSchema?: APISchema;
385
- actionGroupState: ActionGroupState;
496
+ /**
497
+ * The time at which the action group was last updated.
498
+ */
499
+ updatedAt: DateTimestamp;
386
500
  }
387
501
  export interface AgentAlias {
388
- agentId: Id;
502
+ /**
503
+ * The ARN of the alias of the agent.
504
+ */
505
+ agentAliasArn: AgentAliasArn;
506
+ /**
507
+ * Contains details about the history of the alias.
508
+ */
509
+ agentAliasHistoryEvents?: AgentAliasHistoryEvents;
510
+ /**
511
+ * The unique identifier of the alias of the agent.
512
+ */
389
513
  agentAliasId: AgentAliasId;
514
+ /**
515
+ * The name of the alias of the agent.
516
+ */
390
517
  agentAliasName: Name;
391
- agentAliasArn: AgentAliasArn;
518
+ /**
519
+ * The status of the alias of the agent and whether it is ready for use. The following statuses are possible: CREATING – The agent alias is being created. PREPARED – The agent alias is finished being created or updated and is ready to be invoked. FAILED – The agent alias API operation failed. UPDATING – The agent alias is being updated. DELETING – The agent alias is being deleted.
520
+ */
521
+ agentAliasStatus: AgentAliasStatus;
522
+ /**
523
+ * The unique identifier of the agent.
524
+ */
525
+ agentId: Id;
526
+ /**
527
+ * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
528
+ */
392
529
  clientToken?: ClientToken;
530
+ /**
531
+ * The time at which the alias of the agent was created.
532
+ */
533
+ createdAt: DateTimestamp;
534
+ /**
535
+ * The description of the alias of the agent.
536
+ */
393
537
  description?: Description;
538
+ /**
539
+ * Contains details about the routing configuration of the alias.
540
+ */
394
541
  routingConfiguration: AgentAliasRoutingConfiguration;
395
- createdAt: DateTimestamp;
542
+ /**
543
+ * The time at which the alias was last updated.
544
+ */
396
545
  updatedAt: DateTimestamp;
397
- agentAliasHistoryEvents?: AgentAliasHistoryEvents;
398
- agentAliasStatus: AgentAliasStatus;
399
546
  }
400
547
  export type AgentAliasArn = string;
401
548
  export interface AgentAliasHistoryEvent {
402
- routingConfiguration?: AgentAliasRoutingConfiguration;
549
+ /**
550
+ * The date that the alias stopped being associated to the version in the routingConfiguration object
551
+ */
403
552
  endDate?: DateTimestamp;
553
+ /**
554
+ * Contains details about the version of the agent with which the alias is associated.
555
+ */
556
+ routingConfiguration?: AgentAliasRoutingConfiguration;
557
+ /**
558
+ * The date that the alias began being associated to the version in the routingConfiguration object.
559
+ */
404
560
  startDate?: DateTimestamp;
405
561
  }
406
562
  export type AgentAliasHistoryEvents = AgentAliasHistoryEvent[];
407
563
  export type AgentAliasId = string;
408
564
  export type AgentAliasRoutingConfiguration = AgentAliasRoutingConfigurationListItem[];
409
565
  export interface AgentAliasRoutingConfigurationListItem {
566
+ /**
567
+ * The version of the agent with which the alias is associated.
568
+ */
410
569
  agentVersion: Version;
411
570
  }
412
571
  export type AgentAliasStatus = "CREATING"|"PREPARED"|"FAILED"|"UPDATING"|"DELETING"|string;
413
572
  export type AgentAliasSummaries = AgentAliasSummary[];
414
573
  export interface AgentAliasSummary {
574
+ /**
575
+ * Contains details about
576
+ */
415
577
  agentAliasId: AgentAliasId;
578
+ /**
579
+ * The name of the alias.
580
+ */
416
581
  agentAliasName: Name;
417
- description?: Description;
418
- routingConfiguration?: AgentAliasRoutingConfiguration;
582
+ /**
583
+ * The status of the alias.
584
+ */
419
585
  agentAliasStatus: AgentAliasStatus;
586
+ /**
587
+ * The time at which the alias of the agent was created.
588
+ */
420
589
  createdAt: DateTimestamp;
590
+ /**
591
+ * The description of the alias.
592
+ */
593
+ description?: Description;
594
+ /**
595
+ * Contains details about the version of the agent with which the alias is associated.
596
+ */
597
+ routingConfiguration?: AgentAliasRoutingConfiguration;
598
+ /**
599
+ * The time at which the alias was last updated.
600
+ */
421
601
  updatedAt: DateTimestamp;
422
602
  }
423
603
  export type AgentArn = string;
424
604
  export interface AgentKnowledgeBase {
605
+ /**
606
+ * The unique identifier of the agent with which the knowledge base is associated.
607
+ */
425
608
  agentId: Id;
609
+ /**
610
+ * The version of the agent with which the knowledge base is associated.
611
+ */
426
612
  agentVersion: Version;
427
- knowledgeBaseId: Id;
428
- description: Description;
613
+ /**
614
+ * The time at which the association between the agent and the knowledge base was created.
615
+ */
429
616
  createdAt: DateTimestamp;
430
- updatedAt: DateTimestamp;
617
+ /**
618
+ * The description of the association between the agent and the knowledge base.
619
+ */
620
+ description: Description;
621
+ /**
622
+ * The unique identifier of the association between the agent and the knowledge base.
623
+ */
624
+ knowledgeBaseId: Id;
625
+ /**
626
+ * Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
627
+ */
431
628
  knowledgeBaseState: KnowledgeBaseState;
629
+ /**
630
+ * The time at which the association between the agent and the knowledge base was last updated.
631
+ */
632
+ updatedAt: DateTimestamp;
432
633
  }
433
634
  export type AgentKnowledgeBaseSummaries = AgentKnowledgeBaseSummary[];
434
635
  export interface AgentKnowledgeBaseSummary {
435
- knowledgeBaseId: Id;
636
+ /**
637
+ * The description of the knowledge base associated with an agent.
638
+ */
436
639
  description?: Description;
640
+ /**
641
+ * The unique identifier of the knowledge base associated with an agent.
642
+ */
643
+ knowledgeBaseId: Id;
644
+ /**
645
+ * Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
646
+ */
437
647
  knowledgeBaseState: KnowledgeBaseState;
648
+ /**
649
+ * The time at which the knowledge base associated with an agent was last updated.
650
+ */
438
651
  updatedAt: DateTimestamp;
439
652
  }
440
653
  export type AgentRoleArn = string;
441
654
  export type AgentStatus = "CREATING"|"PREPARING"|"PREPARED"|"NOT_PREPARED"|"DELETING"|"FAILED"|"VERSIONING"|"UPDATING"|string;
442
655
  export type AgentSummaries = AgentSummary[];
443
656
  export interface AgentSummary {
657
+ /**
658
+ * The unique identifier of the agent.
659
+ */
444
660
  agentId: Id;
661
+ /**
662
+ * The name of the agent.
663
+ */
445
664
  agentName: Name;
665
+ /**
666
+ * The status of the agent.
667
+ */
446
668
  agentStatus: AgentStatus;
669
+ /**
670
+ * The description of the agent.
671
+ */
447
672
  description?: Description;
448
- updatedAt: DateTimestamp;
673
+ /**
674
+ * The latest version of the agent.
675
+ */
449
676
  latestAgentVersion?: Version;
677
+ /**
678
+ * The time at which the agent was last updated.
679
+ */
680
+ updatedAt: DateTimestamp;
450
681
  }
451
682
  export interface AgentVersion {
683
+ /**
684
+ * The ARN of the agent that the version belongs to.
685
+ */
686
+ agentArn: AgentArn;
687
+ /**
688
+ * The unique identifier of the agent that the version belongs to.
689
+ */
452
690
  agentId: Id;
691
+ /**
692
+ * The name of the agent that the version belongs to.
693
+ */
453
694
  agentName: Name;
454
- agentArn: AgentArn;
455
- version: NumericalVersion;
456
- instruction?: Instruction;
457
- agentStatus: AgentStatus;
458
- foundationModel?: ModelIdentifier;
459
- description?: Description;
460
- idleSessionTTLInSeconds: SessionTTL;
695
+ /**
696
+ * The ARN of the IAM role with permissions to invoke API operations on the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.
697
+ */
461
698
  agentResourceRoleArn: AgentRoleArn;
462
- customerEncryptionKeyArn?: KmsKeyArn;
699
+ /**
700
+ * The status of the agent that the version belongs to.
701
+ */
702
+ agentStatus: AgentStatus;
703
+ /**
704
+ * The time at which the version was created.
705
+ */
463
706
  createdAt: DateTimestamp;
464
- updatedAt: DateTimestamp;
707
+ /**
708
+ * The ARN of the KMS key that encrypts the agent.
709
+ */
710
+ customerEncryptionKeyArn?: KmsKeyArn;
711
+ /**
712
+ * The description of the version.
713
+ */
714
+ description?: Description;
715
+ /**
716
+ * A list of reasons that the API operation on the version failed.
717
+ */
465
718
  failureReasons?: FailureReasons;
466
- recommendedActions?: RecommendedActions;
719
+ /**
720
+ * The foundation model that the version invokes.
721
+ */
722
+ foundationModel?: ModelIdentifier;
723
+ /**
724
+ * The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent. A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
725
+ */
726
+ idleSessionTTLInSeconds: SessionTTL;
727
+ /**
728
+ * The instructions provided to the agent.
729
+ */
730
+ instruction?: Instruction;
731
+ /**
732
+ * Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
733
+ */
467
734
  promptOverrideConfiguration?: PromptOverrideConfiguration;
735
+ /**
736
+ * A list of recommended actions to take for the failed API operation on the version to succeed.
737
+ */
738
+ recommendedActions?: RecommendedActions;
739
+ /**
740
+ * The time at which the version was last updated.
741
+ */
742
+ updatedAt: DateTimestamp;
743
+ /**
744
+ * The version number.
745
+ */
746
+ version: NumericalVersion;
468
747
  }
469
748
  export type AgentVersionSummaries = AgentVersionSummary[];
470
749
  export interface AgentVersionSummary {
750
+ /**
751
+ * The name of the agent to which the version belongs.
752
+ */
471
753
  agentName: Name;
754
+ /**
755
+ * The status of the agent to which the version belongs.
756
+ */
472
757
  agentStatus: AgentStatus;
758
+ /**
759
+ * The version of the agent.
760
+ */
473
761
  agentVersion: Version;
762
+ /**
763
+ * The time at which the version was created.
764
+ */
474
765
  createdAt: DateTimestamp;
475
- updatedAt: DateTimestamp;
766
+ /**
767
+ * The description of the version of the agent.
768
+ */
476
769
  description?: Description;
770
+ /**
771
+ * The time at which the version was last updated.
772
+ */
773
+ updatedAt: DateTimestamp;
477
774
  }
478
775
  export interface AssociateAgentKnowledgeBaseRequest {
479
776
  /**
480
- * Id generated at the server side when an Agent is created
777
+ * The unique identifier of the agent with which you want to associate the knowledge base.
778
+ */
779
+ agentId: Id;
780
+ /**
781
+ * The version of the agent with which you want to associate the knowledge base.
782
+ */
783
+ agentVersion: DraftVersion;
784
+ /**
785
+ * A description of what the agent should use the knowledge base for.
481
786
  */
482
- agentId: Id;
787
+ description: Description;
483
788
  /**
484
- * Draft Version of the Agent.
789
+ * The unique identifier of the knowledge base to associate with the agent.
485
790
  */
486
- agentVersion: DraftVersion;
487
791
  knowledgeBaseId: Id;
488
- description: Description;
792
+ /**
793
+ * Specifies whether to use the knowledge base or not when sending an InvokeAgent request.
794
+ */
489
795
  knowledgeBaseState?: KnowledgeBaseState;
490
796
  }
491
797
  export interface AssociateAgentKnowledgeBaseResponse {
798
+ /**
799
+ * Contains details about the knowledge base that has been associated with the agent.
800
+ */
492
801
  agentKnowledgeBase: AgentKnowledgeBase;
493
802
  }
494
803
  export type BasePromptTemplate = string;
495
804
  export type BedrockEmbeddingModelArn = string;
496
805
  export type Boolean = boolean;
497
806
  export interface ChunkingConfiguration {
807
+ /**
808
+ * Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for NONE, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk. FIXED_SIZE – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the fixedSizeChunkingConfiguration. NONE – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files.
809
+ */
498
810
  chunkingStrategy: ChunkingStrategy;
811
+ /**
812
+ * Configurations for when you choose fixed-size chunking. If you set the chunkingStrategy as NONE, exclude this field.
813
+ */
499
814
  fixedSizeChunkingConfiguration?: FixedSizeChunkingConfiguration;
500
815
  }
501
816
  export type ChunkingStrategy = "FIXED_SIZE"|"NONE"|string;
@@ -503,121 +818,298 @@ declare namespace BedrockAgent {
503
818
  export type ColumnName = string;
504
819
  export interface CreateAgentActionGroupRequest {
505
820
  /**
506
- * Id generated at the server side when an Agent is created
821
+ * The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
822
+ */
823
+ actionGroupExecutor?: ActionGroupExecutor;
824
+ /**
825
+ * The name to give the action group.
826
+ */
827
+ actionGroupName: Name;
828
+ /**
829
+ * Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
830
+ */
831
+ actionGroupState?: ActionGroupState;
832
+ /**
833
+ * The unique identifier of the agent for which to create the action group.
507
834
  */
508
835
  agentId: Id;
509
836
  /**
510
- * Draft Version of the Agent.
837
+ * The version of the agent for which to create the action group.
511
838
  */
512
839
  agentVersion: DraftVersion;
513
- actionGroupName: Name;
840
+ /**
841
+ * Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
842
+ */
843
+ apiSchema?: APISchema;
844
+ /**
845
+ * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
846
+ */
514
847
  clientToken?: ClientToken;
848
+ /**
849
+ * A description of the action group.
850
+ */
515
851
  description?: Description;
852
+ /**
853
+ * To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor 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 Observation reprompting the user for more information.
854
+ */
516
855
  parentActionGroupSignature?: ActionGroupSignature;
517
- actionGroupExecutor?: ActionGroupExecutor;
518
- apiSchema?: APISchema;
519
- actionGroupState?: ActionGroupState;
520
856
  }
521
857
  export interface CreateAgentActionGroupResponse {
858
+ /**
859
+ * Contains details about the action group that was created.
860
+ */
522
861
  agentActionGroup: AgentActionGroup;
523
862
  }
524
863
  export interface CreateAgentAliasRequest {
525
864
  /**
526
- * Id generated at the server side when an Agent is created
865
+ * The name of the alias.
527
866
  */
528
- agentId: Id;
529
867
  agentAliasName: Name;
868
+ /**
869
+ * The unique identifier of the agent.
870
+ */
871
+ agentId: Id;
872
+ /**
873
+ * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
874
+ */
530
875
  clientToken?: ClientToken;
876
+ /**
877
+ * A description of the alias of the agent.
878
+ */
531
879
  description?: Description;
880
+ /**
881
+ * Contains details about the routing configuration of the alias.
882
+ */
532
883
  routingConfiguration?: AgentAliasRoutingConfiguration;
884
+ /**
885
+ * Any tags that you want to attach to the alias of the agent.
886
+ */
533
887
  tags?: TagsMap;
534
888
  }
535
889
  export interface CreateAgentAliasResponse {
890
+ /**
891
+ * Contains details about the alias that was created.
892
+ */
536
893
  agentAlias: AgentAlias;
537
894
  }
538
895
  export interface CreateAgentRequest {
896
+ /**
897
+ * A name for the agent that you create.
898
+ */
539
899
  agentName: Name;
900
+ /**
901
+ * The ARN of the IAM role with permissions to create the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.
902
+ */
903
+ agentResourceRoleArn: AgentRoleArn;
904
+ /**
905
+ * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
906
+ */
540
907
  clientToken?: ClientToken;
541
- instruction?: Instruction;
542
- foundationModel?: ModelIdentifier;
908
+ /**
909
+ * The ARN of the KMS key with which to encrypt the agent.
910
+ */
911
+ customerEncryptionKeyArn?: KmsKeyArn;
912
+ /**
913
+ * A description of the agent.
914
+ */
543
915
  description?: Description;
916
+ /**
917
+ * The foundation model to be used for orchestration by the agent you create.
918
+ */
919
+ foundationModel?: ModelIdentifier;
920
+ /**
921
+ * The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent. A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
922
+ */
544
923
  idleSessionTTLInSeconds?: SessionTTL;
545
- agentResourceRoleArn: AgentRoleArn;
546
- customerEncryptionKeyArn?: KmsKeyArn;
547
- tags?: TagsMap;
924
+ /**
925
+ * Instructions that tell the agent what it should do and how it should interact with users.
926
+ */
927
+ instruction?: Instruction;
928
+ /**
929
+ * Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
930
+ */
548
931
  promptOverrideConfiguration?: PromptOverrideConfiguration;
932
+ /**
933
+ * Any tags that you want to attach to the agent.
934
+ */
935
+ tags?: TagsMap;
549
936
  }
550
937
  export interface CreateAgentResponse {
938
+ /**
939
+ * Contains details about the agent created.
940
+ */
551
941
  agent: Agent;
552
942
  }
553
943
  export interface CreateDataSourceRequest {
554
- knowledgeBaseId: Id;
944
+ /**
945
+ * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
946
+ */
555
947
  clientToken?: ClientToken;
556
- name: Name;
557
- description?: Description;
948
+ /**
949
+ * Contains metadata about where the data source is stored.
950
+ */
558
951
  dataSourceConfiguration: DataSourceConfiguration;
952
+ /**
953
+ * A description of the data source.
954
+ */
955
+ description?: Description;
956
+ /**
957
+ * The unique identifier of the knowledge base to which to add the data source.
958
+ */
959
+ knowledgeBaseId: Id;
960
+ /**
961
+ * The name of the data source.
962
+ */
963
+ name: Name;
964
+ /**
965
+ * Contains details about the server-side encryption for the data source.
966
+ */
559
967
  serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
968
+ /**
969
+ * Contains details about how to ingest the documents in the data source.
970
+ */
560
971
  vectorIngestionConfiguration?: VectorIngestionConfiguration;
561
972
  }
562
973
  export interface CreateDataSourceResponse {
974
+ /**
975
+ * Contains details about the data source.
976
+ */
563
977
  dataSource: DataSource;
564
978
  }
565
979
  export interface CreateKnowledgeBaseRequest {
980
+ /**
981
+ * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
982
+ */
566
983
  clientToken?: ClientToken;
567
- name: Name;
984
+ /**
985
+ * A description of the knowledge base.
986
+ */
568
987
  description?: Description;
569
- roleArn: KnowledgeBaseRoleArn;
988
+ /**
989
+ * Contains details about the embeddings model used for the knowledge base.
990
+ */
570
991
  knowledgeBaseConfiguration: KnowledgeBaseConfiguration;
992
+ /**
993
+ * A name for the knowledge base.
994
+ */
995
+ name: Name;
996
+ /**
997
+ * The ARN of the IAM role with permissions to create the knowledge base.
998
+ */
999
+ roleArn: KnowledgeBaseRoleArn;
1000
+ /**
1001
+ * Contains details about the configuration of the vector database used for the knowledge base.
1002
+ */
571
1003
  storageConfiguration: StorageConfiguration;
1004
+ /**
1005
+ * Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
1006
+ */
572
1007
  tags?: TagsMap;
573
1008
  }
574
1009
  export interface CreateKnowledgeBaseResponse {
1010
+ /**
1011
+ * Contains details about the knowledge base.
1012
+ */
575
1013
  knowledgeBase: KnowledgeBase;
576
1014
  }
577
1015
  export type CreationMode = "DEFAULT"|"OVERRIDDEN"|string;
578
1016
  export interface DataSource {
579
- knowledgeBaseId: Id;
1017
+ /**
1018
+ * The time at which the data source was created.
1019
+ */
1020
+ createdAt: DateTimestamp;
1021
+ /**
1022
+ * Contains details about how the data source is stored.
1023
+ */
1024
+ dataSourceConfiguration: DataSourceConfiguration;
1025
+ /**
1026
+ * The unique identifier of the data source.
1027
+ */
580
1028
  dataSourceId: Id;
581
- name: Name;
582
- status: DataSourceStatus;
1029
+ /**
1030
+ * The description of the data source.
1031
+ */
583
1032
  description?: Description;
584
- dataSourceConfiguration: DataSourceConfiguration;
1033
+ /**
1034
+ * The unique identifier of the knowledge base to which the data source belongs.
1035
+ */
1036
+ knowledgeBaseId: Id;
1037
+ /**
1038
+ * The name of the data source.
1039
+ */
1040
+ name: Name;
1041
+ /**
1042
+ * Contains details about the configuration of the server-side encryption.
1043
+ */
585
1044
  serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
586
- vectorIngestionConfiguration?: VectorIngestionConfiguration;
587
- createdAt: DateTimestamp;
1045
+ /**
1046
+ * The status of the data source. The following statuses are possible: Available – The data source has been created and is ready for ingestion into the knowledge base. Deleting – The data source is being deleted.
1047
+ */
1048
+ status: DataSourceStatus;
1049
+ /**
1050
+ * The time at which the data source was last updated.
1051
+ */
588
1052
  updatedAt: DateTimestamp;
1053
+ /**
1054
+ * Contains details about how to ingest the documents in the data source.
1055
+ */
1056
+ vectorIngestionConfiguration?: VectorIngestionConfiguration;
589
1057
  }
590
1058
  export interface DataSourceConfiguration {
591
- type: DataSourceType;
1059
+ /**
1060
+ * Contains details about the configuration of the S3 object containing the data source.
1061
+ */
592
1062
  s3Configuration?: S3DataSourceConfiguration;
1063
+ /**
1064
+ * The type of storage for the data source.
1065
+ */
1066
+ type: DataSourceType;
593
1067
  }
594
1068
  export type DataSourceStatus = "AVAILABLE"|"DELETING"|string;
595
1069
  export type DataSourceSummaries = DataSourceSummary[];
596
1070
  export interface DataSourceSummary {
597
- knowledgeBaseId: Id;
1071
+ /**
1072
+ * The unique identifier of the data source.
1073
+ */
598
1074
  dataSourceId: Id;
1075
+ /**
1076
+ * The description of the data source.
1077
+ */
1078
+ description?: Description;
1079
+ /**
1080
+ * The unique identifier of the knowledge base to which the data source belongs.
1081
+ */
1082
+ knowledgeBaseId: Id;
1083
+ /**
1084
+ * The name of the data source.
1085
+ */
599
1086
  name: Name;
1087
+ /**
1088
+ * The status of the data source.
1089
+ */
600
1090
  status: DataSourceStatus;
601
- description?: Description;
1091
+ /**
1092
+ * The time at which the data source was last updated.
1093
+ */
602
1094
  updatedAt: DateTimestamp;
603
1095
  }
604
1096
  export type DataSourceType = "S3"|string;
605
1097
  export type DateTimestamp = Date;
606
1098
  export interface DeleteAgentActionGroupRequest {
607
1099
  /**
608
- * Id generated at the server side when an Agent is created
1100
+ * The unique identifier of the action group to delete.
609
1101
  */
610
- agentId: Id;
1102
+ actionGroupId: Id;
611
1103
  /**
612
- * Draft Version of the Agent.
1104
+ * The unique identifier of the agent that the action group belongs to.
613
1105
  */
614
- agentVersion: DraftVersion;
1106
+ agentId: Id;
615
1107
  /**
616
- * Id generated at the server side when an Agent ActionGroup is created
1108
+ * The version of the agent that the action group belongs to.
617
1109
  */
618
- actionGroupId: Id;
1110
+ agentVersion: DraftVersion;
619
1111
  /**
620
- * Skips checking if resource is in use when set to true. Defaults to false
1112
+ * By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
621
1113
  */
622
1114
  skipResourceInUseCheck?: Boolean;
623
1115
  }
@@ -625,77 +1117,128 @@ declare namespace BedrockAgent {
625
1117
  }
626
1118
  export interface DeleteAgentAliasRequest {
627
1119
  /**
628
- * Id generated at the server side when an Agent is created
1120
+ * The unique identifier of the alias to delete.
629
1121
  */
630
- agentId: Id;
1122
+ agentAliasId: AgentAliasId;
631
1123
  /**
632
- * Id generated at the server side when an Agent Alias is created
1124
+ * The unique identifier of the agent that the alias belongs to.
633
1125
  */
634
- agentAliasId: AgentAliasId;
1126
+ agentId: Id;
635
1127
  }
636
1128
  export interface DeleteAgentAliasResponse {
637
- agentId: Id;
1129
+ /**
1130
+ * The unique identifier of the alias that was deleted.
1131
+ */
638
1132
  agentAliasId: AgentAliasId;
1133
+ /**
1134
+ * The status of the alias.
1135
+ */
639
1136
  agentAliasStatus: AgentAliasStatus;
1137
+ /**
1138
+ * The unique identifier of the agent that the alias belongs to.
1139
+ */
1140
+ agentId: Id;
640
1141
  }
641
1142
  export interface DeleteAgentRequest {
642
1143
  /**
643
- * Id generated at the server side when an Agent is created
1144
+ * The unique identifier of the agent to delete.
644
1145
  */
645
1146
  agentId: Id;
646
1147
  /**
647
- * Skips checking if resource is in use when set to true. Defaults to false
1148
+ * By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
648
1149
  */
649
1150
  skipResourceInUseCheck?: Boolean;
650
1151
  }
651
1152
  export interface DeleteAgentResponse {
1153
+ /**
1154
+ * The unique identifier of the agent that was deleted.
1155
+ */
652
1156
  agentId: Id;
1157
+ /**
1158
+ * The status of the agent.
1159
+ */
653
1160
  agentStatus: AgentStatus;
654
1161
  }
655
1162
  export interface DeleteAgentVersionRequest {
656
1163
  /**
657
- * Id generated at the server side when an Agent is created
1164
+ * The unique identifier of the agent that the version belongs to.
658
1165
  */
659
1166
  agentId: Id;
1167
+ /**
1168
+ * The version of the agent to delete.
1169
+ */
660
1170
  agentVersion: NumericalVersion;
661
1171
  /**
662
- * Skips checking if resource is in use when set to true. Defaults to false
1172
+ * By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.
663
1173
  */
664
1174
  skipResourceInUseCheck?: Boolean;
665
1175
  }
666
1176
  export interface DeleteAgentVersionResponse {
1177
+ /**
1178
+ * The unique identifier of the agent that the version belongs to.
1179
+ */
667
1180
  agentId: Id;
668
- agentVersion: NumericalVersion;
1181
+ /**
1182
+ * The status of the agent version.
1183
+ */
669
1184
  agentStatus: AgentStatus;
1185
+ /**
1186
+ * The version that was deleted.
1187
+ */
1188
+ agentVersion: NumericalVersion;
670
1189
  }
671
1190
  export interface DeleteDataSourceRequest {
672
- knowledgeBaseId: Id;
1191
+ /**
1192
+ * The unique identifier of the data source to delete.
1193
+ */
673
1194
  dataSourceId: Id;
1195
+ /**
1196
+ * The unique identifier of the knowledge base from which to delete the data source.
1197
+ */
1198
+ knowledgeBaseId: Id;
674
1199
  }
675
1200
  export interface DeleteDataSourceResponse {
676
- knowledgeBaseId: Id;
1201
+ /**
1202
+ * The unique identifier of the data source that was deleted.
1203
+ */
677
1204
  dataSourceId: Id;
1205
+ /**
1206
+ * The unique identifier of the knowledge base to which the data source that was deleted belonged.
1207
+ */
1208
+ knowledgeBaseId: Id;
1209
+ /**
1210
+ * The status of the data source.
1211
+ */
678
1212
  status: DataSourceStatus;
679
1213
  }
680
1214
  export interface DeleteKnowledgeBaseRequest {
1215
+ /**
1216
+ * The unique identifier of the knowledge base to delete.
1217
+ */
681
1218
  knowledgeBaseId: Id;
682
1219
  }
683
1220
  export interface DeleteKnowledgeBaseResponse {
1221
+ /**
1222
+ * The unique identifier of the knowledge base that was deleted.
1223
+ */
684
1224
  knowledgeBaseId: Id;
1225
+ /**
1226
+ * The status of the knowledge base and whether it has been successfully deleted.
1227
+ */
685
1228
  status: KnowledgeBaseStatus;
686
1229
  }
687
1230
  export type Description = string;
688
1231
  export interface DisassociateAgentKnowledgeBaseRequest {
689
1232
  /**
690
- * Id generated at the server side when an Agent is created
1233
+ * The unique identifier of the agent from which to disassociate the knowledge base.
691
1234
  */
692
1235
  agentId: Id;
693
1236
  /**
694
- * Draft Version of the Agent.
1237
+ * The version of the agent from which to disassociate the knowledge base.
695
1238
  */
696
1239
  agentVersion: DraftVersion;
697
1240
  /**
698
- * Id generated at the server side when a Knowledge Base is associated to an Agent
1241
+ * The unique identifier of the knowledge base to disassociate.
699
1242
  */
700
1243
  knowledgeBaseId: Id;
701
1244
  }
@@ -707,11 +1250,11 @@ declare namespace BedrockAgent {
707
1250
  export type FieldName = string;
708
1251
  export interface FixedSizeChunkingConfiguration {
709
1252
  /**
710
- * The maximum number of tokens per chunk.
1253
+ * The maximum number of tokens to include in a chunk.
711
1254
  */
712
1255
  maxTokens: FixedSizeChunkingConfigurationMaxTokensInteger;
713
1256
  /**
714
- * The overlap percentage between adjacent chunks.
1257
+ * The percentage of overlap between adjacent chunks of a data source.
715
1258
  */
716
1259
  overlapPercentage: FixedSizeChunkingConfigurationOverlapPercentageInteger;
717
1260
  }
@@ -719,113 +1262,209 @@ declare namespace BedrockAgent {
719
1262
  export type FixedSizeChunkingConfigurationOverlapPercentageInteger = number;
720
1263
  export interface GetAgentActionGroupRequest {
721
1264
  /**
722
- * Id generated at the server side when an Agent is created
1265
+ * The unique identifier of the action group for which to get information.
723
1266
  */
724
- agentId: Id;
1267
+ actionGroupId: Id;
725
1268
  /**
726
- * Version number generated when a version is created
1269
+ * The unique identifier of the agent that the action group belongs to.
727
1270
  */
728
- agentVersion: Version;
1271
+ agentId: Id;
729
1272
  /**
730
- * Id generated at the server side when an Agent Action Group is created
1273
+ * The version of the agent that the action group belongs to.
731
1274
  */
732
- actionGroupId: Id;
1275
+ agentVersion: Version;
733
1276
  }
734
1277
  export interface GetAgentActionGroupResponse {
1278
+ /**
1279
+ * Contains details about the action group.
1280
+ */
735
1281
  agentActionGroup: AgentActionGroup;
736
1282
  }
737
1283
  export interface GetAgentAliasRequest {
738
1284
  /**
739
- * Id generated at the server side when an Agent is created
1285
+ * The unique identifier of the alias for which to get information.
740
1286
  */
741
- agentId: Id;
1287
+ agentAliasId: AgentAliasId;
742
1288
  /**
743
- * Id generated at the server side when an Agent Alias is created
1289
+ * The unique identifier of the agent to which the alias to get information belongs.
744
1290
  */
745
- agentAliasId: AgentAliasId;
1291
+ agentId: Id;
746
1292
  }
747
1293
  export interface GetAgentAliasResponse {
1294
+ /**
1295
+ * Contains information about the alias.
1296
+ */
748
1297
  agentAlias: AgentAlias;
749
1298
  }
750
1299
  export interface GetAgentKnowledgeBaseRequest {
751
1300
  /**
752
- * Id generated at the server side when an Agent is created
1301
+ * The unique identifier of the agent with which the knowledge base is associated.
753
1302
  */
754
1303
  agentId: Id;
755
1304
  /**
756
- * Version number generated when a version is created
1305
+ * The version of the agent with which the knowledge base is associated.
757
1306
  */
758
1307
  agentVersion: Version;
759
1308
  /**
760
- * Id generated at the server side when a Knowledge Base is associated
1309
+ * The unique identifier of the knowledge base associated with the agent.
761
1310
  */
762
1311
  knowledgeBaseId: Id;
763
1312
  }
764
1313
  export interface GetAgentKnowledgeBaseResponse {
1314
+ /**
1315
+ * Contains details about a knowledge base attached to an agent.
1316
+ */
765
1317
  agentKnowledgeBase: AgentKnowledgeBase;
766
1318
  }
767
1319
  export interface GetAgentRequest {
768
1320
  /**
769
- * Id generated at the server side when an Agent is created
1321
+ * The unique identifier of the agent.
770
1322
  */
771
1323
  agentId: Id;
772
1324
  }
773
1325
  export interface GetAgentResponse {
1326
+ /**
1327
+ * Contains details about the agent.
1328
+ */
774
1329
  agent: Agent;
775
1330
  }
776
1331
  export interface GetAgentVersionRequest {
777
1332
  /**
778
- * Id generated at the server side when an Agent is created
1333
+ * The unique identifier of the agent.
779
1334
  */
780
1335
  agentId: Id;
1336
+ /**
1337
+ * The version of the agent.
1338
+ */
781
1339
  agentVersion: NumericalVersion;
782
1340
  }
783
1341
  export interface GetAgentVersionResponse {
1342
+ /**
1343
+ * Contains details about the version of the agent.
1344
+ */
784
1345
  agentVersion: AgentVersion;
785
1346
  }
786
1347
  export interface GetDataSourceRequest {
787
- knowledgeBaseId: Id;
1348
+ /**
1349
+ * The unique identifier of the data source.
1350
+ */
788
1351
  dataSourceId: Id;
1352
+ /**
1353
+ * The unique identifier of the knowledge base that the data source was added to.
1354
+ */
1355
+ knowledgeBaseId: Id;
789
1356
  }
790
1357
  export interface GetDataSourceResponse {
1358
+ /**
1359
+ * Contains details about the data source.
1360
+ */
791
1361
  dataSource: DataSource;
792
1362
  }
793
1363
  export interface GetIngestionJobRequest {
794
- knowledgeBaseId: Id;
1364
+ /**
1365
+ * The unique identifier of the data source in the ingestion job.
1366
+ */
795
1367
  dataSourceId: Id;
1368
+ /**
1369
+ * The unique identifier of the ingestion job.
1370
+ */
796
1371
  ingestionJobId: Id;
1372
+ /**
1373
+ * The unique identifier of the knowledge base for which the ingestion job applies.
1374
+ */
1375
+ knowledgeBaseId: Id;
797
1376
  }
798
1377
  export interface GetIngestionJobResponse {
1378
+ /**
1379
+ * Contains details about the ingestion job.
1380
+ */
799
1381
  ingestionJob: IngestionJob;
800
1382
  }
801
1383
  export interface GetKnowledgeBaseRequest {
1384
+ /**
1385
+ * The unique identifier of the knowledge base for which to get information.
1386
+ */
802
1387
  knowledgeBaseId: Id;
803
1388
  }
804
1389
  export interface GetKnowledgeBaseResponse {
1390
+ /**
1391
+ * Contains details about the knowledge base.
1392
+ */
805
1393
  knowledgeBase: KnowledgeBase;
806
1394
  }
807
1395
  export type Id = string;
808
1396
  export interface InferenceConfiguration {
809
- temperature?: Temperature;
810
- topP?: TopP;
811
- topK?: TopK;
1397
+ /**
1398
+ * The maximum number of tokens to allow in the generated response.
1399
+ */
812
1400
  maximumLength?: MaximumLength;
1401
+ /**
1402
+ * A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
1403
+ */
813
1404
  stopSequences?: StopSequences;
1405
+ /**
1406
+ * The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.
1407
+ */
1408
+ temperature?: Temperature;
1409
+ /**
1410
+ * While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for topK is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topK to 50, the model selects the next token from among the top 50 most likely choices.
1411
+ */
1412
+ topK?: TopK;
1413
+ /**
1414
+ * While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for Top P determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set topP to 80, the model only selects the next token from the top 80% of the probability distribution of next tokens.
1415
+ */
1416
+ topP?: TopP;
814
1417
  }
815
1418
  export interface IngestionJob {
816
- knowledgeBaseId: Id;
1419
+ /**
1420
+ * The unique identifier of the ingested data source.
1421
+ */
817
1422
  dataSourceId: Id;
818
- ingestionJobId: Id;
1423
+ /**
1424
+ * The description of the ingestion job.
1425
+ */
819
1426
  description?: Description;
820
- status: IngestionJobStatus;
821
- statistics?: IngestionJobStatistics;
1427
+ /**
1428
+ * A list of reasons that the ingestion job failed.
1429
+ */
822
1430
  failureReasons?: FailureReasons;
1431
+ /**
1432
+ * The unique identifier of the ingestion job.
1433
+ */
1434
+ ingestionJobId: Id;
1435
+ /**
1436
+ * The unique identifier of the knowledge base to which the data source is being added.
1437
+ */
1438
+ knowledgeBaseId: Id;
1439
+ /**
1440
+ * The time at which the ingestion job started.
1441
+ */
823
1442
  startedAt: DateTimestamp;
1443
+ /**
1444
+ * Contains statistics about the ingestion job.
1445
+ */
1446
+ statistics?: IngestionJobStatistics;
1447
+ /**
1448
+ * The status of the ingestion job.
1449
+ */
1450
+ status: IngestionJobStatus;
1451
+ /**
1452
+ * The time at which the ingestion job was last updated.
1453
+ */
824
1454
  updatedAt: DateTimestamp;
825
1455
  }
826
1456
  export interface IngestionJobFilter {
1457
+ /**
1458
+ * The attribute by which to filter the results.
1459
+ */
827
1460
  attribute: IngestionJobFilterAttribute;
1461
+ /**
1462
+ * The operation to carry out between the attribute and the values.
1463
+ */
828
1464
  operator: IngestionJobFilterOperator;
1465
+ /**
1466
+ * A list of values for the attribute.
1467
+ */
829
1468
  values: IngestionJobFilterValues;
830
1469
  }
831
1470
  export type IngestionJobFilterAttribute = "STATUS"|string;
@@ -834,62 +1473,139 @@ declare namespace BedrockAgent {
834
1473
  export type IngestionJobFilterValues = IngestionJobFilterValue[];
835
1474
  export type IngestionJobFilters = IngestionJobFilter[];
836
1475
  export interface IngestionJobSortBy {
1476
+ /**
1477
+ * The attribute by which to sort the results.
1478
+ */
837
1479
  attribute: IngestionJobSortByAttribute;
1480
+ /**
1481
+ * The order by which to sort the results.
1482
+ */
838
1483
  order: SortOrder;
839
1484
  }
840
1485
  export type IngestionJobSortByAttribute = "STATUS"|"STARTED_AT"|string;
841
1486
  export interface IngestionJobStatistics {
842
1487
  /**
843
- * Number of scanned documents
1488
+ * The number of source documents that was deleted.
1489
+ */
1490
+ numberOfDocumentsDeleted?: PrimitiveLong;
1491
+ /**
1492
+ * The number of source documents that failed to be ingested.
1493
+ */
1494
+ numberOfDocumentsFailed?: PrimitiveLong;
1495
+ /**
1496
+ * The total number of source documents that were scanned. Includes new, updated, and unchanged documents.
844
1497
  */
845
1498
  numberOfDocumentsScanned?: PrimitiveLong;
846
1499
  /**
847
- * Number of indexed documents
1500
+ * The number of metadata files that were updated or deleted.
848
1501
  */
849
- numberOfNewDocumentsIndexed?: PrimitiveLong;
1502
+ numberOfMetadataDocumentsModified?: PrimitiveLong;
850
1503
  /**
851
- * Number of modified documents indexed
1504
+ * The total number of metadata files that were scanned. Includes new, updated, and unchanged files.
852
1505
  */
853
- numberOfModifiedDocumentsIndexed?: PrimitiveLong;
1506
+ numberOfMetadataDocumentsScanned?: PrimitiveLong;
854
1507
  /**
855
- * Number of deleted documents
1508
+ * The number of modified source documents in the data source that were successfully indexed.
856
1509
  */
857
- numberOfDocumentsDeleted?: PrimitiveLong;
1510
+ numberOfModifiedDocumentsIndexed?: PrimitiveLong;
858
1511
  /**
859
- * Number of failed documents
1512
+ * The number of new source documents in the data source that were successfully indexed.
860
1513
  */
861
- numberOfDocumentsFailed?: PrimitiveLong;
1514
+ numberOfNewDocumentsIndexed?: PrimitiveLong;
862
1515
  }
863
1516
  export type IngestionJobStatus = "STARTING"|"IN_PROGRESS"|"COMPLETE"|"FAILED"|string;
864
1517
  export type IngestionJobSummaries = IngestionJobSummary[];
865
1518
  export interface IngestionJobSummary {
866
- knowledgeBaseId: Id;
1519
+ /**
1520
+ * The unique identifier of the data source in the ingestion job.
1521
+ */
867
1522
  dataSourceId: Id;
868
- ingestionJobId: Id;
1523
+ /**
1524
+ * The description of the ingestion job.
1525
+ */
869
1526
  description?: Description;
870
- status: IngestionJobStatus;
1527
+ /**
1528
+ * The unique identifier of the ingestion job.
1529
+ */
1530
+ ingestionJobId: Id;
1531
+ /**
1532
+ * The unique identifier of the knowledge base to which the data source is added.
1533
+ */
1534
+ knowledgeBaseId: Id;
1535
+ /**
1536
+ * The time at which the ingestion job was started.
1537
+ */
871
1538
  startedAt: DateTimestamp;
872
- updatedAt: DateTimestamp;
1539
+ /**
1540
+ * Contains statistics for the ingestion job.
1541
+ */
873
1542
  statistics?: IngestionJobStatistics;
1543
+ /**
1544
+ * The status of the ingestion job.
1545
+ */
1546
+ status: IngestionJobStatus;
1547
+ /**
1548
+ * The time at which the ingestion job was last updated.
1549
+ */
1550
+ updatedAt: DateTimestamp;
874
1551
  }
875
1552
  export type Instruction = string;
876
1553
  export type KmsKeyArn = string;
877
1554
  export interface KnowledgeBase {
1555
+ /**
1556
+ * The time at which the knowledge base was created.
1557
+ */
1558
+ createdAt: DateTimestamp;
1559
+ /**
1560
+ * The description of the knowledge base.
1561
+ */
1562
+ description?: Description;
1563
+ /**
1564
+ * A list of reasons that the API operation on the knowledge base failed.
1565
+ */
1566
+ failureReasons?: FailureReasons;
1567
+ /**
1568
+ * The ARN of the knowledge base.
1569
+ */
1570
+ knowledgeBaseArn: KnowledgeBaseArn;
1571
+ /**
1572
+ * Contains details about the embeddings configuration of the knowledge base.
1573
+ */
1574
+ knowledgeBaseConfiguration: KnowledgeBaseConfiguration;
1575
+ /**
1576
+ * The unique identifier of the knowledge base.
1577
+ */
878
1578
  knowledgeBaseId: Id;
1579
+ /**
1580
+ * The name of the knowledge base.
1581
+ */
879
1582
  name: Name;
880
- knowledgeBaseArn: KnowledgeBaseArn;
881
- description?: Description;
1583
+ /**
1584
+ * The ARN of the IAM role with permissions to invoke API operations on the knowledge base. The ARN must begin with AmazonBedrockExecutionRoleForKnowledgeBase_.
1585
+ */
882
1586
  roleArn: KnowledgeBaseRoleArn;
883
- knowledgeBaseConfiguration: KnowledgeBaseConfiguration;
884
- storageConfiguration: StorageConfiguration;
1587
+ /**
1588
+ * The status of the knowledge base. The following statuses are possible: CREATING – The knowledge base is being created. ACTIVE – The knowledge base is ready to be queried. DELETING – The knowledge base is being deleted. UPDATING – The knowledge base is being updated. FAILED – The knowledge base API operation failed.
1589
+ */
885
1590
  status: KnowledgeBaseStatus;
886
- createdAt: DateTimestamp;
1591
+ /**
1592
+ * Contains details about the storage configuration of the knowledge base.
1593
+ */
1594
+ storageConfiguration: StorageConfiguration;
1595
+ /**
1596
+ * The time at which the knowledge base was last updated.
1597
+ */
887
1598
  updatedAt: DateTimestamp;
888
- failureReasons?: FailureReasons;
889
1599
  }
890
1600
  export type KnowledgeBaseArn = string;
891
1601
  export interface KnowledgeBaseConfiguration {
1602
+ /**
1603
+ * The type of data that the data source is converted into for the knowledge base.
1604
+ */
892
1605
  type: KnowledgeBaseType;
1606
+ /**
1607
+ * Contains details about the embeddings model that'sused to convert the data source.
1608
+ */
893
1609
  vectorKnowledgeBaseConfiguration?: VectorKnowledgeBaseConfiguration;
894
1610
  }
895
1611
  export type KnowledgeBaseRoleArn = string;
@@ -898,111 +1614,243 @@ declare namespace BedrockAgent {
898
1614
  export type KnowledgeBaseStorageType = "OPENSEARCH_SERVERLESS"|"PINECONE"|"REDIS_ENTERPRISE_CLOUD"|"RDS"|string;
899
1615
  export type KnowledgeBaseSummaries = KnowledgeBaseSummary[];
900
1616
  export interface KnowledgeBaseSummary {
1617
+ /**
1618
+ * The description of the knowledge base.
1619
+ */
1620
+ description?: Description;
1621
+ /**
1622
+ * The unique identifier of the knowledge base.
1623
+ */
901
1624
  knowledgeBaseId: Id;
1625
+ /**
1626
+ * The name of the knowledge base.
1627
+ */
902
1628
  name: Name;
903
- description?: Description;
1629
+ /**
1630
+ * The status of the knowledge base.
1631
+ */
904
1632
  status: KnowledgeBaseStatus;
1633
+ /**
1634
+ * The time at which the knowledge base was last updated.
1635
+ */
905
1636
  updatedAt: DateTimestamp;
906
1637
  }
907
1638
  export type KnowledgeBaseType = "VECTOR"|string;
908
1639
  export type LambdaArn = string;
909
1640
  export interface ListAgentActionGroupsRequest {
910
1641
  /**
911
- * Id generated at the server side when an Agent is Listed
1642
+ * The unique identifier of the agent.
912
1643
  */
913
1644
  agentId: Id;
914
1645
  /**
915
- * Id generated at the server side when an Agent is Listed
1646
+ * The version of the agent.
916
1647
  */
917
1648
  agentVersion: Version;
1649
+ /**
1650
+ * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
1651
+ */
918
1652
  maxResults?: MaxResults;
1653
+ /**
1654
+ * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
1655
+ */
919
1656
  nextToken?: NextToken;
920
1657
  }
921
1658
  export interface ListAgentActionGroupsResponse {
1659
+ /**
1660
+ * A list of objects, each of which contains information about an action group.
1661
+ */
922
1662
  actionGroupSummaries: ActionGroupSummaries;
1663
+ /**
1664
+ * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
1665
+ */
923
1666
  nextToken?: NextToken;
924
1667
  }
925
1668
  export interface ListAgentAliasesRequest {
926
1669
  /**
927
- * Id generated at the server side when an Agent is created
1670
+ * The unique identifier of the agent.
928
1671
  */
929
1672
  agentId: Id;
1673
+ /**
1674
+ * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
1675
+ */
930
1676
  maxResults?: MaxResults;
1677
+ /**
1678
+ * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
1679
+ */
931
1680
  nextToken?: NextToken;
932
1681
  }
933
1682
  export interface ListAgentAliasesResponse {
1683
+ /**
1684
+ * A list of objects, each of which contains information about an alias of the agent.
1685
+ */
934
1686
  agentAliasSummaries: AgentAliasSummaries;
1687
+ /**
1688
+ * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
1689
+ */
935
1690
  nextToken?: NextToken;
936
1691
  }
937
1692
  export interface ListAgentKnowledgeBasesRequest {
938
1693
  /**
939
- * Id generated at the server side when an Agent is created
1694
+ * The unique identifier of the agent for which to return information about knowledge bases associated with it.
940
1695
  */
941
1696
  agentId: Id;
942
1697
  /**
943
- * Version number generated when a version is created
1698
+ * The version of the agent for which to return information about knowledge bases associated with it.
944
1699
  */
945
1700
  agentVersion: Version;
1701
+ /**
1702
+ * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
1703
+ */
946
1704
  maxResults?: MaxResults;
1705
+ /**
1706
+ * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
1707
+ */
947
1708
  nextToken?: NextToken;
948
1709
  }
949
1710
  export interface ListAgentKnowledgeBasesResponse {
1711
+ /**
1712
+ * A list of objects, each of which contains information about a knowledge base associated with the agent.
1713
+ */
950
1714
  agentKnowledgeBaseSummaries: AgentKnowledgeBaseSummaries;
1715
+ /**
1716
+ * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
1717
+ */
951
1718
  nextToken?: NextToken;
952
1719
  }
953
1720
  export interface ListAgentVersionsRequest {
954
1721
  /**
955
- * Id generated at the server side when an Agent is created
1722
+ * The unique identifier of the agent.
956
1723
  */
957
1724
  agentId: Id;
1725
+ /**
1726
+ * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
1727
+ */
958
1728
  maxResults?: MaxResults;
1729
+ /**
1730
+ * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
1731
+ */
959
1732
  nextToken?: NextToken;
960
1733
  }
961
1734
  export interface ListAgentVersionsResponse {
1735
+ /**
1736
+ * A list of objects, each of which contains information about a version of the agent.
1737
+ */
962
1738
  agentVersionSummaries: AgentVersionSummaries;
1739
+ /**
1740
+ * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
1741
+ */
963
1742
  nextToken?: NextToken;
964
1743
  }
965
1744
  export interface ListAgentsRequest {
1745
+ /**
1746
+ * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
1747
+ */
966
1748
  maxResults?: MaxResults;
1749
+ /**
1750
+ * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
1751
+ */
967
1752
  nextToken?: NextToken;
968
1753
  }
969
1754
  export interface ListAgentsResponse {
1755
+ /**
1756
+ * A list of objects, each of which contains information about an agent.
1757
+ */
970
1758
  agentSummaries: AgentSummaries;
1759
+ /**
1760
+ * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
1761
+ */
971
1762
  nextToken?: NextToken;
972
1763
  }
973
1764
  export interface ListDataSourcesRequest {
1765
+ /**
1766
+ * The unique identifier of the knowledge base for which to return a list of information.
1767
+ */
974
1768
  knowledgeBaseId: Id;
1769
+ /**
1770
+ * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
1771
+ */
975
1772
  maxResults?: MaxResults;
1773
+ /**
1774
+ * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
1775
+ */
976
1776
  nextToken?: NextToken;
977
1777
  }
978
1778
  export interface ListDataSourcesResponse {
1779
+ /**
1780
+ * A list of objects, each of which contains information about a data source.
1781
+ */
979
1782
  dataSourceSummaries: DataSourceSummaries;
1783
+ /**
1784
+ * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
1785
+ */
980
1786
  nextToken?: NextToken;
981
1787
  }
982
1788
  export interface ListIngestionJobsRequest {
983
- knowledgeBaseId: Id;
1789
+ /**
1790
+ * The unique identifier of the data source for which to return ingestion jobs.
1791
+ */
984
1792
  dataSourceId: Id;
1793
+ /**
1794
+ * Contains a definition of a filter for which to filter the results.
1795
+ */
985
1796
  filters?: IngestionJobFilters;
986
- sortBy?: IngestionJobSortBy;
1797
+ /**
1798
+ * The unique identifier of the knowledge base for which to return ingestion jobs.
1799
+ */
1800
+ knowledgeBaseId: Id;
1801
+ /**
1802
+ * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
1803
+ */
987
1804
  maxResults?: MaxResults;
1805
+ /**
1806
+ * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
1807
+ */
988
1808
  nextToken?: NextToken;
1809
+ /**
1810
+ * Contains details about how to sort the results.
1811
+ */
1812
+ sortBy?: IngestionJobSortBy;
989
1813
  }
990
1814
  export interface ListIngestionJobsResponse {
1815
+ /**
1816
+ * A list of objects, each of which contains information about an ingestion job.
1817
+ */
991
1818
  ingestionJobSummaries: IngestionJobSummaries;
1819
+ /**
1820
+ * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
1821
+ */
992
1822
  nextToken?: NextToken;
993
1823
  }
994
1824
  export interface ListKnowledgeBasesRequest {
1825
+ /**
1826
+ * The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
1827
+ */
995
1828
  maxResults?: MaxResults;
1829
+ /**
1830
+ * If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
1831
+ */
996
1832
  nextToken?: NextToken;
997
1833
  }
998
1834
  export interface ListKnowledgeBasesResponse {
1835
+ /**
1836
+ * A list of objects, each of which contains information about a knowledge base.
1837
+ */
999
1838
  knowledgeBaseSummaries: KnowledgeBaseSummaries;
1839
+ /**
1840
+ * If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.
1841
+ */
1000
1842
  nextToken?: NextToken;
1001
1843
  }
1002
1844
  export interface ListTagsForResourceRequest {
1845
+ /**
1846
+ * The ARN of the resource for which to list tags.
1847
+ */
1003
1848
  resourceArn: TaggableResourcesArn;
1004
1849
  }
1005
1850
  export interface ListTagsForResourceResponse {
1851
+ /**
1852
+ * The key-value pairs for the tags associated with the resource.
1853
+ */
1006
1854
  tags?: TagsMap;
1007
1855
  }
1008
1856
  export type MaxResults = number;
@@ -1013,96 +1861,228 @@ declare namespace BedrockAgent {
1013
1861
  export type NumericalVersion = string;
1014
1862
  export type OpenSearchServerlessCollectionArn = string;
1015
1863
  export interface OpenSearchServerlessConfiguration {
1864
+ /**
1865
+ * The ARN of the OpenSearch Service vector store.
1866
+ */
1016
1867
  collectionArn: OpenSearchServerlessCollectionArn;
1017
- vectorIndexName: OpenSearchServerlessIndexName;
1868
+ /**
1869
+ * Contains the names of the fields to which to map information about the vector store.
1870
+ */
1018
1871
  fieldMapping: OpenSearchServerlessFieldMapping;
1872
+ /**
1873
+ * The name of the vector store.
1874
+ */
1875
+ vectorIndexName: OpenSearchServerlessIndexName;
1019
1876
  }
1020
1877
  export interface OpenSearchServerlessFieldMapping {
1021
- vectorField: FieldName;
1022
- textField: FieldName;
1878
+ /**
1879
+ * The name of the field in which Amazon Bedrock stores metadata about the vector store.
1880
+ */
1023
1881
  metadataField: FieldName;
1882
+ /**
1883
+ * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
1884
+ */
1885
+ textField: FieldName;
1886
+ /**
1887
+ * The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
1888
+ */
1889
+ vectorField: FieldName;
1024
1890
  }
1025
1891
  export type OpenSearchServerlessIndexName = string;
1026
1892
  export type Payload = string;
1027
1893
  export interface PineconeConfiguration {
1894
+ /**
1895
+ * The endpoint URL for your index management page.
1896
+ */
1028
1897
  connectionString: PineconeConnectionString;
1898
+ /**
1899
+ * The ARN of the secret that you created in Secrets Manager that is linked to your Pinecone API key.
1900
+ */
1029
1901
  credentialsSecretArn: SecretArn;
1030
- namespace?: PineconeNamespace;
1902
+ /**
1903
+ * Contains the names of the fields to which to map information about the vector store.
1904
+ */
1031
1905
  fieldMapping: PineconeFieldMapping;
1906
+ /**
1907
+ * The namespace to be used to write new data to your database.
1908
+ */
1909
+ namespace?: PineconeNamespace;
1032
1910
  }
1033
1911
  export type PineconeConnectionString = string;
1034
1912
  export interface PineconeFieldMapping {
1035
- textField: FieldName;
1913
+ /**
1914
+ * The name of the field in which Amazon Bedrock stores metadata about the vector store.
1915
+ */
1036
1916
  metadataField: FieldName;
1917
+ /**
1918
+ * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
1919
+ */
1920
+ textField: FieldName;
1037
1921
  }
1038
1922
  export type PineconeNamespace = string;
1039
1923
  export interface PrepareAgentRequest {
1040
1924
  /**
1041
- * Id generated at the server side when an Agent is created
1925
+ * The unique identifier of the agent for which to create a DRAFT version.
1042
1926
  */
1043
1927
  agentId: Id;
1044
1928
  }
1045
1929
  export interface PrepareAgentResponse {
1930
+ /**
1931
+ * The unique identifier of the agent for which the DRAFT version was created.
1932
+ */
1046
1933
  agentId: Id;
1934
+ /**
1935
+ * The status of the DRAFT version and whether it is ready for use.
1936
+ */
1047
1937
  agentStatus: AgentStatus;
1938
+ /**
1939
+ * The version of the agent.
1940
+ */
1048
1941
  agentVersion: Version;
1942
+ /**
1943
+ * The time at which the DRAFT version of the agent was last prepared.
1944
+ */
1049
1945
  preparedAt: DateTimestamp;
1050
1946
  }
1051
1947
  export type PrimitiveLong = number;
1052
1948
  export interface PromptConfiguration {
1053
- promptType?: PromptType;
1054
- promptCreationMode?: CreationMode;
1055
- promptState?: PromptState;
1949
+ /**
1950
+ * Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables.
1951
+ */
1056
1952
  basePromptTemplate?: BasePromptTemplate;
1953
+ /**
1954
+ * Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.
1955
+ */
1057
1956
  inferenceConfiguration?: InferenceConfiguration;
1957
+ /**
1958
+ * Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.
1959
+ */
1058
1960
  parserMode?: CreationMode;
1961
+ /**
1962
+ * Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.
1963
+ */
1964
+ promptCreationMode?: CreationMode;
1965
+ /**
1966
+ * Specifies whether to allow the agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows. PRE_PROCESSING – ENABLED ORCHESTRATION – ENABLED KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED POST_PROCESSING – DISABLED
1967
+ */
1968
+ promptState?: PromptState;
1969
+ /**
1970
+ * The step in the agent sequence that this prompt configuration applies to.
1971
+ */
1972
+ promptType?: PromptType;
1059
1973
  }
1060
1974
  export type PromptConfigurations = PromptConfiguration[];
1061
1975
  export interface PromptOverrideConfiguration {
1062
- promptConfigurations: PromptConfigurations;
1976
+ /**
1977
+ * The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the promptConfigurations must contain a parserMode value that is set to OVERRIDDEN.
1978
+ */
1063
1979
  overrideLambda?: LambdaArn;
1980
+ /**
1981
+ * Contains configurations to override a prompt template in one part of an agent sequence. For more information, see Advanced prompts.
1982
+ */
1983
+ promptConfigurations: PromptConfigurations;
1064
1984
  }
1065
1985
  export type PromptState = "ENABLED"|"DISABLED"|string;
1066
1986
  export type PromptType = "PRE_PROCESSING"|"ORCHESTRATION"|"POST_PROCESSING"|"KNOWLEDGE_BASE_RESPONSE_GENERATION"|string;
1067
1987
  export type RdsArn = string;
1068
1988
  export interface RdsConfiguration {
1069
- resourceArn: RdsArn;
1989
+ /**
1990
+ * The ARN of the secret that you created in Secrets Manager that is linked to your Amazon RDS database.
1991
+ */
1070
1992
  credentialsSecretArn: SecretArn;
1993
+ /**
1994
+ * The name of your Amazon RDS database.
1995
+ */
1071
1996
  databaseName: RdsDatabaseName;
1072
- tableName: RdsTableName;
1997
+ /**
1998
+ * Contains the names of the fields to which to map information about the vector store.
1999
+ */
1073
2000
  fieldMapping: RdsFieldMapping;
2001
+ /**
2002
+ * The ARN of the vector store.
2003
+ */
2004
+ resourceArn: RdsArn;
2005
+ /**
2006
+ * The name of the table in the database.
2007
+ */
2008
+ tableName: RdsTableName;
1074
2009
  }
1075
2010
  export type RdsDatabaseName = string;
1076
2011
  export interface RdsFieldMapping {
2012
+ /**
2013
+ * The name of the field in which Amazon Bedrock stores metadata about the vector store.
2014
+ */
2015
+ metadataField: ColumnName;
2016
+ /**
2017
+ * The name of the field in which Amazon Bedrock stores the ID for each entry.
2018
+ */
1077
2019
  primaryKeyField: ColumnName;
1078
- vectorField: ColumnName;
2020
+ /**
2021
+ * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
2022
+ */
1079
2023
  textField: ColumnName;
1080
- metadataField: ColumnName;
2024
+ /**
2025
+ * The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
2026
+ */
2027
+ vectorField: ColumnName;
1081
2028
  }
1082
2029
  export type RdsTableName = string;
1083
2030
  export type RecommendedAction = string;
1084
2031
  export type RecommendedActions = RecommendedAction[];
1085
2032
  export interface RedisEnterpriseCloudConfiguration {
1086
- endpoint: RedisEnterpriseCloudEndpoint;
1087
- vectorIndexName: RedisEnterpriseCloudIndexName;
2033
+ /**
2034
+ * The ARN of the secret that you created in Secrets Manager that is linked to your Redis Enterprise Cloud database.
2035
+ */
1088
2036
  credentialsSecretArn: SecretArn;
2037
+ /**
2038
+ * The endpoint URL of the Redis Enterprise Cloud database.
2039
+ */
2040
+ endpoint: RedisEnterpriseCloudEndpoint;
2041
+ /**
2042
+ * Contains the names of the fields to which to map information about the vector store.
2043
+ */
1089
2044
  fieldMapping: RedisEnterpriseCloudFieldMapping;
2045
+ /**
2046
+ * The name of the vector index.
2047
+ */
2048
+ vectorIndexName: RedisEnterpriseCloudIndexName;
1090
2049
  }
1091
2050
  export type RedisEnterpriseCloudEndpoint = string;
1092
2051
  export interface RedisEnterpriseCloudFieldMapping {
1093
- vectorField: FieldName;
1094
- textField: FieldName;
2052
+ /**
2053
+ * The name of the field in which Amazon Bedrock stores metadata about the vector store.
2054
+ */
1095
2055
  metadataField: FieldName;
2056
+ /**
2057
+ * The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.
2058
+ */
2059
+ textField: FieldName;
2060
+ /**
2061
+ * The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.
2062
+ */
2063
+ vectorField: FieldName;
1096
2064
  }
1097
2065
  export type RedisEnterpriseCloudIndexName = string;
1098
2066
  export type S3BucketArn = string;
1099
2067
  export type S3BucketName = string;
1100
2068
  export interface S3DataSourceConfiguration {
2069
+ /**
2070
+ * The ARN of the bucket that contains the data source.
2071
+ */
1101
2072
  bucketArn: S3BucketArn;
2073
+ /**
2074
+ * A list of S3 prefixes that define the object containing the data sources. For more information, see Organizing objects using prefixes.
2075
+ */
1102
2076
  inclusionPrefixes?: S3Prefixes;
1103
2077
  }
1104
2078
  export interface S3Identifier {
2079
+ /**
2080
+ * The name of the S3 bucket.
2081
+ */
1105
2082
  s3BucketName?: S3BucketName;
2083
+ /**
2084
+ * The S3 object key containing the resource.
2085
+ */
1106
2086
  s3ObjectKey?: S3ObjectKey;
1107
2087
  }
1108
2088
  export type S3ObjectKey = string;
@@ -1110,32 +2090,71 @@ declare namespace BedrockAgent {
1110
2090
  export type S3Prefixes = S3Prefix[];
1111
2091
  export type SecretArn = string;
1112
2092
  export interface ServerSideEncryptionConfiguration {
2093
+ /**
2094
+ * The ARN of the KMS key used to encrypt the resource.
2095
+ */
1113
2096
  kmsKeyArn?: KmsKeyArn;
1114
2097
  }
1115
2098
  export type SessionTTL = number;
1116
2099
  export type SortOrder = "ASCENDING"|"DESCENDING"|string;
1117
2100
  export interface StartIngestionJobRequest {
1118
- knowledgeBaseId: Id;
1119
- dataSourceId: Id;
2101
+ /**
2102
+ * A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
2103
+ */
1120
2104
  clientToken?: ClientToken;
2105
+ /**
2106
+ * The unique identifier of the data source to ingest.
2107
+ */
2108
+ dataSourceId: Id;
2109
+ /**
2110
+ * A description of the ingestion job.
2111
+ */
1121
2112
  description?: Description;
2113
+ /**
2114
+ * The unique identifier of the knowledge base to which to add the data source.
2115
+ */
2116
+ knowledgeBaseId: Id;
1122
2117
  }
1123
2118
  export interface StartIngestionJobResponse {
2119
+ /**
2120
+ * An object containing information about the ingestion job.
2121
+ */
1124
2122
  ingestionJob: IngestionJob;
1125
2123
  }
1126
2124
  export type StopSequences = String[];
1127
2125
  export interface StorageConfiguration {
1128
- type: KnowledgeBaseStorageType;
2126
+ /**
2127
+ * Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
2128
+ */
1129
2129
  opensearchServerlessConfiguration?: OpenSearchServerlessConfiguration;
2130
+ /**
2131
+ * Contains the storage configuration of the knowledge base in Pinecone.
2132
+ */
1130
2133
  pineconeConfiguration?: PineconeConfiguration;
1131
- redisEnterpriseCloudConfiguration?: RedisEnterpriseCloudConfiguration;
2134
+ /**
2135
+ * Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.
2136
+ */
1132
2137
  rdsConfiguration?: RdsConfiguration;
2138
+ /**
2139
+ * Contains the storage configuration of the knowledge base in Redis Enterprise Cloud.
2140
+ */
2141
+ redisEnterpriseCloudConfiguration?: RedisEnterpriseCloudConfiguration;
2142
+ /**
2143
+ * The vector store service in which the knowledge base is stored.
2144
+ */
2145
+ type: KnowledgeBaseStorageType;
1133
2146
  }
1134
2147
  export type String = string;
1135
2148
  export type TagKey = string;
1136
2149
  export type TagKeyList = TagKey[];
1137
2150
  export interface TagResourceRequest {
2151
+ /**
2152
+ * The ARN of the resource to tag.
2153
+ */
1138
2154
  resourceArn: TaggableResourcesArn;
2155
+ /**
2156
+ * An object containing key-value pairs that define the tags to attach to the resource.
2157
+ */
1139
2158
  tags: TagsMap;
1140
2159
  }
1141
2160
  export interface TagResourceResponse {
@@ -1147,113 +2166,239 @@ declare namespace BedrockAgent {
1147
2166
  export type TopK = number;
1148
2167
  export type TopP = number;
1149
2168
  export interface UntagResourceRequest {
2169
+ /**
2170
+ * The ARN of the resource from which to remove tags.
2171
+ */
1150
2172
  resourceArn: TaggableResourcesArn;
2173
+ /**
2174
+ * A list of keys of the tags to remove from the resource.
2175
+ */
1151
2176
  tagKeys: TagKeyList;
1152
2177
  }
1153
2178
  export interface UntagResourceResponse {
1154
2179
  }
1155
2180
  export interface UpdateAgentActionGroupRequest {
1156
2181
  /**
1157
- * Id generated at the server side when an Agent is created
2182
+ * The ARN of the Lambda function containing the business logic that is carried out upon invoking the action.
2183
+ */
2184
+ actionGroupExecutor?: ActionGroupExecutor;
2185
+ /**
2186
+ * The unique identifier of the action group.
2187
+ */
2188
+ actionGroupId: Id;
2189
+ /**
2190
+ * Specifies a new name for the action group.
2191
+ */
2192
+ actionGroupName: Name;
2193
+ /**
2194
+ * Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.
2195
+ */
2196
+ actionGroupState?: ActionGroupState;
2197
+ /**
2198
+ * The unique identifier of the agent for which to update the action group.
1158
2199
  */
1159
2200
  agentId: Id;
1160
2201
  /**
1161
- * Draft Version of the Agent.
2202
+ * The unique identifier of the agent version for which to update the action group.
1162
2203
  */
1163
2204
  agentVersion: DraftVersion;
1164
2205
  /**
1165
- * Id generated at the server side when an Action Group is created under Agent
2206
+ * Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.
2207
+ */
2208
+ apiSchema?: APISchema;
2209
+ /**
2210
+ * Specifies a new name for the action group.
1166
2211
  */
1167
- actionGroupId: Id;
1168
- actionGroupName: Name;
1169
2212
  description?: Description;
2213
+ /**
2214
+ * To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor 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 Observation reprompting the user for more information.
2215
+ */
1170
2216
  parentActionGroupSignature?: ActionGroupSignature;
1171
- actionGroupExecutor?: ActionGroupExecutor;
1172
- actionGroupState?: ActionGroupState;
1173
- apiSchema?: APISchema;
1174
2217
  }
1175
2218
  export interface UpdateAgentActionGroupResponse {
2219
+ /**
2220
+ * Contains details about the action group that was updated.
2221
+ */
1176
2222
  agentActionGroup: AgentActionGroup;
1177
2223
  }
1178
2224
  export interface UpdateAgentAliasRequest {
1179
2225
  /**
1180
- * Id generated at the server side when an Agent is created
2226
+ * The unique identifier of the alias.
1181
2227
  */
1182
- agentId: Id;
2228
+ agentAliasId: AgentAliasId;
1183
2229
  /**
1184
- * Id generated at the server side when an Agent Alias is created
2230
+ * Specifies a new name for the alias.
1185
2231
  */
1186
- agentAliasId: AgentAliasId;
1187
2232
  agentAliasName: Name;
2233
+ /**
2234
+ * The unique identifier of the agent.
2235
+ */
2236
+ agentId: Id;
2237
+ /**
2238
+ * Specifies a new description for the alias.
2239
+ */
1188
2240
  description?: Description;
2241
+ /**
2242
+ * Contains details about the routing configuration of the alias.
2243
+ */
1189
2244
  routingConfiguration?: AgentAliasRoutingConfiguration;
1190
2245
  }
1191
2246
  export interface UpdateAgentAliasResponse {
2247
+ /**
2248
+ * Contains details about the alias that was updated.
2249
+ */
1192
2250
  agentAlias: AgentAlias;
1193
2251
  }
1194
2252
  export interface UpdateAgentKnowledgeBaseRequest {
1195
2253
  /**
1196
- * Id generated at the server side when an Agent is created
2254
+ * The unique identifier of the agent associated with the knowledge base that you want to update.
1197
2255
  */
1198
2256
  agentId: Id;
1199
2257
  /**
1200
- * Draft Version of the Agent.
2258
+ * The version of the agent associated with the knowledge base that you want to update.
1201
2259
  */
1202
2260
  agentVersion: DraftVersion;
1203
2261
  /**
1204
- * Id generated at the server side when a Knowledge Base is associated to an Agent
2262
+ * Specifies a new description for the knowledge base associated with an agent.
1205
2263
  */
1206
- knowledgeBaseId: Id;
1207
2264
  description?: Description;
2265
+ /**
2266
+ * The unique identifier of the knowledge base that has been associated with an agent.
2267
+ */
2268
+ knowledgeBaseId: Id;
2269
+ /**
2270
+ * Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.
2271
+ */
1208
2272
  knowledgeBaseState?: KnowledgeBaseState;
1209
2273
  }
1210
2274
  export interface UpdateAgentKnowledgeBaseResponse {
2275
+ /**
2276
+ * Contains details about the knowledge base that has been associated with an agent.
2277
+ */
1211
2278
  agentKnowledgeBase: AgentKnowledgeBase;
1212
2279
  }
1213
2280
  export interface UpdateAgentRequest {
1214
2281
  /**
1215
- * Id generated at the server side when an Agent is created
2282
+ * The unique identifier of the agent.
1216
2283
  */
1217
2284
  agentId: Id;
2285
+ /**
2286
+ * Specifies a new name for the agent.
2287
+ */
1218
2288
  agentName: Name;
1219
- instruction?: Instruction;
1220
- foundationModel?: ModelIdentifier;
1221
- description?: Description;
1222
- idleSessionTTLInSeconds?: SessionTTL;
2289
+ /**
2290
+ * The ARN of the IAM role with permissions to update the agent. The ARN must begin with AmazonBedrockExecutionRoleForAgents_.
2291
+ */
1223
2292
  agentResourceRoleArn: AgentRoleArn;
2293
+ /**
2294
+ * The ARN of the KMS key with which to encrypt the agent.
2295
+ */
1224
2296
  customerEncryptionKeyArn?: KmsKeyArn;
2297
+ /**
2298
+ * Specifies a new description of the agent.
2299
+ */
2300
+ description?: Description;
2301
+ /**
2302
+ * Specifies a new foundation model to be used for orchestration by the agent.
2303
+ */
2304
+ foundationModel: ModelIdentifier;
2305
+ /**
2306
+ * The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent. A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.
2307
+ */
2308
+ idleSessionTTLInSeconds?: SessionTTL;
2309
+ /**
2310
+ * Specifies new instructions that tell the agent what it should do and how it should interact with users.
2311
+ */
2312
+ instruction?: Instruction;
2313
+ /**
2314
+ * Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
2315
+ */
1225
2316
  promptOverrideConfiguration?: PromptOverrideConfiguration;
1226
2317
  }
1227
2318
  export interface UpdateAgentResponse {
2319
+ /**
2320
+ * Contains details about the agent that was updated.
2321
+ */
1228
2322
  agent: Agent;
1229
2323
  }
1230
2324
  export interface UpdateDataSourceRequest {
1231
- knowledgeBaseId: Id;
2325
+ /**
2326
+ * Contains details about the storage configuration of the data source.
2327
+ */
2328
+ dataSourceConfiguration: DataSourceConfiguration;
2329
+ /**
2330
+ * The unique identifier of the data source.
2331
+ */
1232
2332
  dataSourceId: Id;
1233
- name: Name;
2333
+ /**
2334
+ * Specifies a new description for the data source.
2335
+ */
1234
2336
  description?: Description;
1235
- dataSourceConfiguration: DataSourceConfiguration;
2337
+ /**
2338
+ * The unique identifier of the knowledge base to which the data source belongs.
2339
+ */
2340
+ knowledgeBaseId: Id;
2341
+ /**
2342
+ * Specifies a new name for the data source.
2343
+ */
2344
+ name: Name;
2345
+ /**
2346
+ * Contains details about server-side encryption of the data source.
2347
+ */
1236
2348
  serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
2349
+ /**
2350
+ * Contains details about how to ingest the documents in the data source.
2351
+ */
1237
2352
  vectorIngestionConfiguration?: VectorIngestionConfiguration;
1238
2353
  }
1239
2354
  export interface UpdateDataSourceResponse {
2355
+ /**
2356
+ * Contains details about the data source.
2357
+ */
1240
2358
  dataSource: DataSource;
1241
2359
  }
1242
2360
  export interface UpdateKnowledgeBaseRequest {
2361
+ /**
2362
+ * Specifies a new description for the knowledge base.
2363
+ */
2364
+ description?: Description;
2365
+ /**
2366
+ * Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.
2367
+ */
2368
+ knowledgeBaseConfiguration: KnowledgeBaseConfiguration;
2369
+ /**
2370
+ * The unique identifier of the knowledge base to update.
2371
+ */
1243
2372
  knowledgeBaseId: Id;
2373
+ /**
2374
+ * Specifies a new name for the knowledge base.
2375
+ */
1244
2376
  name: Name;
1245
- description?: Description;
2377
+ /**
2378
+ * Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to modify the knowledge base.
2379
+ */
1246
2380
  roleArn: KnowledgeBaseRoleArn;
1247
- knowledgeBaseConfiguration: KnowledgeBaseConfiguration;
2381
+ /**
2382
+ * Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.
2383
+ */
1248
2384
  storageConfiguration: StorageConfiguration;
1249
2385
  }
1250
2386
  export interface UpdateKnowledgeBaseResponse {
2387
+ /**
2388
+ * Contains details about the knowledge base.
2389
+ */
1251
2390
  knowledgeBase: KnowledgeBase;
1252
2391
  }
1253
2392
  export interface VectorIngestionConfiguration {
2393
+ /**
2394
+ * Details about how to chunk the documents in the data source. A chunk refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried.
2395
+ */
1254
2396
  chunkingConfiguration?: ChunkingConfiguration;
1255
2397
  }
1256
2398
  export interface VectorKnowledgeBaseConfiguration {
2399
+ /**
2400
+ * The ARN of the model used to create vector embeddings for the knowledge base.
2401
+ */
1257
2402
  embeddingModelArn: BedrockEmbeddingModelArn;
1258
2403
  }
1259
2404
  export type Version = string;