@@ -12,10 +12,6 @@ Deploy a Bedrock Agent.
12
12
13
13
↳ ** ` Agent ` **
14
14
15
- ## Implements
16
-
17
- - ` ITaggableV2 `
18
-
19
15
## Table of contents
20
16
21
17
### Constructors
@@ -24,23 +20,28 @@ Deploy a Bedrock Agent.
24
20
25
21
### Properties
26
22
23
+ - [ actionGroups] ( bedrock.Agent.md#actiongroups )
27
24
- [ agentArn] ( bedrock.Agent.md#agentarn )
28
25
- [ agentId] ( bedrock.Agent.md#agentid )
26
+ - [ agentInstance] ( bedrock.Agent.md#agentinstance )
27
+ - [ agentversion] ( bedrock.Agent.md#agentversion )
29
28
- [ aliasArn] ( bedrock.Agent.md#aliasarn )
30
29
- [ aliasId] ( bedrock.Agent.md#aliasid )
31
30
- [ aliasName] ( bedrock.Agent.md#aliasname )
32
- - [ cdkTagManager ] ( bedrock.Agent.md#cdktagmanager )
31
+ - [ knowledgeBases ] ( bedrock.Agent.md#knowledgebases )
33
32
- [ name] ( bedrock.Agent.md#name )
34
33
- [ node] ( bedrock.Agent.md#node )
35
34
- [ resourceUpdates] ( bedrock.Agent.md#resourceupdates )
36
35
- [ role] ( bedrock.Agent.md#role )
37
- - [ shouldPrepareAgent] ( bedrock.Agent.md#shouldprepareagent )
38
36
39
37
### Methods
40
38
41
39
- [ \_ addAliasDependency] ( bedrock.Agent.md#_addaliasdependency )
42
40
- [ addActionGroup] ( bedrock.Agent.md#addactiongroup )
41
+ - [ addActionGroups] ( bedrock.Agent.md#addactiongroups )
43
42
- [ addAlias] ( bedrock.Agent.md#addalias )
43
+ - [ addKnowledgeBase] ( bedrock.Agent.md#addknowledgebase )
44
+ - [ addKnowledgeBases] ( bedrock.Agent.md#addknowledgebases )
44
45
- [ toString] ( bedrock.Agent.md#tostring )
45
46
- [ isConstruct] ( bedrock.Agent.md#isconstruct )
46
47
@@ -68,6 +69,14 @@ Construct.constructor
68
69
69
70
## Properties
70
71
72
+ ### actionGroups
73
+
74
+ • ` Private ` ** actionGroups** : ` AgentActionGroupProperty ` [ ] = ` [] `
75
+
76
+ A list of action groups associated with the agent
77
+
78
+ ___
79
+
71
80
### agentArn
72
81
73
82
• ` Readonly ` ** agentArn** : ` string `
@@ -84,6 +93,22 @@ The unique identifier of the agent.
84
93
85
94
___
86
95
96
+ ### agentInstance
97
+
98
+ • ` Readonly ` ** agentInstance** : ` CfnAgent `
99
+
100
+ Instance of Agent
101
+
102
+ ___
103
+
104
+ ### agentversion
105
+
106
+ • ` Readonly ` ** agentversion** : ` string `
107
+
108
+ The version for the agent
109
+
110
+ ___
111
+
87
112
### aliasArn
88
113
89
114
• ` Optional ` ` Readonly ` ** aliasArn** : ` string `
@@ -108,15 +133,17 @@ The name for the agent alias.
108
133
109
134
___
110
135
111
- ### cdkTagManager
136
+ ### knowledgeBases
112
137
113
- • ` Readonly ` ** cdkTagManager ** : ` TagManager `
138
+ • ** knowledgeBases ** : ` AgentKnowledgeBaseProperty ` [ ] = ` [] `
114
139
115
- TagManager facilitates a common implementation of tagging for Constructs
140
+ A list of KnowledgeBases associated with the agent.
116
141
117
- #### Implementation of
142
+ ** ` Default ` **
118
143
119
- cdk.ITaggableV2.cdkTagManager
144
+ ``` ts
145
+ - No knowledge base is used .
146
+ ```
120
147
121
148
___
122
149
154
181
155
182
The IAM role for the agent.
156
183
157
- ___
158
-
159
- ### shouldPrepareAgent
160
-
161
- • ` Private ` ` Readonly ` ** shouldPrepareAgent** : ` boolean `
162
-
163
- If prepare agent should be called on resource updates.
164
-
165
184
## Methods
166
185
167
186
### \_ addAliasDependency
@@ -184,19 +203,37 @@ ___
184
203
185
204
### addActionGroup
186
205
187
- ▸ ** addActionGroup** (` props ` ): [ ` AgentActionGroup ` ] ( bedrock.AgentActionGroup.md )
206
+ ▸ ** addActionGroup** (` actionGroup ` ): ` void `
188
207
189
- Add an action group to the agent.
208
+ Add action group to the agent.
190
209
191
210
#### Parameters
192
211
193
212
| Name | Type |
194
213
| :------ | :------ |
195
- | ` props ` | [ ` AddAgentActionGroupProps ` ] ( ../interfaces/ bedrock.AddAgentActionGroupProps .md) |
214
+ | ` actionGroup ` | [ ` AgentActionGroup ` ] ( bedrock.AgentActionGroup .md ) |
196
215
197
216
#### Returns
198
217
199
- [ ` AgentActionGroup ` ] ( bedrock.AgentActionGroup.md )
218
+ ` void `
219
+
220
+ ___
221
+
222
+ ### addActionGroups
223
+
224
+ ▸ ** addActionGroups** (` actionGroups ` ): ` void `
225
+
226
+ Add action groups to the agent.
227
+
228
+ #### Parameters
229
+
230
+ | Name | Type |
231
+ | :------ | :------ |
232
+ | ` actionGroups ` | [ ` AgentActionGroup ` ] ( bedrock.AgentActionGroup.md ) [ ] |
233
+
234
+ #### Returns
235
+
236
+ ` void `
200
237
201
238
___
202
239
@@ -218,6 +255,42 @@ Add an alias to the agent.
218
255
219
256
___
220
257
258
+ ### addKnowledgeBase
259
+
260
+ ▸ ** addKnowledgeBase** (` knowledgeBase ` ): ` void `
261
+
262
+ Add knowledge base to the agent.
263
+
264
+ #### Parameters
265
+
266
+ | Name | Type |
267
+ | :------ | :------ |
268
+ | ` knowledgeBase ` | [ ` KnowledgeBase ` ] ( bedrock.KnowledgeBase.md ) |
269
+
270
+ #### Returns
271
+
272
+ ` void `
273
+
274
+ ___
275
+
276
+ ### addKnowledgeBases
277
+
278
+ ▸ ** addKnowledgeBases** (` knowledgeBases ` ): ` void `
279
+
280
+ Add knowledge bases to the agent.
281
+
282
+ #### Parameters
283
+
284
+ | Name | Type |
285
+ | :------ | :------ |
286
+ | ` knowledgeBases ` | [ ` KnowledgeBase ` ] ( bedrock.KnowledgeBase.md ) [ ] |
287
+
288
+ #### Returns
289
+
290
+ ` void `
291
+
292
+ ___
293
+
221
294
### toString
222
295
223
296
▸ ** toString** (): ` string `
0 commit comments