@aws-sdk/client-bedrock-runtime 3.699.0 → 3.705.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 +31 -7
- package/dist-cjs/index.js +484 -116
- package/dist-es/BedrockRuntime.js +6 -0
- package/dist-es/commands/GetAsyncInvokeCommand.js +23 -0
- package/dist-es/commands/ListAsyncInvokesCommand.js +23 -0
- package/dist-es/commands/StartAsyncInvokeCommand.js +23 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/models_0.js +156 -72
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListAsyncInvokesPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +200 -2
- package/dist-types/BedrockRuntime.d.ts +22 -0
- package/dist-types/BedrockRuntimeClient.d.ts +5 -2
- package/dist-types/commands/ApplyGuardrailCommand.d.ts +12 -5
- package/dist-types/commands/ConverseCommand.d.ts +73 -9
- package/dist-types/commands/ConverseStreamCommand.d.ts +53 -9
- package/dist-types/commands/GetAsyncInvokeCommand.d.ts +101 -0
- package/dist-types/commands/InvokeModelCommand.d.ts +26 -9
- package/dist-types/commands/InvokeModelWithResponseStreamCommand.d.ts +26 -9
- package/dist-types/commands/ListAsyncInvokesCommand.d.ts +112 -0
- package/dist-types/commands/StartAsyncInvokeCommand.d.ts +124 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +652 -97
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListAsyncInvokesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
- package/dist-types/ts3.4/BedrockRuntime.d.ts +52 -0
- package/dist-types/ts3.4/BedrockRuntimeClient.d.ts +20 -2
- package/dist-types/ts3.4/commands/GetAsyncInvokeCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListAsyncInvokesCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/StartAsyncInvokeCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +254 -42
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListAsyncInvokesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
- package/package.json +4 -2
|
@@ -2,7 +2,8 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
|
|
|
2
2
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
3
|
import { BedrockRuntimeServiceException as __BaseException } from "./BedrockRuntimeServiceException";
|
|
4
4
|
/**
|
|
5
|
-
* <p>The request is denied because
|
|
5
|
+
* <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error,
|
|
6
|
+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide</p>
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
8
9
|
export declare class AccessDeniedException extends __BaseException {
|
|
@@ -13,6 +14,404 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
13
14
|
*/
|
|
14
15
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
16
|
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
export interface GetAsyncInvokeRequest {
|
|
21
|
+
/**
|
|
22
|
+
* <p>The invocation's ARN.</p>
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
invocationArn: string | undefined;
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* <p>Asynchronous invocation output data settings.</p>
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
export interface AsyncInvokeS3OutputDataConfig {
|
|
32
|
+
/**
|
|
33
|
+
* <p>An object URI starting with <code>s3://</code>.</p>
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
s3Uri: string | undefined;
|
|
37
|
+
/**
|
|
38
|
+
* <p>A KMS encryption key ID.</p>
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
41
|
+
kmsKeyId?: string | undefined;
|
|
42
|
+
/**
|
|
43
|
+
* <p>If the bucket belongs to another AWS account, specify that account's ID.</p>
|
|
44
|
+
* @public
|
|
45
|
+
*/
|
|
46
|
+
bucketOwner?: string | undefined;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* <p>Asynchronous invocation output data settings.</p>
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
export type AsyncInvokeOutputDataConfig = AsyncInvokeOutputDataConfig.S3OutputDataConfigMember | AsyncInvokeOutputDataConfig.$UnknownMember;
|
|
53
|
+
/**
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
export declare namespace AsyncInvokeOutputDataConfig {
|
|
57
|
+
/**
|
|
58
|
+
* <p>A storage location for the output data in an S3 bucket</p>
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
interface S3OutputDataConfigMember {
|
|
62
|
+
s3OutputDataConfig: AsyncInvokeS3OutputDataConfig;
|
|
63
|
+
$unknown?: never;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
interface $UnknownMember {
|
|
69
|
+
s3OutputDataConfig?: never;
|
|
70
|
+
$unknown: [string, any];
|
|
71
|
+
}
|
|
72
|
+
interface Visitor<T> {
|
|
73
|
+
s3OutputDataConfig: (value: AsyncInvokeS3OutputDataConfig) => T;
|
|
74
|
+
_: (name: string, value: any) => T;
|
|
75
|
+
}
|
|
76
|
+
const visit: <T>(value: AsyncInvokeOutputDataConfig, visitor: Visitor<T>) => T;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* @public
|
|
80
|
+
* @enum
|
|
81
|
+
*/
|
|
82
|
+
export declare const AsyncInvokeStatus: {
|
|
83
|
+
readonly COMPLETED: "Completed";
|
|
84
|
+
readonly FAILED: "Failed";
|
|
85
|
+
readonly IN_PROGRESS: "InProgress";
|
|
86
|
+
};
|
|
87
|
+
/**
|
|
88
|
+
* @public
|
|
89
|
+
*/
|
|
90
|
+
export type AsyncInvokeStatus = (typeof AsyncInvokeStatus)[keyof typeof AsyncInvokeStatus];
|
|
91
|
+
/**
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
export interface GetAsyncInvokeResponse {
|
|
95
|
+
/**
|
|
96
|
+
* <p>The invocation's ARN.</p>
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
invocationArn: string | undefined;
|
|
100
|
+
/**
|
|
101
|
+
* <p>The invocation's model ARN.</p>
|
|
102
|
+
* @public
|
|
103
|
+
*/
|
|
104
|
+
modelArn: string | undefined;
|
|
105
|
+
/**
|
|
106
|
+
* <p>The invocation's idempotency token.</p>
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
clientRequestToken?: string | undefined;
|
|
110
|
+
/**
|
|
111
|
+
* <p>The invocation's status.</p>
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
status: AsyncInvokeStatus | undefined;
|
|
115
|
+
/**
|
|
116
|
+
* <p>An error message.</p>
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
failureMessage?: string | undefined;
|
|
120
|
+
/**
|
|
121
|
+
* <p>When the invocation request was submitted.</p>
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
submitTime: Date | undefined;
|
|
125
|
+
/**
|
|
126
|
+
* <p>The invocation's last modified time.</p>
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
lastModifiedTime?: Date | undefined;
|
|
130
|
+
/**
|
|
131
|
+
* <p>When the invocation ended.</p>
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
endTime?: Date | undefined;
|
|
135
|
+
/**
|
|
136
|
+
* <p>Output data settings.</p>
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
outputDataConfig: AsyncInvokeOutputDataConfig | undefined;
|
|
140
|
+
}
|
|
141
|
+
/**
|
|
142
|
+
* <p>An internal server error occurred. For troubleshooting this error,
|
|
143
|
+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure">InternalFailure</a> in the Amazon Bedrock User Guide</p>
|
|
144
|
+
* @public
|
|
145
|
+
*/
|
|
146
|
+
export declare class InternalServerException extends __BaseException {
|
|
147
|
+
readonly name: "InternalServerException";
|
|
148
|
+
readonly $fault: "server";
|
|
149
|
+
/**
|
|
150
|
+
* @internal
|
|
151
|
+
*/
|
|
152
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For
|
|
156
|
+
* troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide</p>
|
|
157
|
+
* @public
|
|
158
|
+
*/
|
|
159
|
+
export declare class ThrottlingException extends __BaseException {
|
|
160
|
+
readonly name: "ThrottlingException";
|
|
161
|
+
readonly $fault: "client";
|
|
162
|
+
/**
|
|
163
|
+
* @internal
|
|
164
|
+
*/
|
|
165
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error,
|
|
169
|
+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide</p>
|
|
170
|
+
* @public
|
|
171
|
+
*/
|
|
172
|
+
export declare class ValidationException extends __BaseException {
|
|
173
|
+
readonly name: "ValidationException";
|
|
174
|
+
readonly $fault: "client";
|
|
175
|
+
/**
|
|
176
|
+
* @internal
|
|
177
|
+
*/
|
|
178
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* @public
|
|
182
|
+
* @enum
|
|
183
|
+
*/
|
|
184
|
+
export declare const SortAsyncInvocationBy: {
|
|
185
|
+
readonly SUBMISSION_TIME: "SubmissionTime";
|
|
186
|
+
};
|
|
187
|
+
/**
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
export type SortAsyncInvocationBy = (typeof SortAsyncInvocationBy)[keyof typeof SortAsyncInvocationBy];
|
|
191
|
+
/**
|
|
192
|
+
* @public
|
|
193
|
+
* @enum
|
|
194
|
+
*/
|
|
195
|
+
export declare const SortOrder: {
|
|
196
|
+
readonly ASCENDING: "Ascending";
|
|
197
|
+
readonly DESCENDING: "Descending";
|
|
198
|
+
};
|
|
199
|
+
/**
|
|
200
|
+
* @public
|
|
201
|
+
*/
|
|
202
|
+
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
203
|
+
/**
|
|
204
|
+
* @public
|
|
205
|
+
*/
|
|
206
|
+
export interface ListAsyncInvokesRequest {
|
|
207
|
+
/**
|
|
208
|
+
* <p>Include invocations submitted after this time.</p>
|
|
209
|
+
* @public
|
|
210
|
+
*/
|
|
211
|
+
submitTimeAfter?: Date | undefined;
|
|
212
|
+
/**
|
|
213
|
+
* <p>Include invocations submitted before this time.</p>
|
|
214
|
+
* @public
|
|
215
|
+
*/
|
|
216
|
+
submitTimeBefore?: Date | undefined;
|
|
217
|
+
/**
|
|
218
|
+
* <p>Filter invocations by status.</p>
|
|
219
|
+
* @public
|
|
220
|
+
*/
|
|
221
|
+
statusEquals?: AsyncInvokeStatus | undefined;
|
|
222
|
+
/**
|
|
223
|
+
* <p>The maximum number of invocations to return in one page of results.</p>
|
|
224
|
+
* @public
|
|
225
|
+
*/
|
|
226
|
+
maxResults?: number | undefined;
|
|
227
|
+
/**
|
|
228
|
+
* <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
|
|
229
|
+
* @public
|
|
230
|
+
*/
|
|
231
|
+
nextToken?: string | undefined;
|
|
232
|
+
/**
|
|
233
|
+
* <p>How to sort the response.</p>
|
|
234
|
+
* @public
|
|
235
|
+
*/
|
|
236
|
+
sortBy?: SortAsyncInvocationBy | undefined;
|
|
237
|
+
/**
|
|
238
|
+
* <p>The sorting order for the response.</p>
|
|
239
|
+
* @public
|
|
240
|
+
*/
|
|
241
|
+
sortOrder?: SortOrder | undefined;
|
|
242
|
+
}
|
|
243
|
+
/**
|
|
244
|
+
* <p>A summary of an asynchronous invocation.</p>
|
|
245
|
+
* @public
|
|
246
|
+
*/
|
|
247
|
+
export interface AsyncInvokeSummary {
|
|
248
|
+
/**
|
|
249
|
+
* <p>The invocation's ARN.</p>
|
|
250
|
+
* @public
|
|
251
|
+
*/
|
|
252
|
+
invocationArn: string | undefined;
|
|
253
|
+
/**
|
|
254
|
+
* <p>The invoked model's ARN.</p>
|
|
255
|
+
* @public
|
|
256
|
+
*/
|
|
257
|
+
modelArn: string | undefined;
|
|
258
|
+
/**
|
|
259
|
+
* <p>The invocation's idempotency token.</p>
|
|
260
|
+
* @public
|
|
261
|
+
*/
|
|
262
|
+
clientRequestToken?: string | undefined;
|
|
263
|
+
/**
|
|
264
|
+
* <p>The invocation's status.</p>
|
|
265
|
+
* @public
|
|
266
|
+
*/
|
|
267
|
+
status?: AsyncInvokeStatus | undefined;
|
|
268
|
+
/**
|
|
269
|
+
* <p>An error message.</p>
|
|
270
|
+
* @public
|
|
271
|
+
*/
|
|
272
|
+
failureMessage?: string | undefined;
|
|
273
|
+
/**
|
|
274
|
+
* <p>When the invocation was submitted.</p>
|
|
275
|
+
* @public
|
|
276
|
+
*/
|
|
277
|
+
submitTime: Date | undefined;
|
|
278
|
+
/**
|
|
279
|
+
* <p>When the invocation was last modified.</p>
|
|
280
|
+
* @public
|
|
281
|
+
*/
|
|
282
|
+
lastModifiedTime?: Date | undefined;
|
|
283
|
+
/**
|
|
284
|
+
* <p>When the invocation ended.</p>
|
|
285
|
+
* @public
|
|
286
|
+
*/
|
|
287
|
+
endTime?: Date | undefined;
|
|
288
|
+
/**
|
|
289
|
+
* <p>The invocation's output data settings.</p>
|
|
290
|
+
* @public
|
|
291
|
+
*/
|
|
292
|
+
outputDataConfig: AsyncInvokeOutputDataConfig | undefined;
|
|
293
|
+
}
|
|
294
|
+
/**
|
|
295
|
+
* @public
|
|
296
|
+
*/
|
|
297
|
+
export interface ListAsyncInvokesResponse {
|
|
298
|
+
/**
|
|
299
|
+
* <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
|
|
300
|
+
* @public
|
|
301
|
+
*/
|
|
302
|
+
nextToken?: string | undefined;
|
|
303
|
+
/**
|
|
304
|
+
* <p>A list of invocation summaries.</p>
|
|
305
|
+
* @public
|
|
306
|
+
*/
|
|
307
|
+
asyncInvokeSummaries?: AsyncInvokeSummary[] | undefined;
|
|
308
|
+
}
|
|
309
|
+
/**
|
|
310
|
+
* <p>Error occurred because of a conflict while performing an operation.</p>
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
export declare class ConflictException extends __BaseException {
|
|
314
|
+
readonly name: "ConflictException";
|
|
315
|
+
readonly $fault: "client";
|
|
316
|
+
/**
|
|
317
|
+
* @internal
|
|
318
|
+
*/
|
|
319
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
320
|
+
}
|
|
321
|
+
/**
|
|
322
|
+
* <p>The specified resource ARN was not found. For troubleshooting this error,
|
|
323
|
+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found">ResourceNotFound</a> in the Amazon Bedrock User Guide</p>
|
|
324
|
+
* @public
|
|
325
|
+
*/
|
|
326
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
327
|
+
readonly name: "ResourceNotFoundException";
|
|
328
|
+
readonly $fault: "client";
|
|
329
|
+
/**
|
|
330
|
+
* @internal
|
|
331
|
+
*/
|
|
332
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
333
|
+
}
|
|
334
|
+
/**
|
|
335
|
+
* <p>Your request exceeds the service quota for your account. You can view your quotas at <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html">Viewing service quotas</a>. You can resubmit your request later.</p>
|
|
336
|
+
* @public
|
|
337
|
+
*/
|
|
338
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
339
|
+
readonly name: "ServiceQuotaExceededException";
|
|
340
|
+
readonly $fault: "client";
|
|
341
|
+
/**
|
|
342
|
+
* @internal
|
|
343
|
+
*/
|
|
344
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
345
|
+
}
|
|
346
|
+
/**
|
|
347
|
+
* <p>The service isn't currently available. For troubleshooting this error,
|
|
348
|
+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable">ServiceUnavailable</a> in the Amazon Bedrock User Guide</p>
|
|
349
|
+
* @public
|
|
350
|
+
*/
|
|
351
|
+
export declare class ServiceUnavailableException extends __BaseException {
|
|
352
|
+
readonly name: "ServiceUnavailableException";
|
|
353
|
+
readonly $fault: "server";
|
|
354
|
+
/**
|
|
355
|
+
* @internal
|
|
356
|
+
*/
|
|
357
|
+
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
358
|
+
}
|
|
359
|
+
/**
|
|
360
|
+
* <p>A tag.</p>
|
|
361
|
+
* @public
|
|
362
|
+
*/
|
|
363
|
+
export interface Tag {
|
|
364
|
+
/**
|
|
365
|
+
* <p>The tag's key.</p>
|
|
366
|
+
* @public
|
|
367
|
+
*/
|
|
368
|
+
key: string | undefined;
|
|
369
|
+
/**
|
|
370
|
+
* <p>The tag's value.</p>
|
|
371
|
+
* @public
|
|
372
|
+
*/
|
|
373
|
+
value: string | undefined;
|
|
374
|
+
}
|
|
375
|
+
/**
|
|
376
|
+
* @public
|
|
377
|
+
*/
|
|
378
|
+
export interface StartAsyncInvokeRequest {
|
|
379
|
+
/**
|
|
380
|
+
* <p>Specify idempotency token to ensure that requests are not duplicated.</p>
|
|
381
|
+
* @public
|
|
382
|
+
*/
|
|
383
|
+
clientRequestToken?: string | undefined;
|
|
384
|
+
/**
|
|
385
|
+
* <p>The model to invoke.</p>
|
|
386
|
+
* @public
|
|
387
|
+
*/
|
|
388
|
+
modelId: string | undefined;
|
|
389
|
+
/**
|
|
390
|
+
* <p>Input to send to the model.</p>
|
|
391
|
+
* @public
|
|
392
|
+
*/
|
|
393
|
+
modelInput: __DocumentType | undefined;
|
|
394
|
+
/**
|
|
395
|
+
* <p>Where to store the output.</p>
|
|
396
|
+
* @public
|
|
397
|
+
*/
|
|
398
|
+
outputDataConfig: AsyncInvokeOutputDataConfig | undefined;
|
|
399
|
+
/**
|
|
400
|
+
* <p>Tags to apply to the invocation.</p>
|
|
401
|
+
* @public
|
|
402
|
+
*/
|
|
403
|
+
tags?: Tag[] | undefined;
|
|
404
|
+
}
|
|
405
|
+
/**
|
|
406
|
+
* @public
|
|
407
|
+
*/
|
|
408
|
+
export interface StartAsyncInvokeResponse {
|
|
409
|
+
/**
|
|
410
|
+
* <p>The ARN of the invocation.</p>
|
|
411
|
+
* @public
|
|
412
|
+
*/
|
|
413
|
+
invocationArn: string | undefined;
|
|
414
|
+
}
|
|
16
415
|
/**
|
|
17
416
|
* @public
|
|
18
417
|
* @enum
|
|
@@ -680,66 +1079,6 @@ export interface ApplyGuardrailResponse {
|
|
|
680
1079
|
*/
|
|
681
1080
|
guardrailCoverage?: GuardrailCoverage | undefined;
|
|
682
1081
|
}
|
|
683
|
-
/**
|
|
684
|
-
* <p>An internal server error occurred. Retry your request.</p>
|
|
685
|
-
* @public
|
|
686
|
-
*/
|
|
687
|
-
export declare class InternalServerException extends __BaseException {
|
|
688
|
-
readonly name: "InternalServerException";
|
|
689
|
-
readonly $fault: "server";
|
|
690
|
-
/**
|
|
691
|
-
* @internal
|
|
692
|
-
*/
|
|
693
|
-
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
694
|
-
}
|
|
695
|
-
/**
|
|
696
|
-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
697
|
-
* @public
|
|
698
|
-
*/
|
|
699
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
700
|
-
readonly name: "ResourceNotFoundException";
|
|
701
|
-
readonly $fault: "client";
|
|
702
|
-
/**
|
|
703
|
-
* @internal
|
|
704
|
-
*/
|
|
705
|
-
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
706
|
-
}
|
|
707
|
-
/**
|
|
708
|
-
* <p>Your request exceeds the service quota for your account. You can view your quotas at <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html">Viewing service quotas</a>. You can resubmit your request later.</p>
|
|
709
|
-
* @public
|
|
710
|
-
*/
|
|
711
|
-
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
712
|
-
readonly name: "ServiceQuotaExceededException";
|
|
713
|
-
readonly $fault: "client";
|
|
714
|
-
/**
|
|
715
|
-
* @internal
|
|
716
|
-
*/
|
|
717
|
-
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
718
|
-
}
|
|
719
|
-
/**
|
|
720
|
-
* <p>Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html">Provisioned Throughput</a> to increase the rate or number of tokens you can process.</p>
|
|
721
|
-
* @public
|
|
722
|
-
*/
|
|
723
|
-
export declare class ThrottlingException extends __BaseException {
|
|
724
|
-
readonly name: "ThrottlingException";
|
|
725
|
-
readonly $fault: "client";
|
|
726
|
-
/**
|
|
727
|
-
* @internal
|
|
728
|
-
*/
|
|
729
|
-
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
730
|
-
}
|
|
731
|
-
/**
|
|
732
|
-
* <p>Input validation failed. Check your request parameters and retry the request.</p>
|
|
733
|
-
* @public
|
|
734
|
-
*/
|
|
735
|
-
export declare class ValidationException extends __BaseException {
|
|
736
|
-
readonly name: "ValidationException";
|
|
737
|
-
readonly $fault: "client";
|
|
738
|
-
/**
|
|
739
|
-
* @internal
|
|
740
|
-
*/
|
|
741
|
-
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
742
|
-
}
|
|
743
1082
|
/**
|
|
744
1083
|
* @public
|
|
745
1084
|
* @enum
|
|
@@ -1028,11 +1367,106 @@ export interface ImageBlock {
|
|
|
1028
1367
|
*/
|
|
1029
1368
|
source: ImageSource | undefined;
|
|
1030
1369
|
}
|
|
1370
|
+
/**
|
|
1371
|
+
* @public
|
|
1372
|
+
* @enum
|
|
1373
|
+
*/
|
|
1374
|
+
export declare const VideoFormat: {
|
|
1375
|
+
readonly FLV: "flv";
|
|
1376
|
+
readonly MKV: "mkv";
|
|
1377
|
+
readonly MOV: "mov";
|
|
1378
|
+
readonly MP4: "mp4";
|
|
1379
|
+
readonly MPEG: "mpeg";
|
|
1380
|
+
readonly MPG: "mpg";
|
|
1381
|
+
readonly THREE_GP: "three_gp";
|
|
1382
|
+
readonly WEBM: "webm";
|
|
1383
|
+
readonly WMV: "wmv";
|
|
1384
|
+
};
|
|
1385
|
+
/**
|
|
1386
|
+
* @public
|
|
1387
|
+
*/
|
|
1388
|
+
export type VideoFormat = (typeof VideoFormat)[keyof typeof VideoFormat];
|
|
1389
|
+
/**
|
|
1390
|
+
* <p>A storage location in an S3 bucket.</p>
|
|
1391
|
+
* @public
|
|
1392
|
+
*/
|
|
1393
|
+
export interface S3Location {
|
|
1394
|
+
/**
|
|
1395
|
+
* <p>An object URI starting with <code>s3://</code>.</p>
|
|
1396
|
+
* @public
|
|
1397
|
+
*/
|
|
1398
|
+
uri: string | undefined;
|
|
1399
|
+
/**
|
|
1400
|
+
* <p>If the bucket belongs to another AWS account, specify that account's ID.</p>
|
|
1401
|
+
* @public
|
|
1402
|
+
*/
|
|
1403
|
+
bucketOwner?: string | undefined;
|
|
1404
|
+
}
|
|
1405
|
+
/**
|
|
1406
|
+
* <p>A video source. You can upload a smaller video as a base64-encoded string as
|
|
1407
|
+
* long as the encoded file is less than 25MB. You can also transfer videos up to 1GB in size
|
|
1408
|
+
* from an S3 bucket.</p>
|
|
1409
|
+
* @public
|
|
1410
|
+
*/
|
|
1411
|
+
export type VideoSource = VideoSource.BytesMember | VideoSource.S3LocationMember | VideoSource.$UnknownMember;
|
|
1412
|
+
/**
|
|
1413
|
+
* @public
|
|
1414
|
+
*/
|
|
1415
|
+
export declare namespace VideoSource {
|
|
1416
|
+
/**
|
|
1417
|
+
* <p>Video content encoded in base64.</p>
|
|
1418
|
+
* @public
|
|
1419
|
+
*/
|
|
1420
|
+
interface BytesMember {
|
|
1421
|
+
bytes: Uint8Array;
|
|
1422
|
+
s3Location?: never;
|
|
1423
|
+
$unknown?: never;
|
|
1424
|
+
}
|
|
1425
|
+
/**
|
|
1426
|
+
* <p>The location of a video object in an S3 bucket.</p>
|
|
1427
|
+
* @public
|
|
1428
|
+
*/
|
|
1429
|
+
interface S3LocationMember {
|
|
1430
|
+
bytes?: never;
|
|
1431
|
+
s3Location: S3Location;
|
|
1432
|
+
$unknown?: never;
|
|
1433
|
+
}
|
|
1434
|
+
/**
|
|
1435
|
+
* @public
|
|
1436
|
+
*/
|
|
1437
|
+
interface $UnknownMember {
|
|
1438
|
+
bytes?: never;
|
|
1439
|
+
s3Location?: never;
|
|
1440
|
+
$unknown: [string, any];
|
|
1441
|
+
}
|
|
1442
|
+
interface Visitor<T> {
|
|
1443
|
+
bytes: (value: Uint8Array) => T;
|
|
1444
|
+
s3Location: (value: S3Location) => T;
|
|
1445
|
+
_: (name: string, value: any) => T;
|
|
1446
|
+
}
|
|
1447
|
+
const visit: <T>(value: VideoSource, visitor: Visitor<T>) => T;
|
|
1448
|
+
}
|
|
1449
|
+
/**
|
|
1450
|
+
* <p>A video block.</p>
|
|
1451
|
+
* @public
|
|
1452
|
+
*/
|
|
1453
|
+
export interface VideoBlock {
|
|
1454
|
+
/**
|
|
1455
|
+
* <p>The block's format.</p>
|
|
1456
|
+
* @public
|
|
1457
|
+
*/
|
|
1458
|
+
format: VideoFormat | undefined;
|
|
1459
|
+
/**
|
|
1460
|
+
* <p>The block's source.</p>
|
|
1461
|
+
* @public
|
|
1462
|
+
*/
|
|
1463
|
+
source: VideoSource | undefined;
|
|
1464
|
+
}
|
|
1031
1465
|
/**
|
|
1032
1466
|
* <p>The tool result content block.</p>
|
|
1033
1467
|
* @public
|
|
1034
1468
|
*/
|
|
1035
|
-
export type ToolResultContentBlock = ToolResultContentBlock.DocumentMember | ToolResultContentBlock.ImageMember | ToolResultContentBlock.JsonMember | ToolResultContentBlock.TextMember | ToolResultContentBlock.$UnknownMember;
|
|
1469
|
+
export type ToolResultContentBlock = ToolResultContentBlock.DocumentMember | ToolResultContentBlock.ImageMember | ToolResultContentBlock.JsonMember | ToolResultContentBlock.TextMember | ToolResultContentBlock.VideoMember | ToolResultContentBlock.$UnknownMember;
|
|
1036
1470
|
/**
|
|
1037
1471
|
* @public
|
|
1038
1472
|
*/
|
|
@@ -1046,6 +1480,7 @@ export declare namespace ToolResultContentBlock {
|
|
|
1046
1480
|
text?: never;
|
|
1047
1481
|
image?: never;
|
|
1048
1482
|
document?: never;
|
|
1483
|
+
video?: never;
|
|
1049
1484
|
$unknown?: never;
|
|
1050
1485
|
}
|
|
1051
1486
|
/**
|
|
@@ -1057,6 +1492,7 @@ export declare namespace ToolResultContentBlock {
|
|
|
1057
1492
|
text: string;
|
|
1058
1493
|
image?: never;
|
|
1059
1494
|
document?: never;
|
|
1495
|
+
video?: never;
|
|
1060
1496
|
$unknown?: never;
|
|
1061
1497
|
}
|
|
1062
1498
|
/**
|
|
@@ -1071,6 +1507,7 @@ export declare namespace ToolResultContentBlock {
|
|
|
1071
1507
|
text?: never;
|
|
1072
1508
|
image: ImageBlock;
|
|
1073
1509
|
document?: never;
|
|
1510
|
+
video?: never;
|
|
1074
1511
|
$unknown?: never;
|
|
1075
1512
|
}
|
|
1076
1513
|
/**
|
|
@@ -1082,6 +1519,19 @@ export declare namespace ToolResultContentBlock {
|
|
|
1082
1519
|
text?: never;
|
|
1083
1520
|
image?: never;
|
|
1084
1521
|
document: DocumentBlock;
|
|
1522
|
+
video?: never;
|
|
1523
|
+
$unknown?: never;
|
|
1524
|
+
}
|
|
1525
|
+
/**
|
|
1526
|
+
* <p>A tool result that is video.</p>
|
|
1527
|
+
* @public
|
|
1528
|
+
*/
|
|
1529
|
+
interface VideoMember {
|
|
1530
|
+
json?: never;
|
|
1531
|
+
text?: never;
|
|
1532
|
+
image?: never;
|
|
1533
|
+
document?: never;
|
|
1534
|
+
video: VideoBlock;
|
|
1085
1535
|
$unknown?: never;
|
|
1086
1536
|
}
|
|
1087
1537
|
/**
|
|
@@ -1092,6 +1542,7 @@ export declare namespace ToolResultContentBlock {
|
|
|
1092
1542
|
text?: never;
|
|
1093
1543
|
image?: never;
|
|
1094
1544
|
document?: never;
|
|
1545
|
+
video?: never;
|
|
1095
1546
|
$unknown: [string, any];
|
|
1096
1547
|
}
|
|
1097
1548
|
interface Visitor<T> {
|
|
@@ -1099,6 +1550,7 @@ export declare namespace ToolResultContentBlock {
|
|
|
1099
1550
|
text: (value: string) => T;
|
|
1100
1551
|
image: (value: ImageBlock) => T;
|
|
1101
1552
|
document: (value: DocumentBlock) => T;
|
|
1553
|
+
video: (value: VideoBlock) => T;
|
|
1102
1554
|
_: (name: string, value: any) => T;
|
|
1103
1555
|
}
|
|
1104
1556
|
const visit: <T>(value: ToolResultContentBlock, visitor: Visitor<T>) => T;
|
|
@@ -1166,7 +1618,7 @@ export interface ToolUseBlock {
|
|
|
1166
1618
|
* <p>A block of content for a message that you pass to, or receive from, a model with the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a> or <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html">ConverseStream</a> API operations.</p>
|
|
1167
1619
|
* @public
|
|
1168
1620
|
*/
|
|
1169
|
-
export type ContentBlock = ContentBlock.DocumentMember | ContentBlock.GuardContentMember | ContentBlock.ImageMember | ContentBlock.TextMember | ContentBlock.ToolResultMember | ContentBlock.ToolUseMember | ContentBlock.$UnknownMember;
|
|
1621
|
+
export type ContentBlock = ContentBlock.DocumentMember | ContentBlock.GuardContentMember | ContentBlock.ImageMember | ContentBlock.TextMember | ContentBlock.ToolResultMember | ContentBlock.ToolUseMember | ContentBlock.VideoMember | ContentBlock.$UnknownMember;
|
|
1170
1622
|
/**
|
|
1171
1623
|
* @public
|
|
1172
1624
|
*/
|
|
@@ -1179,6 +1631,7 @@ export declare namespace ContentBlock {
|
|
|
1179
1631
|
text: string;
|
|
1180
1632
|
image?: never;
|
|
1181
1633
|
document?: never;
|
|
1634
|
+
video?: never;
|
|
1182
1635
|
toolUse?: never;
|
|
1183
1636
|
toolResult?: never;
|
|
1184
1637
|
guardContent?: never;
|
|
@@ -1195,6 +1648,7 @@ export declare namespace ContentBlock {
|
|
|
1195
1648
|
text?: never;
|
|
1196
1649
|
image: ImageBlock;
|
|
1197
1650
|
document?: never;
|
|
1651
|
+
video?: never;
|
|
1198
1652
|
toolUse?: never;
|
|
1199
1653
|
toolResult?: never;
|
|
1200
1654
|
guardContent?: never;
|
|
@@ -1208,6 +1662,21 @@ export declare namespace ContentBlock {
|
|
|
1208
1662
|
text?: never;
|
|
1209
1663
|
image?: never;
|
|
1210
1664
|
document: DocumentBlock;
|
|
1665
|
+
video?: never;
|
|
1666
|
+
toolUse?: never;
|
|
1667
|
+
toolResult?: never;
|
|
1668
|
+
guardContent?: never;
|
|
1669
|
+
$unknown?: never;
|
|
1670
|
+
}
|
|
1671
|
+
/**
|
|
1672
|
+
* <p>Video to include in the message. </p>
|
|
1673
|
+
* @public
|
|
1674
|
+
*/
|
|
1675
|
+
interface VideoMember {
|
|
1676
|
+
text?: never;
|
|
1677
|
+
image?: never;
|
|
1678
|
+
document?: never;
|
|
1679
|
+
video: VideoBlock;
|
|
1211
1680
|
toolUse?: never;
|
|
1212
1681
|
toolResult?: never;
|
|
1213
1682
|
guardContent?: never;
|
|
@@ -1221,6 +1690,7 @@ export declare namespace ContentBlock {
|
|
|
1221
1690
|
text?: never;
|
|
1222
1691
|
image?: never;
|
|
1223
1692
|
document?: never;
|
|
1693
|
+
video?: never;
|
|
1224
1694
|
toolUse: ToolUseBlock;
|
|
1225
1695
|
toolResult?: never;
|
|
1226
1696
|
guardContent?: never;
|
|
@@ -1234,6 +1704,7 @@ export declare namespace ContentBlock {
|
|
|
1234
1704
|
text?: never;
|
|
1235
1705
|
image?: never;
|
|
1236
1706
|
document?: never;
|
|
1707
|
+
video?: never;
|
|
1237
1708
|
toolUse?: never;
|
|
1238
1709
|
toolResult: ToolResultBlock;
|
|
1239
1710
|
guardContent?: never;
|
|
@@ -1252,6 +1723,7 @@ export declare namespace ContentBlock {
|
|
|
1252
1723
|
text?: never;
|
|
1253
1724
|
image?: never;
|
|
1254
1725
|
document?: never;
|
|
1726
|
+
video?: never;
|
|
1255
1727
|
toolUse?: never;
|
|
1256
1728
|
toolResult?: never;
|
|
1257
1729
|
guardContent: GuardrailConverseContentBlock;
|
|
@@ -1264,6 +1736,7 @@ export declare namespace ContentBlock {
|
|
|
1264
1736
|
text?: never;
|
|
1265
1737
|
image?: never;
|
|
1266
1738
|
document?: never;
|
|
1739
|
+
video?: never;
|
|
1267
1740
|
toolUse?: never;
|
|
1268
1741
|
toolResult?: never;
|
|
1269
1742
|
guardContent?: never;
|
|
@@ -1273,6 +1746,7 @@ export declare namespace ContentBlock {
|
|
|
1273
1746
|
text: (value: string) => T;
|
|
1274
1747
|
image: (value: ImageBlock) => T;
|
|
1275
1748
|
document: (value: DocumentBlock) => T;
|
|
1749
|
+
video: (value: VideoBlock) => T;
|
|
1276
1750
|
toolUse: (value: ToolUseBlock) => T;
|
|
1277
1751
|
toolResult: (value: ToolResultBlock) => T;
|
|
1278
1752
|
guardContent: (value: GuardrailConverseContentBlock) => T;
|
|
@@ -1322,6 +1796,29 @@ export interface Message {
|
|
|
1322
1796
|
*/
|
|
1323
1797
|
content: ContentBlock[] | undefined;
|
|
1324
1798
|
}
|
|
1799
|
+
/**
|
|
1800
|
+
* @public
|
|
1801
|
+
* @enum
|
|
1802
|
+
*/
|
|
1803
|
+
export declare const PerformanceConfigLatency: {
|
|
1804
|
+
readonly OPTIMIZED: "optimized";
|
|
1805
|
+
readonly STANDARD: "standard";
|
|
1806
|
+
};
|
|
1807
|
+
/**
|
|
1808
|
+
* @public
|
|
1809
|
+
*/
|
|
1810
|
+
export type PerformanceConfigLatency = (typeof PerformanceConfigLatency)[keyof typeof PerformanceConfigLatency];
|
|
1811
|
+
/**
|
|
1812
|
+
* <p>Performance settings for a model.</p>
|
|
1813
|
+
* @public
|
|
1814
|
+
*/
|
|
1815
|
+
export interface PerformanceConfiguration {
|
|
1816
|
+
/**
|
|
1817
|
+
* <p>To use a latency-optimized version of the model, set to <code>optimized</code>.</p>
|
|
1818
|
+
* @public
|
|
1819
|
+
*/
|
|
1820
|
+
latency?: PerformanceConfigLatency | undefined;
|
|
1821
|
+
}
|
|
1325
1822
|
/**
|
|
1326
1823
|
* <p>Contains a map of variables in a prompt from Prompt management to an object containing the values to fill in for them when running model invocation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-how.html">How Prompt management works</a>.</p>
|
|
1327
1824
|
* @public
|
|
@@ -1564,9 +2061,6 @@ export declare namespace Tool {
|
|
|
1564
2061
|
}
|
|
1565
2062
|
/**
|
|
1566
2063
|
* <p>Configuration information for the tools that you pass to a model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html">Tool use (function calling)</a> in the Amazon Bedrock User Guide.</p>
|
|
1567
|
-
* <note>
|
|
1568
|
-
* <p>This field is only supported by Anthropic Claude 3, Cohere Command R, Cohere Command R+, and Mistral Large models.</p>
|
|
1569
|
-
* </note>
|
|
1570
2064
|
* @public
|
|
1571
2065
|
*/
|
|
1572
2066
|
export interface ToolConfiguration {
|
|
@@ -1601,7 +2095,7 @@ export interface ConverseRequest {
|
|
|
1601
2095
|
* <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
|
|
1602
2096
|
* </li>
|
|
1603
2097
|
* <li>
|
|
1604
|
-
* <p>To include a prompt that was defined in Prompt management
|
|
2098
|
+
* <p>To include a prompt that was defined in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html">Prompt management</a>, specify the ARN of the prompt version to use.</p>
|
|
1605
2099
|
* </li>
|
|
1606
2100
|
* </ul>
|
|
1607
2101
|
* <p>The Converse API doesn't support <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported models</a>.</p>
|
|
@@ -1627,9 +2121,8 @@ export interface ConverseRequest {
|
|
|
1627
2121
|
inferenceConfig?: InferenceConfiguration | undefined;
|
|
1628
2122
|
/**
|
|
1629
2123
|
* <p>Configuration information for the tools that the model can use when generating a response. </p>
|
|
1630
|
-
* <
|
|
1631
|
-
*
|
|
1632
|
-
* </note>
|
|
2124
|
+
* <p>For information about models that support tool use, see
|
|
2125
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html#conversation-inference-supported-models-features">Supported models and model features</a>.</p>
|
|
1633
2126
|
* @public
|
|
1634
2127
|
*/
|
|
1635
2128
|
toolConfig?: ToolConfiguration | undefined;
|
|
@@ -1660,7 +2153,7 @@ export interface ConverseRequest {
|
|
|
1660
2153
|
* ]</code>
|
|
1661
2154
|
* </p>
|
|
1662
2155
|
* <p>For information about the JSON Pointer syntax, see the
|
|
1663
|
-
*
|
|
2156
|
+
* <a href="https://datatracker.ietf.org/doc/html/rfc6901">Internet Engineering Task Force (IETF)</a> documentation.</p>
|
|
1664
2157
|
* <p>
|
|
1665
2158
|
* <code>Converse</code> and <code>ConverseStream</code> reject an empty JSON Pointer or incorrectly structured
|
|
1666
2159
|
* JSON Pointer with a <code>400</code> error code. if the JSON Pointer is valid, but the requested
|
|
@@ -1668,6 +2161,16 @@ export interface ConverseRequest {
|
|
|
1668
2161
|
* @public
|
|
1669
2162
|
*/
|
|
1670
2163
|
additionalModelResponseFieldPaths?: string[] | undefined;
|
|
2164
|
+
/**
|
|
2165
|
+
* <p>Key-value pairs that you can use to filter invocation logs.</p>
|
|
2166
|
+
* @public
|
|
2167
|
+
*/
|
|
2168
|
+
requestMetadata?: Record<string, string> | undefined;
|
|
2169
|
+
/**
|
|
2170
|
+
* <p>Model performance settings for the request.</p>
|
|
2171
|
+
* @public
|
|
2172
|
+
*/
|
|
2173
|
+
performanceConfig?: PerformanceConfiguration | undefined;
|
|
1671
2174
|
}
|
|
1672
2175
|
/**
|
|
1673
2176
|
* <p>Metrics for a call to <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a>.</p>
|
|
@@ -1815,6 +2318,11 @@ export interface ConverseResponse {
|
|
|
1815
2318
|
* @public
|
|
1816
2319
|
*/
|
|
1817
2320
|
trace?: ConverseTrace | undefined;
|
|
2321
|
+
/**
|
|
2322
|
+
* <p>Model performance settings for the request.</p>
|
|
2323
|
+
* @public
|
|
2324
|
+
*/
|
|
2325
|
+
performanceConfig?: PerformanceConfiguration | undefined;
|
|
1818
2326
|
}
|
|
1819
2327
|
/**
|
|
1820
2328
|
* <p>The request failed due to an error while processing the model.</p>
|
|
@@ -1840,9 +2348,9 @@ export declare class ModelErrorException extends __BaseException {
|
|
|
1840
2348
|
}
|
|
1841
2349
|
/**
|
|
1842
2350
|
* <p>The model specified in the request is not ready to serve inference requests. The AWS SDK
|
|
1843
|
-
*
|
|
1844
|
-
*
|
|
1845
|
-
*
|
|
2351
|
+
* will automatically retry the operation up to 5 times. For information about configuring
|
|
2352
|
+
* automatic retries, see <a href="https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html">Retry behavior</a> in the <i>AWS SDKs and Tools</i>
|
|
2353
|
+
* reference guide.</p>
|
|
1846
2354
|
* @public
|
|
1847
2355
|
*/
|
|
1848
2356
|
export declare class ModelNotReadyException extends __BaseException {
|
|
@@ -1866,18 +2374,6 @@ export declare class ModelTimeoutException extends __BaseException {
|
|
|
1866
2374
|
*/
|
|
1867
2375
|
constructor(opts: __ExceptionOptionType<ModelTimeoutException, __BaseException>);
|
|
1868
2376
|
}
|
|
1869
|
-
/**
|
|
1870
|
-
* <p>The service isn't currently available. Try again later.</p>
|
|
1871
|
-
* @public
|
|
1872
|
-
*/
|
|
1873
|
-
export declare class ServiceUnavailableException extends __BaseException {
|
|
1874
|
-
readonly name: "ServiceUnavailableException";
|
|
1875
|
-
readonly $fault: "server";
|
|
1876
|
-
/**
|
|
1877
|
-
* @internal
|
|
1878
|
-
*/
|
|
1879
|
-
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
1880
|
-
}
|
|
1881
2377
|
/**
|
|
1882
2378
|
* @public
|
|
1883
2379
|
* @enum
|
|
@@ -1939,7 +2435,7 @@ export interface ConverseStreamRequest {
|
|
|
1939
2435
|
* <p>If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html">Use a custom model in Amazon Bedrock</a> in the Amazon Bedrock User Guide.</p>
|
|
1940
2436
|
* </li>
|
|
1941
2437
|
* <li>
|
|
1942
|
-
* <p>To include a prompt that was defined in Prompt management
|
|
2438
|
+
* <p>To include a prompt that was defined in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html">Prompt management</a>, specify the ARN of the prompt version to use.</p>
|
|
1943
2439
|
* </li>
|
|
1944
2440
|
* </ul>
|
|
1945
2441
|
* <p>The Converse API doesn't support <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html">imported models</a>.</p>
|
|
@@ -1965,9 +2461,8 @@ export interface ConverseStreamRequest {
|
|
|
1965
2461
|
inferenceConfig?: InferenceConfiguration | undefined;
|
|
1966
2462
|
/**
|
|
1967
2463
|
* <p>Configuration information for the tools that the model can use when generating a response.</p>
|
|
1968
|
-
* <
|
|
1969
|
-
* <
|
|
1970
|
-
* </note>
|
|
2464
|
+
* <p>For information about models that support streaming tool use, see
|
|
2465
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html#conversation-inference-supported-models-features">Supported models and model features</a>.</p>
|
|
1971
2466
|
* @public
|
|
1972
2467
|
*/
|
|
1973
2468
|
toolConfig?: ToolConfiguration | undefined;
|
|
@@ -1998,7 +2493,7 @@ export interface ConverseStreamRequest {
|
|
|
1998
2493
|
* ]</code>
|
|
1999
2494
|
* </p>
|
|
2000
2495
|
* <p>For information about the JSON Pointer syntax, see the
|
|
2001
|
-
*
|
|
2496
|
+
* <a href="https://datatracker.ietf.org/doc/html/rfc6901">Internet Engineering Task Force (IETF)</a> documentation.</p>
|
|
2002
2497
|
* <p>
|
|
2003
2498
|
* <code>Converse</code> and <code>ConverseStream</code> reject an empty JSON Pointer or incorrectly structured
|
|
2004
2499
|
* JSON Pointer with a <code>400</code> error code. if the JSON Pointer is valid, but the requested
|
|
@@ -2006,6 +2501,16 @@ export interface ConverseStreamRequest {
|
|
|
2006
2501
|
* @public
|
|
2007
2502
|
*/
|
|
2008
2503
|
additionalModelResponseFieldPaths?: string[] | undefined;
|
|
2504
|
+
/**
|
|
2505
|
+
* <p>Key-value pairs that you can use to filter invocation logs.</p>
|
|
2506
|
+
* @public
|
|
2507
|
+
*/
|
|
2508
|
+
requestMetadata?: Record<string, string> | undefined;
|
|
2509
|
+
/**
|
|
2510
|
+
* <p>Model performance settings for the request.</p>
|
|
2511
|
+
* @public
|
|
2512
|
+
*/
|
|
2513
|
+
performanceConfig?: PerformanceConfiguration | undefined;
|
|
2009
2514
|
}
|
|
2010
2515
|
/**
|
|
2011
2516
|
* <p>The delta for a tool use block.</p>
|
|
@@ -2218,6 +2723,11 @@ export interface ConverseStreamMetadataEvent {
|
|
|
2218
2723
|
* @public
|
|
2219
2724
|
*/
|
|
2220
2725
|
trace?: ConverseStreamTrace | undefined;
|
|
2726
|
+
/**
|
|
2727
|
+
* <p>Model performance configuration metadata for the conversation stream event.</p>
|
|
2728
|
+
* @public
|
|
2729
|
+
*/
|
|
2730
|
+
performanceConfig?: PerformanceConfiguration | undefined;
|
|
2221
2731
|
}
|
|
2222
2732
|
/**
|
|
2223
2733
|
* <p>An error occurred while streaming the response. Retry your request.</p>
|
|
@@ -2395,7 +2905,8 @@ export declare namespace ConverseStreamOutput {
|
|
|
2395
2905
|
$unknown?: never;
|
|
2396
2906
|
}
|
|
2397
2907
|
/**
|
|
2398
|
-
* <p>
|
|
2908
|
+
* <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error,
|
|
2909
|
+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide</p>
|
|
2399
2910
|
* @public
|
|
2400
2911
|
*/
|
|
2401
2912
|
interface ValidationExceptionMember {
|
|
@@ -2413,7 +2924,8 @@ export declare namespace ConverseStreamOutput {
|
|
|
2413
2924
|
$unknown?: never;
|
|
2414
2925
|
}
|
|
2415
2926
|
/**
|
|
2416
|
-
* <p>
|
|
2927
|
+
* <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For
|
|
2928
|
+
* troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide</p>
|
|
2417
2929
|
* @public
|
|
2418
2930
|
*/
|
|
2419
2931
|
interface ThrottlingExceptionMember {
|
|
@@ -2431,7 +2943,8 @@ export declare namespace ConverseStreamOutput {
|
|
|
2431
2943
|
$unknown?: never;
|
|
2432
2944
|
}
|
|
2433
2945
|
/**
|
|
2434
|
-
* <p>The service isn't currently available.
|
|
2946
|
+
* <p>The service isn't currently available. For troubleshooting this error,
|
|
2947
|
+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable">ServiceUnavailable</a> in the Amazon Bedrock User Guide</p>
|
|
2435
2948
|
* @public
|
|
2436
2949
|
*/
|
|
2437
2950
|
interface ServiceUnavailableExceptionMember {
|
|
@@ -2525,12 +3038,15 @@ export interface InvokeModelRequest {
|
|
|
2525
3038
|
accept?: string | undefined;
|
|
2526
3039
|
/**
|
|
2527
3040
|
* <p>The unique identifier of the model to invoke to run inference.</p>
|
|
2528
|
-
* <p>The <code>modelId</code> to provide depends on the type of model that you use:</p>
|
|
3041
|
+
* <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
|
|
2529
3042
|
* <ul>
|
|
2530
3043
|
* <li>
|
|
2531
3044
|
* <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p>
|
|
2532
3045
|
* </li>
|
|
2533
3046
|
* <li>
|
|
3047
|
+
* <p>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</p>
|
|
3048
|
+
* </li>
|
|
3049
|
+
* <li>
|
|
2534
3050
|
* <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
|
|
2535
3051
|
* </li>
|
|
2536
3052
|
* <li>
|
|
@@ -2571,6 +3087,11 @@ export interface InvokeModelRequest {
|
|
|
2571
3087
|
* @public
|
|
2572
3088
|
*/
|
|
2573
3089
|
guardrailVersion?: string | undefined;
|
|
3090
|
+
/**
|
|
3091
|
+
* <p>Model performance settings for the request.</p>
|
|
3092
|
+
* @public
|
|
3093
|
+
*/
|
|
3094
|
+
performanceConfigLatency?: PerformanceConfigLatency | undefined;
|
|
2574
3095
|
}
|
|
2575
3096
|
/**
|
|
2576
3097
|
* @public
|
|
@@ -2586,6 +3107,11 @@ export interface InvokeModelResponse {
|
|
|
2586
3107
|
* @public
|
|
2587
3108
|
*/
|
|
2588
3109
|
contentType: string | undefined;
|
|
3110
|
+
/**
|
|
3111
|
+
* <p>Model performance settings for the request.</p>
|
|
3112
|
+
* @public
|
|
3113
|
+
*/
|
|
3114
|
+
performanceConfigLatency?: PerformanceConfigLatency | undefined;
|
|
2589
3115
|
}
|
|
2590
3116
|
/**
|
|
2591
3117
|
* @public
|
|
@@ -2610,12 +3136,15 @@ export interface InvokeModelWithResponseStreamRequest {
|
|
|
2610
3136
|
accept?: string | undefined;
|
|
2611
3137
|
/**
|
|
2612
3138
|
* <p>The unique identifier of the model to invoke to run inference.</p>
|
|
2613
|
-
* <p>The <code>modelId</code> to provide depends on the type of model that you use:</p>
|
|
3139
|
+
* <p>The <code>modelId</code> to provide depends on the type of model or throughput that you use:</p>
|
|
2614
3140
|
* <ul>
|
|
2615
3141
|
* <li>
|
|
2616
3142
|
* <p>If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">Amazon Bedrock base model IDs (on-demand throughput)</a> in the Amazon Bedrock User Guide.</p>
|
|
2617
3143
|
* </li>
|
|
2618
3144
|
* <li>
|
|
3145
|
+
* <p>If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html">Supported Regions and models for cross-region inference</a> in the Amazon Bedrock User Guide.</p>
|
|
3146
|
+
* </li>
|
|
3147
|
+
* <li>
|
|
2619
3148
|
* <p>If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html">Run inference using a Provisioned Throughput</a> in the Amazon Bedrock User Guide.</p>
|
|
2620
3149
|
* </li>
|
|
2621
3150
|
* <li>
|
|
@@ -2656,6 +3185,11 @@ export interface InvokeModelWithResponseStreamRequest {
|
|
|
2656
3185
|
* @public
|
|
2657
3186
|
*/
|
|
2658
3187
|
guardrailVersion?: string | undefined;
|
|
3188
|
+
/**
|
|
3189
|
+
* <p>Model performance settings for the request.</p>
|
|
3190
|
+
* @public
|
|
3191
|
+
*/
|
|
3192
|
+
performanceConfigLatency?: PerformanceConfigLatency | undefined;
|
|
2659
3193
|
}
|
|
2660
3194
|
/**
|
|
2661
3195
|
* <p>Payload content included in the response.</p>
|
|
@@ -2762,7 +3296,7 @@ export declare namespace ResponseStream {
|
|
|
2762
3296
|
$unknown?: never;
|
|
2763
3297
|
}
|
|
2764
3298
|
/**
|
|
2765
|
-
* <p>The service isn't
|
|
3299
|
+
* <p>The service isn't available. Try again later.</p>
|
|
2766
3300
|
* @public
|
|
2767
3301
|
*/
|
|
2768
3302
|
interface ServiceUnavailableExceptionMember {
|
|
@@ -2814,7 +3348,28 @@ export interface InvokeModelWithResponseStreamResponse {
|
|
|
2814
3348
|
* @public
|
|
2815
3349
|
*/
|
|
2816
3350
|
contentType: string | undefined;
|
|
3351
|
+
/**
|
|
3352
|
+
* <p>Model performance settings for the request.</p>
|
|
3353
|
+
* @public
|
|
3354
|
+
*/
|
|
3355
|
+
performanceConfigLatency?: PerformanceConfigLatency | undefined;
|
|
2817
3356
|
}
|
|
3357
|
+
/**
|
|
3358
|
+
* @internal
|
|
3359
|
+
*/
|
|
3360
|
+
export declare const GetAsyncInvokeResponseFilterSensitiveLog: (obj: GetAsyncInvokeResponse) => any;
|
|
3361
|
+
/**
|
|
3362
|
+
* @internal
|
|
3363
|
+
*/
|
|
3364
|
+
export declare const AsyncInvokeSummaryFilterSensitiveLog: (obj: AsyncInvokeSummary) => any;
|
|
3365
|
+
/**
|
|
3366
|
+
* @internal
|
|
3367
|
+
*/
|
|
3368
|
+
export declare const ListAsyncInvokesResponseFilterSensitiveLog: (obj: ListAsyncInvokesResponse) => any;
|
|
3369
|
+
/**
|
|
3370
|
+
* @internal
|
|
3371
|
+
*/
|
|
3372
|
+
export declare const StartAsyncInvokeRequestFilterSensitiveLog: (obj: StartAsyncInvokeRequest) => any;
|
|
2818
3373
|
/**
|
|
2819
3374
|
* @internal
|
|
2820
3375
|
*/
|