@aws-sdk/client-bedrock-agent 3.686.0 → 3.687.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -0
- package/dist-cjs/index.js +516 -49
- package/dist-es/BedrockAgent.js +2 -0
- package/dist-es/commands/CreatePromptCommand.js +1 -1
- package/dist-es/commands/CreatePromptVersionCommand.js +1 -1
- package/dist-es/commands/GetAgentVersionCommand.js +1 -1
- package/dist-es/commands/GetPromptCommand.js +1 -1
- package/dist-es/commands/UpdatePromptCommand.js +1 -1
- package/dist-es/commands/ValidateFlowDefinitionCommand.js +23 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +239 -41
- package/dist-es/models/models_1.js +69 -0
- package/dist-es/protocols/Aws_restJson1.js +141 -5
- package/dist-types/BedrockAgent.d.ts +7 -0
- package/dist-types/BedrockAgentClient.d.ts +3 -2
- package/dist-types/commands/CreateFlowCommand.d.ts +102 -2
- package/dist-types/commands/CreateFlowVersionCommand.d.ts +51 -1
- package/dist-types/commands/CreatePromptCommand.d.ts +97 -3
- package/dist-types/commands/CreatePromptVersionCommand.d.ts +49 -2
- package/dist-types/commands/DeleteAgentVersionCommand.d.ts +1 -1
- package/dist-types/commands/DeletePromptCommand.d.ts +1 -1
- package/dist-types/commands/GetAgentVersionCommand.d.ts +1 -1
- package/dist-types/commands/GetFlowCommand.d.ts +137 -1
- package/dist-types/commands/GetFlowVersionCommand.d.ts +51 -1
- package/dist-types/commands/GetPromptCommand.d.ts +49 -2
- package/dist-types/commands/ListAgentKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/commands/ListAgentVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/commands/ListPromptsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFlowCommand.d.ts +102 -2
- package/dist-types/commands/UpdateKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePromptCommand.d.ts +97 -3
- package/dist-types/commands/ValidateFlowDefinitionCommand.d.ts +335 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +2060 -1356
- package/dist-types/models/models_1.d.ts +974 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/BedrockAgent.d.ts +17 -0
- package/dist-types/ts3.4/BedrockAgentClient.d.ts +8 -2
- package/dist-types/ts3.4/commands/CreatePromptCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreatePromptVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteAgentVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeletePromptCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetAgentVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetPromptCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAgentKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAgentVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPromptsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAgentKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePromptCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ValidateFlowDefinitionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +1109 -229
- package/dist-types/ts3.4/models/models_1.d.ts +287 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +6 -6
|
@@ -0,0 +1,974 @@
|
|
|
1
|
+
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
+
import { AgentKnowledgeBase, AgentKnowledgeBaseSummary, AgentStatus, AgentVersion, AgentVersionSummary, FlowDefinition, FlowValidation, KnowledgeBase, KnowledgeBaseConfiguration, KnowledgeBaseState, KnowledgeBaseStatus, PromptInferenceConfiguration, PromptTemplateConfiguration, PromptTemplateType, StorageConfiguration } from "./models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface ListAgentKnowledgeBasesRequest {
|
|
7
|
+
/**
|
|
8
|
+
* <p>The unique identifier of the agent for which to return information about knowledge bases associated with it.</p>
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
agentId: string | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* <p>The version of the agent for which to return information about knowledge bases associated with it.</p>
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
agentVersion: string | undefined;
|
|
17
|
+
/**
|
|
18
|
+
* <p>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 <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
maxResults?: number;
|
|
22
|
+
/**
|
|
23
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
nextToken?: string;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
export interface ListAgentKnowledgeBasesResponse {
|
|
32
|
+
/**
|
|
33
|
+
* <p>A list of objects, each of which contains information about a knowledge base associated with the agent.</p>
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
agentKnowledgeBaseSummaries: AgentKnowledgeBaseSummary[] | undefined;
|
|
37
|
+
/**
|
|
38
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
41
|
+
nextToken?: string;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* @public
|
|
45
|
+
*/
|
|
46
|
+
export interface ListKnowledgeBasesRequest {
|
|
47
|
+
/**
|
|
48
|
+
* <p>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 <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
49
|
+
* @public
|
|
50
|
+
*/
|
|
51
|
+
maxResults?: number;
|
|
52
|
+
/**
|
|
53
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
nextToken?: string;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* <p>Contains details about a knowledge base.</p>
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
62
|
+
export interface KnowledgeBaseSummary {
|
|
63
|
+
/**
|
|
64
|
+
* <p>The unique identifier of the knowledge base.</p>
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
knowledgeBaseId: string | undefined;
|
|
68
|
+
/**
|
|
69
|
+
* <p>The name of the knowledge base.</p>
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
name: string | undefined;
|
|
73
|
+
/**
|
|
74
|
+
* <p>The description of the knowledge base.</p>
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
description?: string;
|
|
78
|
+
/**
|
|
79
|
+
* <p>The status of the knowledge base.</p>
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
status: KnowledgeBaseStatus | undefined;
|
|
83
|
+
/**
|
|
84
|
+
* <p>The time the knowledge base was last updated.</p>
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
updatedAt: Date | undefined;
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export interface ListKnowledgeBasesResponse {
|
|
93
|
+
/**
|
|
94
|
+
* <p>A list of knowledge bases with information about each knowledge base.</p>
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
|
|
98
|
+
/**
|
|
99
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
nextToken?: string;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
export interface UpdateAgentKnowledgeBaseRequest {
|
|
108
|
+
/**
|
|
109
|
+
* <p>The unique identifier of the agent associated with the knowledge base that you want to update.</p>
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
agentId: string | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* <p>The version of the agent associated with the knowledge base that you want to update.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
agentVersion: string | undefined;
|
|
118
|
+
/**
|
|
119
|
+
* <p>The unique identifier of the knowledge base that has been associated with an agent.</p>
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
knowledgeBaseId: string | undefined;
|
|
123
|
+
/**
|
|
124
|
+
* <p>Specifies a new description for the knowledge base associated with an agent.</p>
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
description?: string;
|
|
128
|
+
/**
|
|
129
|
+
* <p>Specifies whether the agent uses the knowledge base or not when sending an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request.</p>
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
knowledgeBaseState?: KnowledgeBaseState;
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
export interface UpdateAgentKnowledgeBaseResponse {
|
|
138
|
+
/**
|
|
139
|
+
* <p>Contains details about the knowledge base that has been associated with an agent.</p>
|
|
140
|
+
* @public
|
|
141
|
+
*/
|
|
142
|
+
agentKnowledgeBase: AgentKnowledgeBase | undefined;
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* @public
|
|
146
|
+
*/
|
|
147
|
+
export interface UpdateKnowledgeBaseRequest {
|
|
148
|
+
/**
|
|
149
|
+
* <p>The unique identifier of the knowledge base to update.</p>
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
knowledgeBaseId: string | undefined;
|
|
153
|
+
/**
|
|
154
|
+
* <p>Specifies a new name for the knowledge base.</p>
|
|
155
|
+
* @public
|
|
156
|
+
*/
|
|
157
|
+
name: string | undefined;
|
|
158
|
+
/**
|
|
159
|
+
* <p>Specifies a new description for the knowledge base.</p>
|
|
160
|
+
* @public
|
|
161
|
+
*/
|
|
162
|
+
description?: string;
|
|
163
|
+
/**
|
|
164
|
+
* <p>Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>
|
|
165
|
+
* @public
|
|
166
|
+
*/
|
|
167
|
+
roleArn: string | undefined;
|
|
168
|
+
/**
|
|
169
|
+
* <p>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.</p>
|
|
170
|
+
* @public
|
|
171
|
+
*/
|
|
172
|
+
knowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined;
|
|
173
|
+
/**
|
|
174
|
+
* <p>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.</p>
|
|
175
|
+
* @public
|
|
176
|
+
*/
|
|
177
|
+
storageConfiguration: StorageConfiguration | undefined;
|
|
178
|
+
}
|
|
179
|
+
/**
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
182
|
+
export interface UpdateKnowledgeBaseResponse {
|
|
183
|
+
/**
|
|
184
|
+
* <p>Contains details about the knowledge base.</p>
|
|
185
|
+
* @public
|
|
186
|
+
*/
|
|
187
|
+
knowledgeBase: KnowledgeBase | undefined;
|
|
188
|
+
}
|
|
189
|
+
/**
|
|
190
|
+
* <p>Contains specifications for an Amazon Bedrock agent with which to use the prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html">Create a prompt using Prompt management</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents.html">Automate tasks in your application using conversational agents</a>.</p>
|
|
191
|
+
* @public
|
|
192
|
+
*/
|
|
193
|
+
export interface PromptAgentResource {
|
|
194
|
+
/**
|
|
195
|
+
* <p>The ARN of the agent with which to use the prompt.</p>
|
|
196
|
+
* @public
|
|
197
|
+
*/
|
|
198
|
+
agentIdentifier: string | undefined;
|
|
199
|
+
}
|
|
200
|
+
/**
|
|
201
|
+
* <p>Contains specifications for a generative AI resource with which to use the prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html">Create a prompt using Prompt management</a>.</p>
|
|
202
|
+
* @public
|
|
203
|
+
*/
|
|
204
|
+
export type PromptGenAiResource = PromptGenAiResource.AgentMember | PromptGenAiResource.$UnknownMember;
|
|
205
|
+
/**
|
|
206
|
+
* @public
|
|
207
|
+
*/
|
|
208
|
+
export declare namespace PromptGenAiResource {
|
|
209
|
+
/**
|
|
210
|
+
* <p>Specifies an Amazon Bedrock agent with which to use the prompt.</p>
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
interface AgentMember {
|
|
214
|
+
agent: PromptAgentResource;
|
|
215
|
+
$unknown?: never;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* @public
|
|
219
|
+
*/
|
|
220
|
+
interface $UnknownMember {
|
|
221
|
+
agent?: never;
|
|
222
|
+
$unknown: [string, any];
|
|
223
|
+
}
|
|
224
|
+
interface Visitor<T> {
|
|
225
|
+
agent: (value: PromptAgentResource) => T;
|
|
226
|
+
_: (name: string, value: any) => T;
|
|
227
|
+
}
|
|
228
|
+
const visit: <T>(value: PromptGenAiResource, visitor: Visitor<T>) => T;
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* <p>Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html">Create a prompt using Prompt management</a>.</p>
|
|
232
|
+
* @public
|
|
233
|
+
*/
|
|
234
|
+
export interface PromptMetadataEntry {
|
|
235
|
+
/**
|
|
236
|
+
* <p>The key of a metadata tag for a prompt variant.</p>
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
key: string | undefined;
|
|
240
|
+
/**
|
|
241
|
+
* <p>The value of a metadata tag for a prompt variant.</p>
|
|
242
|
+
* @public
|
|
243
|
+
*/
|
|
244
|
+
value: string | undefined;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* <p>Contains details about a variant of the prompt.</p>
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
250
|
+
export interface PromptVariant {
|
|
251
|
+
/**
|
|
252
|
+
* <p>The name of the prompt variant.</p>
|
|
253
|
+
* @public
|
|
254
|
+
*/
|
|
255
|
+
name: string | undefined;
|
|
256
|
+
/**
|
|
257
|
+
* <p>The type of prompt template to use.</p>
|
|
258
|
+
* @public
|
|
259
|
+
*/
|
|
260
|
+
templateType: PromptTemplateType | undefined;
|
|
261
|
+
/**
|
|
262
|
+
* <p>Contains configurations for the prompt template.</p>
|
|
263
|
+
* @public
|
|
264
|
+
*/
|
|
265
|
+
templateConfiguration: PromptTemplateConfiguration | undefined;
|
|
266
|
+
/**
|
|
267
|
+
* <p>The unique identifier of the model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> with which to run inference on the prompt.</p>
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
modelId?: string;
|
|
271
|
+
/**
|
|
272
|
+
* <p>Contains inference configurations for the prompt variant.</p>
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
inferenceConfiguration?: PromptInferenceConfiguration;
|
|
276
|
+
/**
|
|
277
|
+
* <p>An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.</p>
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
metadata?: PromptMetadataEntry[];
|
|
281
|
+
/**
|
|
282
|
+
* <p>Contains model-specific inference configurations that aren't in the <code>inferenceConfiguration</code> field. To see model-specific inference parameters, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference request parameters and response fields for foundation models</a>.</p>
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
additionalModelRequestFields?: __DocumentType;
|
|
286
|
+
/**
|
|
287
|
+
* <p>Specifies a generative AI resource with which to use the prompt.</p>
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
genAiResource?: PromptGenAiResource;
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* @public
|
|
294
|
+
*/
|
|
295
|
+
export interface CreatePromptRequest {
|
|
296
|
+
/**
|
|
297
|
+
* <p>A name for the prompt.</p>
|
|
298
|
+
* @public
|
|
299
|
+
*/
|
|
300
|
+
name: string | undefined;
|
|
301
|
+
/**
|
|
302
|
+
* <p>A description for the prompt.</p>
|
|
303
|
+
* @public
|
|
304
|
+
*/
|
|
305
|
+
description?: string;
|
|
306
|
+
/**
|
|
307
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.</p>
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
customerEncryptionKeyArn?: string;
|
|
311
|
+
/**
|
|
312
|
+
* <p>The name of the default variant for the prompt. This value must match the <code>name</code> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.</p>
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
defaultVariant?: string;
|
|
316
|
+
/**
|
|
317
|
+
* <p>A list of objects, each containing details about a variant of the prompt.</p>
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
variants?: PromptVariant[];
|
|
321
|
+
/**
|
|
322
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
323
|
+
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
324
|
+
* @public
|
|
325
|
+
*/
|
|
326
|
+
clientToken?: string;
|
|
327
|
+
/**
|
|
328
|
+
* <p>Any tags that you want to attach to the prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging resources in Amazon Bedrock</a>.</p>
|
|
329
|
+
* @public
|
|
330
|
+
*/
|
|
331
|
+
tags?: Record<string, string>;
|
|
332
|
+
}
|
|
333
|
+
/**
|
|
334
|
+
* @public
|
|
335
|
+
*/
|
|
336
|
+
export interface CreatePromptResponse {
|
|
337
|
+
/**
|
|
338
|
+
* <p>The name of the prompt.</p>
|
|
339
|
+
* @public
|
|
340
|
+
*/
|
|
341
|
+
name: string | undefined;
|
|
342
|
+
/**
|
|
343
|
+
* <p>The description of the prompt.</p>
|
|
344
|
+
* @public
|
|
345
|
+
*/
|
|
346
|
+
description?: string;
|
|
347
|
+
/**
|
|
348
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.</p>
|
|
349
|
+
* @public
|
|
350
|
+
*/
|
|
351
|
+
customerEncryptionKeyArn?: string;
|
|
352
|
+
/**
|
|
353
|
+
* <p>The name of the default variant for your prompt.</p>
|
|
354
|
+
* @public
|
|
355
|
+
*/
|
|
356
|
+
defaultVariant?: string;
|
|
357
|
+
/**
|
|
358
|
+
* <p>A list of objects, each containing details about a variant of the prompt.</p>
|
|
359
|
+
* @public
|
|
360
|
+
*/
|
|
361
|
+
variants?: PromptVariant[];
|
|
362
|
+
/**
|
|
363
|
+
* <p>The unique identifier of the prompt.</p>
|
|
364
|
+
* @public
|
|
365
|
+
*/
|
|
366
|
+
id: string | undefined;
|
|
367
|
+
/**
|
|
368
|
+
* <p>The Amazon Resource Name (ARN) of the prompt.</p>
|
|
369
|
+
* @public
|
|
370
|
+
*/
|
|
371
|
+
arn: string | undefined;
|
|
372
|
+
/**
|
|
373
|
+
* <p>The version of the prompt. When you create a prompt, the version created is the <code>DRAFT</code> version.</p>
|
|
374
|
+
* @public
|
|
375
|
+
*/
|
|
376
|
+
version: string | undefined;
|
|
377
|
+
/**
|
|
378
|
+
* <p>The time at which the prompt was created.</p>
|
|
379
|
+
* @public
|
|
380
|
+
*/
|
|
381
|
+
createdAt: Date | undefined;
|
|
382
|
+
/**
|
|
383
|
+
* <p>The time at which the prompt was last updated.</p>
|
|
384
|
+
* @public
|
|
385
|
+
*/
|
|
386
|
+
updatedAt: Date | undefined;
|
|
387
|
+
}
|
|
388
|
+
/**
|
|
389
|
+
* @public
|
|
390
|
+
*/
|
|
391
|
+
export interface CreatePromptVersionRequest {
|
|
392
|
+
/**
|
|
393
|
+
* <p>The unique identifier of the prompt that you want to create a version of.</p>
|
|
394
|
+
* @public
|
|
395
|
+
*/
|
|
396
|
+
promptIdentifier: string | undefined;
|
|
397
|
+
/**
|
|
398
|
+
* <p>A description for the version of the prompt.</p>
|
|
399
|
+
* @public
|
|
400
|
+
*/
|
|
401
|
+
description?: string;
|
|
402
|
+
/**
|
|
403
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request,
|
|
404
|
+
* Amazon Bedrock ignores the request, but does not return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>
|
|
405
|
+
* @public
|
|
406
|
+
*/
|
|
407
|
+
clientToken?: string;
|
|
408
|
+
/**
|
|
409
|
+
* <p>Any tags that you want to attach to the version of the prompt. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html">Tagging resources in Amazon Bedrock</a>.</p>
|
|
410
|
+
* @public
|
|
411
|
+
*/
|
|
412
|
+
tags?: Record<string, string>;
|
|
413
|
+
}
|
|
414
|
+
/**
|
|
415
|
+
* @public
|
|
416
|
+
*/
|
|
417
|
+
export interface CreatePromptVersionResponse {
|
|
418
|
+
/**
|
|
419
|
+
* <p>The name of the prompt.</p>
|
|
420
|
+
* @public
|
|
421
|
+
*/
|
|
422
|
+
name: string | undefined;
|
|
423
|
+
/**
|
|
424
|
+
* <p>A description for the version.</p>
|
|
425
|
+
* @public
|
|
426
|
+
*/
|
|
427
|
+
description?: string;
|
|
428
|
+
/**
|
|
429
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key to encrypt the version of the prompt.</p>
|
|
430
|
+
* @public
|
|
431
|
+
*/
|
|
432
|
+
customerEncryptionKeyArn?: string;
|
|
433
|
+
/**
|
|
434
|
+
* <p>The name of the default variant for the prompt. This value must match the <code>name</code> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.</p>
|
|
435
|
+
* @public
|
|
436
|
+
*/
|
|
437
|
+
defaultVariant?: string;
|
|
438
|
+
/**
|
|
439
|
+
* <p>A list of objects, each containing details about a variant of the prompt.</p>
|
|
440
|
+
* @public
|
|
441
|
+
*/
|
|
442
|
+
variants?: PromptVariant[];
|
|
443
|
+
/**
|
|
444
|
+
* <p>The unique identifier of the prompt.</p>
|
|
445
|
+
* @public
|
|
446
|
+
*/
|
|
447
|
+
id: string | undefined;
|
|
448
|
+
/**
|
|
449
|
+
* <p>The Amazon Resource Name (ARN) of the version of the prompt.</p>
|
|
450
|
+
* @public
|
|
451
|
+
*/
|
|
452
|
+
arn: string | undefined;
|
|
453
|
+
/**
|
|
454
|
+
* <p>The version of the prompt that was created. Versions are numbered incrementally, starting from 1.</p>
|
|
455
|
+
* @public
|
|
456
|
+
*/
|
|
457
|
+
version: string | undefined;
|
|
458
|
+
/**
|
|
459
|
+
* <p>The time at which the prompt was created.</p>
|
|
460
|
+
* @public
|
|
461
|
+
*/
|
|
462
|
+
createdAt: Date | undefined;
|
|
463
|
+
/**
|
|
464
|
+
* <p>The time at which the prompt was last updated.</p>
|
|
465
|
+
* @public
|
|
466
|
+
*/
|
|
467
|
+
updatedAt: Date | undefined;
|
|
468
|
+
}
|
|
469
|
+
/**
|
|
470
|
+
* @public
|
|
471
|
+
*/
|
|
472
|
+
export interface DeletePromptRequest {
|
|
473
|
+
/**
|
|
474
|
+
* <p>The unique identifier of the prompt.</p>
|
|
475
|
+
* @public
|
|
476
|
+
*/
|
|
477
|
+
promptIdentifier: string | undefined;
|
|
478
|
+
/**
|
|
479
|
+
* <p>The version of the prompt to delete. To delete the prompt, omit this field.</p>
|
|
480
|
+
* @public
|
|
481
|
+
*/
|
|
482
|
+
promptVersion?: string;
|
|
483
|
+
}
|
|
484
|
+
/**
|
|
485
|
+
* @public
|
|
486
|
+
*/
|
|
487
|
+
export interface DeletePromptResponse {
|
|
488
|
+
/**
|
|
489
|
+
* <p>The unique identifier of the prompt that was deleted.</p>
|
|
490
|
+
* @public
|
|
491
|
+
*/
|
|
492
|
+
id: string | undefined;
|
|
493
|
+
/**
|
|
494
|
+
* <p>The version of the prompt that was deleted.</p>
|
|
495
|
+
* @public
|
|
496
|
+
*/
|
|
497
|
+
version?: string;
|
|
498
|
+
}
|
|
499
|
+
/**
|
|
500
|
+
* @public
|
|
501
|
+
*/
|
|
502
|
+
export interface GetPromptRequest {
|
|
503
|
+
/**
|
|
504
|
+
* <p>The unique identifier of the prompt.</p>
|
|
505
|
+
* @public
|
|
506
|
+
*/
|
|
507
|
+
promptIdentifier: string | undefined;
|
|
508
|
+
/**
|
|
509
|
+
* <p>The version of the prompt about which you want to retrieve information. Omit this field to return information about the working draft of the prompt.</p>
|
|
510
|
+
* @public
|
|
511
|
+
*/
|
|
512
|
+
promptVersion?: string;
|
|
513
|
+
}
|
|
514
|
+
/**
|
|
515
|
+
* @public
|
|
516
|
+
*/
|
|
517
|
+
export interface GetPromptResponse {
|
|
518
|
+
/**
|
|
519
|
+
* <p>The name of the prompt.</p>
|
|
520
|
+
* @public
|
|
521
|
+
*/
|
|
522
|
+
name: string | undefined;
|
|
523
|
+
/**
|
|
524
|
+
* <p>The descriptino of the prompt.</p>
|
|
525
|
+
* @public
|
|
526
|
+
*/
|
|
527
|
+
description?: string;
|
|
528
|
+
/**
|
|
529
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with.</p>
|
|
530
|
+
* @public
|
|
531
|
+
*/
|
|
532
|
+
customerEncryptionKeyArn?: string;
|
|
533
|
+
/**
|
|
534
|
+
* <p>The name of the default variant for the prompt. This value must match the <code>name</code> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.</p>
|
|
535
|
+
* @public
|
|
536
|
+
*/
|
|
537
|
+
defaultVariant?: string;
|
|
538
|
+
/**
|
|
539
|
+
* <p>A list of objects, each containing details about a variant of the prompt.</p>
|
|
540
|
+
* @public
|
|
541
|
+
*/
|
|
542
|
+
variants?: PromptVariant[];
|
|
543
|
+
/**
|
|
544
|
+
* <p>The unique identifier of the prompt.</p>
|
|
545
|
+
* @public
|
|
546
|
+
*/
|
|
547
|
+
id: string | undefined;
|
|
548
|
+
/**
|
|
549
|
+
* <p>The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).</p>
|
|
550
|
+
* @public
|
|
551
|
+
*/
|
|
552
|
+
arn: string | undefined;
|
|
553
|
+
/**
|
|
554
|
+
* <p>The version of the prompt.</p>
|
|
555
|
+
* @public
|
|
556
|
+
*/
|
|
557
|
+
version: string | undefined;
|
|
558
|
+
/**
|
|
559
|
+
* <p>The time at which the prompt was created.</p>
|
|
560
|
+
* @public
|
|
561
|
+
*/
|
|
562
|
+
createdAt: Date | undefined;
|
|
563
|
+
/**
|
|
564
|
+
* <p>The time at which the prompt was last updated.</p>
|
|
565
|
+
* @public
|
|
566
|
+
*/
|
|
567
|
+
updatedAt: Date | undefined;
|
|
568
|
+
}
|
|
569
|
+
/**
|
|
570
|
+
* @public
|
|
571
|
+
*/
|
|
572
|
+
export interface ListPromptsRequest {
|
|
573
|
+
/**
|
|
574
|
+
* <p>The unique identifier of the prompt for whose versions you want to return information. Omit this field to list information about all prompts in an account.</p>
|
|
575
|
+
* @public
|
|
576
|
+
*/
|
|
577
|
+
promptIdentifier?: string;
|
|
578
|
+
/**
|
|
579
|
+
* <p>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 <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
580
|
+
* @public
|
|
581
|
+
*/
|
|
582
|
+
maxResults?: number;
|
|
583
|
+
/**
|
|
584
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
nextToken?: string;
|
|
588
|
+
}
|
|
589
|
+
/**
|
|
590
|
+
* <p>Contains information about a prompt in your Prompt management tool.</p>
|
|
591
|
+
* <p>This data type is used in the following API operations:</p>
|
|
592
|
+
* <ul>
|
|
593
|
+
* <li>
|
|
594
|
+
* <p>
|
|
595
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListPrompts.html#API_agent_ListPrompts_ResponseSyntax">ListPrompts response</a>
|
|
596
|
+
* </p>
|
|
597
|
+
* </li>
|
|
598
|
+
* </ul>
|
|
599
|
+
* @public
|
|
600
|
+
*/
|
|
601
|
+
export interface PromptSummary {
|
|
602
|
+
/**
|
|
603
|
+
* <p>The name of the prompt.</p>
|
|
604
|
+
* @public
|
|
605
|
+
*/
|
|
606
|
+
name: string | undefined;
|
|
607
|
+
/**
|
|
608
|
+
* <p>The description of the prompt.</p>
|
|
609
|
+
* @public
|
|
610
|
+
*/
|
|
611
|
+
description?: string;
|
|
612
|
+
/**
|
|
613
|
+
* <p>The unique identifier of the prompt.</p>
|
|
614
|
+
* @public
|
|
615
|
+
*/
|
|
616
|
+
id: string | undefined;
|
|
617
|
+
/**
|
|
618
|
+
* <p>The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).</p>
|
|
619
|
+
* @public
|
|
620
|
+
*/
|
|
621
|
+
arn: string | undefined;
|
|
622
|
+
/**
|
|
623
|
+
* <p>The version of the prompt that this summary applies to.</p>
|
|
624
|
+
* @public
|
|
625
|
+
*/
|
|
626
|
+
version: string | undefined;
|
|
627
|
+
/**
|
|
628
|
+
* <p>The time at which the prompt was created.</p>
|
|
629
|
+
* @public
|
|
630
|
+
*/
|
|
631
|
+
createdAt: Date | undefined;
|
|
632
|
+
/**
|
|
633
|
+
* <p>The time at which the prompt was last updated.</p>
|
|
634
|
+
* @public
|
|
635
|
+
*/
|
|
636
|
+
updatedAt: Date | undefined;
|
|
637
|
+
}
|
|
638
|
+
/**
|
|
639
|
+
* @public
|
|
640
|
+
*/
|
|
641
|
+
export interface ListPromptsResponse {
|
|
642
|
+
/**
|
|
643
|
+
* <p>A list, each member of which contains information about a prompt using Prompt management.</p>
|
|
644
|
+
* @public
|
|
645
|
+
*/
|
|
646
|
+
promptSummaries: PromptSummary[] | undefined;
|
|
647
|
+
/**
|
|
648
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
649
|
+
* @public
|
|
650
|
+
*/
|
|
651
|
+
nextToken?: string;
|
|
652
|
+
}
|
|
653
|
+
/**
|
|
654
|
+
* @public
|
|
655
|
+
*/
|
|
656
|
+
export interface UpdatePromptRequest {
|
|
657
|
+
/**
|
|
658
|
+
* <p>A name for the prompt.</p>
|
|
659
|
+
* @public
|
|
660
|
+
*/
|
|
661
|
+
name: string | undefined;
|
|
662
|
+
/**
|
|
663
|
+
* <p>A description for the prompt.</p>
|
|
664
|
+
* @public
|
|
665
|
+
*/
|
|
666
|
+
description?: string;
|
|
667
|
+
/**
|
|
668
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.</p>
|
|
669
|
+
* @public
|
|
670
|
+
*/
|
|
671
|
+
customerEncryptionKeyArn?: string;
|
|
672
|
+
/**
|
|
673
|
+
* <p>The name of the default variant for the prompt. This value must match the <code>name</code> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.</p>
|
|
674
|
+
* @public
|
|
675
|
+
*/
|
|
676
|
+
defaultVariant?: string;
|
|
677
|
+
/**
|
|
678
|
+
* <p>A list of objects, each containing details about a variant of the prompt.</p>
|
|
679
|
+
* @public
|
|
680
|
+
*/
|
|
681
|
+
variants?: PromptVariant[];
|
|
682
|
+
/**
|
|
683
|
+
* <p>The unique identifier of the prompt.</p>
|
|
684
|
+
* @public
|
|
685
|
+
*/
|
|
686
|
+
promptIdentifier: string | undefined;
|
|
687
|
+
}
|
|
688
|
+
/**
|
|
689
|
+
* @public
|
|
690
|
+
*/
|
|
691
|
+
export interface UpdatePromptResponse {
|
|
692
|
+
/**
|
|
693
|
+
* <p>The name of the prompt.</p>
|
|
694
|
+
* @public
|
|
695
|
+
*/
|
|
696
|
+
name: string | undefined;
|
|
697
|
+
/**
|
|
698
|
+
* <p>The description of the prompt.</p>
|
|
699
|
+
* @public
|
|
700
|
+
*/
|
|
701
|
+
description?: string;
|
|
702
|
+
/**
|
|
703
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.</p>
|
|
704
|
+
* @public
|
|
705
|
+
*/
|
|
706
|
+
customerEncryptionKeyArn?: string;
|
|
707
|
+
/**
|
|
708
|
+
* <p>The name of the default variant for the prompt. This value must match the <code>name</code> field in the relevant <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html">PromptVariant</a> object.</p>
|
|
709
|
+
* @public
|
|
710
|
+
*/
|
|
711
|
+
defaultVariant?: string;
|
|
712
|
+
/**
|
|
713
|
+
* <p>A list of objects, each containing details about a variant of the prompt.</p>
|
|
714
|
+
* @public
|
|
715
|
+
*/
|
|
716
|
+
variants?: PromptVariant[];
|
|
717
|
+
/**
|
|
718
|
+
* <p>The unique identifier of the prompt.</p>
|
|
719
|
+
* @public
|
|
720
|
+
*/
|
|
721
|
+
id: string | undefined;
|
|
722
|
+
/**
|
|
723
|
+
* <p>The Amazon Resource Name (ARN) of the prompt.</p>
|
|
724
|
+
* @public
|
|
725
|
+
*/
|
|
726
|
+
arn: string | undefined;
|
|
727
|
+
/**
|
|
728
|
+
* <p>The version of the prompt. When you update a prompt, the version updated is the <code>DRAFT</code> version.</p>
|
|
729
|
+
* @public
|
|
730
|
+
*/
|
|
731
|
+
version: string | undefined;
|
|
732
|
+
/**
|
|
733
|
+
* <p>The time at which the prompt was created.</p>
|
|
734
|
+
* @public
|
|
735
|
+
*/
|
|
736
|
+
createdAt: Date | undefined;
|
|
737
|
+
/**
|
|
738
|
+
* <p>The time at which the prompt was last updated.</p>
|
|
739
|
+
* @public
|
|
740
|
+
*/
|
|
741
|
+
updatedAt: Date | undefined;
|
|
742
|
+
}
|
|
743
|
+
/**
|
|
744
|
+
* @public
|
|
745
|
+
*/
|
|
746
|
+
export interface ListTagsForResourceRequest {
|
|
747
|
+
/**
|
|
748
|
+
* <p>The Amazon Resource Name (ARN) of the resource for which to list tags.</p>
|
|
749
|
+
* @public
|
|
750
|
+
*/
|
|
751
|
+
resourceArn: string | undefined;
|
|
752
|
+
}
|
|
753
|
+
/**
|
|
754
|
+
* @public
|
|
755
|
+
*/
|
|
756
|
+
export interface ListTagsForResourceResponse {
|
|
757
|
+
/**
|
|
758
|
+
* <p>The key-value pairs for the tags associated with the resource.</p>
|
|
759
|
+
* @public
|
|
760
|
+
*/
|
|
761
|
+
tags?: Record<string, string>;
|
|
762
|
+
}
|
|
763
|
+
/**
|
|
764
|
+
* @public
|
|
765
|
+
*/
|
|
766
|
+
export interface TagResourceRequest {
|
|
767
|
+
/**
|
|
768
|
+
* <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
|
|
769
|
+
* @public
|
|
770
|
+
*/
|
|
771
|
+
resourceArn: string | undefined;
|
|
772
|
+
/**
|
|
773
|
+
* <p>An object containing key-value pairs that define the tags to attach to the resource.</p>
|
|
774
|
+
* @public
|
|
775
|
+
*/
|
|
776
|
+
tags: Record<string, string> | undefined;
|
|
777
|
+
}
|
|
778
|
+
/**
|
|
779
|
+
* @public
|
|
780
|
+
*/
|
|
781
|
+
export interface TagResourceResponse {
|
|
782
|
+
}
|
|
783
|
+
/**
|
|
784
|
+
* @public
|
|
785
|
+
*/
|
|
786
|
+
export interface UntagResourceRequest {
|
|
787
|
+
/**
|
|
788
|
+
* <p>The Amazon Resource Name (ARN) of the resource from which to remove tags.</p>
|
|
789
|
+
* @public
|
|
790
|
+
*/
|
|
791
|
+
resourceArn: string | undefined;
|
|
792
|
+
/**
|
|
793
|
+
* <p>A list of keys of the tags to remove from the resource.</p>
|
|
794
|
+
* @public
|
|
795
|
+
*/
|
|
796
|
+
tagKeys: string[] | undefined;
|
|
797
|
+
}
|
|
798
|
+
/**
|
|
799
|
+
* @public
|
|
800
|
+
*/
|
|
801
|
+
export interface UntagResourceResponse {
|
|
802
|
+
}
|
|
803
|
+
/**
|
|
804
|
+
* @public
|
|
805
|
+
*/
|
|
806
|
+
export interface ValidateFlowDefinitionRequest {
|
|
807
|
+
/**
|
|
808
|
+
* <p>The definition of a flow to validate.</p>
|
|
809
|
+
* @public
|
|
810
|
+
*/
|
|
811
|
+
definition: FlowDefinition | undefined;
|
|
812
|
+
}
|
|
813
|
+
/**
|
|
814
|
+
* @public
|
|
815
|
+
*/
|
|
816
|
+
export interface ValidateFlowDefinitionResponse {
|
|
817
|
+
/**
|
|
818
|
+
* <p>Contains an array of objects, each of which contains an error identified by validation.</p>
|
|
819
|
+
* @public
|
|
820
|
+
*/
|
|
821
|
+
validations: FlowValidation[] | undefined;
|
|
822
|
+
}
|
|
823
|
+
/**
|
|
824
|
+
* @public
|
|
825
|
+
*/
|
|
826
|
+
export interface DeleteAgentVersionRequest {
|
|
827
|
+
/**
|
|
828
|
+
* <p>The unique identifier of the agent that the version belongs to.</p>
|
|
829
|
+
* @public
|
|
830
|
+
*/
|
|
831
|
+
agentId: string | undefined;
|
|
832
|
+
/**
|
|
833
|
+
* <p>The version of the agent to delete.</p>
|
|
834
|
+
* @public
|
|
835
|
+
*/
|
|
836
|
+
agentVersion: string | undefined;
|
|
837
|
+
/**
|
|
838
|
+
* <p>By default, this value is <code>false</code> and deletion is stopped if the resource is in use. If you set it to <code>true</code>, the resource will be deleted even if the resource is in use.</p>
|
|
839
|
+
* @public
|
|
840
|
+
*/
|
|
841
|
+
skipResourceInUseCheck?: boolean;
|
|
842
|
+
}
|
|
843
|
+
/**
|
|
844
|
+
* @public
|
|
845
|
+
*/
|
|
846
|
+
export interface DeleteAgentVersionResponse {
|
|
847
|
+
/**
|
|
848
|
+
* <p>The unique identifier of the agent that the version belongs to.</p>
|
|
849
|
+
* @public
|
|
850
|
+
*/
|
|
851
|
+
agentId: string | undefined;
|
|
852
|
+
/**
|
|
853
|
+
* <p>The version that was deleted.</p>
|
|
854
|
+
* @public
|
|
855
|
+
*/
|
|
856
|
+
agentVersion: string | undefined;
|
|
857
|
+
/**
|
|
858
|
+
* <p>The status of the agent version.</p>
|
|
859
|
+
* @public
|
|
860
|
+
*/
|
|
861
|
+
agentStatus: AgentStatus | undefined;
|
|
862
|
+
}
|
|
863
|
+
/**
|
|
864
|
+
* @public
|
|
865
|
+
*/
|
|
866
|
+
export interface GetAgentVersionRequest {
|
|
867
|
+
/**
|
|
868
|
+
* <p>The unique identifier of the agent.</p>
|
|
869
|
+
* @public
|
|
870
|
+
*/
|
|
871
|
+
agentId: string | undefined;
|
|
872
|
+
/**
|
|
873
|
+
* <p>The version of the agent.</p>
|
|
874
|
+
* @public
|
|
875
|
+
*/
|
|
876
|
+
agentVersion: string | undefined;
|
|
877
|
+
}
|
|
878
|
+
/**
|
|
879
|
+
* @public
|
|
880
|
+
*/
|
|
881
|
+
export interface GetAgentVersionResponse {
|
|
882
|
+
/**
|
|
883
|
+
* <p>Contains details about the version of the agent.</p>
|
|
884
|
+
* @public
|
|
885
|
+
*/
|
|
886
|
+
agentVersion: AgentVersion | undefined;
|
|
887
|
+
}
|
|
888
|
+
/**
|
|
889
|
+
* @public
|
|
890
|
+
*/
|
|
891
|
+
export interface ListAgentVersionsRequest {
|
|
892
|
+
/**
|
|
893
|
+
* <p>The unique identifier of the agent.</p>
|
|
894
|
+
* @public
|
|
895
|
+
*/
|
|
896
|
+
agentId: string | undefined;
|
|
897
|
+
/**
|
|
898
|
+
* <p>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 <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
899
|
+
* @public
|
|
900
|
+
*/
|
|
901
|
+
maxResults?: number;
|
|
902
|
+
/**
|
|
903
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
904
|
+
* @public
|
|
905
|
+
*/
|
|
906
|
+
nextToken?: string;
|
|
907
|
+
}
|
|
908
|
+
/**
|
|
909
|
+
* @public
|
|
910
|
+
*/
|
|
911
|
+
export interface ListAgentVersionsResponse {
|
|
912
|
+
/**
|
|
913
|
+
* <p>A list of objects, each of which contains information about a version of the agent.</p>
|
|
914
|
+
* @public
|
|
915
|
+
*/
|
|
916
|
+
agentVersionSummaries: AgentVersionSummary[] | undefined;
|
|
917
|
+
/**
|
|
918
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
919
|
+
* @public
|
|
920
|
+
*/
|
|
921
|
+
nextToken?: string;
|
|
922
|
+
}
|
|
923
|
+
/**
|
|
924
|
+
* @internal
|
|
925
|
+
*/
|
|
926
|
+
export declare const PromptAgentResourceFilterSensitiveLog: (obj: PromptAgentResource) => any;
|
|
927
|
+
/**
|
|
928
|
+
* @internal
|
|
929
|
+
*/
|
|
930
|
+
export declare const PromptGenAiResourceFilterSensitiveLog: (obj: PromptGenAiResource) => any;
|
|
931
|
+
/**
|
|
932
|
+
* @internal
|
|
933
|
+
*/
|
|
934
|
+
export declare const PromptMetadataEntryFilterSensitiveLog: (obj: PromptMetadataEntry) => any;
|
|
935
|
+
/**
|
|
936
|
+
* @internal
|
|
937
|
+
*/
|
|
938
|
+
export declare const PromptVariantFilterSensitiveLog: (obj: PromptVariant) => any;
|
|
939
|
+
/**
|
|
940
|
+
* @internal
|
|
941
|
+
*/
|
|
942
|
+
export declare const CreatePromptRequestFilterSensitiveLog: (obj: CreatePromptRequest) => any;
|
|
943
|
+
/**
|
|
944
|
+
* @internal
|
|
945
|
+
*/
|
|
946
|
+
export declare const CreatePromptResponseFilterSensitiveLog: (obj: CreatePromptResponse) => any;
|
|
947
|
+
/**
|
|
948
|
+
* @internal
|
|
949
|
+
*/
|
|
950
|
+
export declare const CreatePromptVersionResponseFilterSensitiveLog: (obj: CreatePromptVersionResponse) => any;
|
|
951
|
+
/**
|
|
952
|
+
* @internal
|
|
953
|
+
*/
|
|
954
|
+
export declare const GetPromptResponseFilterSensitiveLog: (obj: GetPromptResponse) => any;
|
|
955
|
+
/**
|
|
956
|
+
* @internal
|
|
957
|
+
*/
|
|
958
|
+
export declare const UpdatePromptRequestFilterSensitiveLog: (obj: UpdatePromptRequest) => any;
|
|
959
|
+
/**
|
|
960
|
+
* @internal
|
|
961
|
+
*/
|
|
962
|
+
export declare const UpdatePromptResponseFilterSensitiveLog: (obj: UpdatePromptResponse) => any;
|
|
963
|
+
/**
|
|
964
|
+
* @internal
|
|
965
|
+
*/
|
|
966
|
+
export declare const ValidateFlowDefinitionRequestFilterSensitiveLog: (obj: ValidateFlowDefinitionRequest) => any;
|
|
967
|
+
/**
|
|
968
|
+
* @internal
|
|
969
|
+
*/
|
|
970
|
+
export declare const ValidateFlowDefinitionResponseFilterSensitiveLog: (obj: ValidateFlowDefinitionResponse) => any;
|
|
971
|
+
/**
|
|
972
|
+
* @internal
|
|
973
|
+
*/
|
|
974
|
+
export declare const GetAgentVersionResponseFilterSensitiveLog: (obj: GetAgentVersionResponse) => any;
|