@aws-sdk/client-bedrock 3.934.0 → 3.935.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.js +389 -389
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +355 -0
- package/dist-es/models/errors.js +123 -0
- package/dist-es/models/models_0.js +1 -355
- package/dist-es/models/models_1.js +1 -123
- package/dist-es/schemas/schemas_0.js +1 -1
- package/dist-types/commands/CreateGuardrailCommand.d.ts +1 -1
- package/dist-types/commands/CreateGuardrailVersionCommand.d.ts +1 -1
- package/dist-types/commands/CreateInferenceProfileCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGuardrailCommand.d.ts +1 -1
- package/dist-types/commands/DeleteInferenceProfileCommand.d.ts +1 -1
- package/dist-types/commands/DeleteModelInvocationLoggingConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetGuardrailCommand.d.ts +1 -1
- package/dist-types/commands/GetInferenceProfileCommand.d.ts +1 -1
- package/dist-types/commands/GetModelInvocationLoggingConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/ListGuardrailsCommand.d.ts +1 -1
- package/dist-types/commands/ListInferenceProfilesCommand.d.ts +1 -1
- package/dist-types/commands/PutModelInvocationLoggingConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateGuardrailCommand.d.ts +1 -1
- package/dist-types/index.d.ts +4 -1
- package/dist-types/models/enums.d.ts +891 -0
- package/dist-types/models/errors.d.ts +127 -0
- package/dist-types/models/models_0.d.ts +1306 -696
- package/dist-types/models/models_1.d.ts +2 -1628
- package/dist-types/ts3.4/commands/CreateGuardrailCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateGuardrailVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateInferenceProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteGuardrailCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteInferenceProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteModelInvocationLoggingConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetGuardrailCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInferenceProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetModelInvocationLoggingConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListGuardrailsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListInferenceProfilesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutModelInvocationLoggingConfigurationCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateGuardrailCommand.d.ts +1 -1
- package/dist-types/ts3.4/index.d.ts +4 -1
- package/dist-types/ts3.4/models/enums.d.ts +478 -0
- package/dist-types/ts3.4/models/errors.d.ts +71 -0
- package/dist-types/ts3.4/models/models_0.d.ts +371 -380
- package/dist-types/ts3.4/models/models_1.d.ts +30 -520
- package/package.json +13 -13
- package/dist-es/models/index.js +0 -2
- package/dist-types/models/index.d.ts +0 -2
- package/dist-types/ts3.4/models/index.d.ts +0 -2
|
@@ -1,1370 +1,5 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
* <p>Contains details about topics that the guardrail should identify and deny.</p>
|
|
4
|
-
* @public
|
|
5
|
-
*/
|
|
6
|
-
export interface GuardrailTopicPolicyConfig {
|
|
7
|
-
/**
|
|
8
|
-
* <p>A list of policies related to topics that the guardrail should deny.</p>
|
|
9
|
-
* @public
|
|
10
|
-
*/
|
|
11
|
-
topicsConfig: GuardrailTopicConfig[] | undefined;
|
|
12
|
-
/**
|
|
13
|
-
* <p>The tier that your guardrail uses for denied topic filters.</p>
|
|
14
|
-
* @public
|
|
15
|
-
*/
|
|
16
|
-
tierConfig?: GuardrailTopicsTierConfig | undefined;
|
|
17
|
-
}
|
|
18
|
-
/**
|
|
19
|
-
* @public
|
|
20
|
-
* @enum
|
|
21
|
-
*/
|
|
22
|
-
export declare const GuardrailWordAction: {
|
|
23
|
-
readonly BLOCK: "BLOCK";
|
|
24
|
-
readonly NONE: "NONE";
|
|
25
|
-
};
|
|
26
|
-
/**
|
|
27
|
-
* @public
|
|
28
|
-
*/
|
|
29
|
-
export type GuardrailWordAction = (typeof GuardrailWordAction)[keyof typeof GuardrailWordAction];
|
|
30
|
-
/**
|
|
31
|
-
* @public
|
|
32
|
-
* @enum
|
|
33
|
-
*/
|
|
34
|
-
export declare const GuardrailManagedWordsType: {
|
|
35
|
-
readonly PROFANITY: "PROFANITY";
|
|
36
|
-
};
|
|
37
|
-
/**
|
|
38
|
-
* @public
|
|
39
|
-
*/
|
|
40
|
-
export type GuardrailManagedWordsType = (typeof GuardrailManagedWordsType)[keyof typeof GuardrailManagedWordsType];
|
|
41
|
-
/**
|
|
42
|
-
* <p>The managed word list to configure for the guardrail.</p>
|
|
43
|
-
* @public
|
|
44
|
-
*/
|
|
45
|
-
export interface GuardrailManagedWordsConfig {
|
|
46
|
-
/**
|
|
47
|
-
* <p>The managed word type to configure for the guardrail.</p>
|
|
48
|
-
* @public
|
|
49
|
-
*/
|
|
50
|
-
type: GuardrailManagedWordsType | undefined;
|
|
51
|
-
/**
|
|
52
|
-
* <p>Specifies the action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
53
|
-
* @public
|
|
54
|
-
*/
|
|
55
|
-
inputAction?: GuardrailWordAction | undefined;
|
|
56
|
-
/**
|
|
57
|
-
* <p>Specifies the action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
58
|
-
* @public
|
|
59
|
-
*/
|
|
60
|
-
outputAction?: GuardrailWordAction | undefined;
|
|
61
|
-
/**
|
|
62
|
-
* <p>Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
63
|
-
* @public
|
|
64
|
-
*/
|
|
65
|
-
inputEnabled?: boolean | undefined;
|
|
66
|
-
/**
|
|
67
|
-
* <p>Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
68
|
-
* @public
|
|
69
|
-
*/
|
|
70
|
-
outputEnabled?: boolean | undefined;
|
|
71
|
-
}
|
|
72
|
-
/**
|
|
73
|
-
* <p>A word to configure for the guardrail.</p>
|
|
74
|
-
* @public
|
|
75
|
-
*/
|
|
76
|
-
export interface GuardrailWordConfig {
|
|
77
|
-
/**
|
|
78
|
-
* <p>Text of the word configured for the guardrail to block.</p>
|
|
79
|
-
* @public
|
|
80
|
-
*/
|
|
81
|
-
text: string | undefined;
|
|
82
|
-
/**
|
|
83
|
-
* <p>Specifies the action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
84
|
-
* @public
|
|
85
|
-
*/
|
|
86
|
-
inputAction?: GuardrailWordAction | undefined;
|
|
87
|
-
/**
|
|
88
|
-
* <p>Specifies the action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
89
|
-
* @public
|
|
90
|
-
*/
|
|
91
|
-
outputAction?: GuardrailWordAction | undefined;
|
|
92
|
-
/**
|
|
93
|
-
* <p>Specifies whether to enable guardrail evaluation on the intput. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
94
|
-
* @public
|
|
95
|
-
*/
|
|
96
|
-
inputEnabled?: boolean | undefined;
|
|
97
|
-
/**
|
|
98
|
-
* <p>Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
99
|
-
* @public
|
|
100
|
-
*/
|
|
101
|
-
outputEnabled?: boolean | undefined;
|
|
102
|
-
}
|
|
103
|
-
/**
|
|
104
|
-
* <p>Contains details about the word policy to configured for the guardrail.</p>
|
|
105
|
-
* @public
|
|
106
|
-
*/
|
|
107
|
-
export interface GuardrailWordPolicyConfig {
|
|
108
|
-
/**
|
|
109
|
-
* <p>A list of words to configure for the guardrail.</p>
|
|
110
|
-
* @public
|
|
111
|
-
*/
|
|
112
|
-
wordsConfig?: GuardrailWordConfig[] | undefined;
|
|
113
|
-
/**
|
|
114
|
-
* <p>A list of managed words to configure for the guardrail.</p>
|
|
115
|
-
* @public
|
|
116
|
-
*/
|
|
117
|
-
managedWordListsConfig?: GuardrailManagedWordsConfig[] | undefined;
|
|
118
|
-
}
|
|
119
|
-
/**
|
|
120
|
-
* @public
|
|
121
|
-
*/
|
|
122
|
-
export interface CreateGuardrailRequest {
|
|
123
|
-
/**
|
|
124
|
-
* <p>The name to give the guardrail.</p>
|
|
125
|
-
* @public
|
|
126
|
-
*/
|
|
127
|
-
name: string | undefined;
|
|
128
|
-
/**
|
|
129
|
-
* <p>A description of the guardrail.</p>
|
|
130
|
-
* @public
|
|
131
|
-
*/
|
|
132
|
-
description?: string | undefined;
|
|
133
|
-
/**
|
|
134
|
-
* <p>The topic policies to configure for the guardrail.</p>
|
|
135
|
-
* @public
|
|
136
|
-
*/
|
|
137
|
-
topicPolicyConfig?: GuardrailTopicPolicyConfig | undefined;
|
|
138
|
-
/**
|
|
139
|
-
* <p>The content filter policies to configure for the guardrail.</p>
|
|
140
|
-
* @public
|
|
141
|
-
*/
|
|
142
|
-
contentPolicyConfig?: GuardrailContentPolicyConfig | undefined;
|
|
143
|
-
/**
|
|
144
|
-
* <p>The word policy you configure for the guardrail.</p>
|
|
145
|
-
* @public
|
|
146
|
-
*/
|
|
147
|
-
wordPolicyConfig?: GuardrailWordPolicyConfig | undefined;
|
|
148
|
-
/**
|
|
149
|
-
* <p>The sensitive information policy to configure for the guardrail.</p>
|
|
150
|
-
* @public
|
|
151
|
-
*/
|
|
152
|
-
sensitiveInformationPolicyConfig?: GuardrailSensitiveInformationPolicyConfig | undefined;
|
|
153
|
-
/**
|
|
154
|
-
* <p>The contextual grounding policy configuration used to create a guardrail.</p>
|
|
155
|
-
* @public
|
|
156
|
-
*/
|
|
157
|
-
contextualGroundingPolicyConfig?: GuardrailContextualGroundingPolicyConfig | undefined;
|
|
158
|
-
/**
|
|
159
|
-
* <p>Optional configuration for integrating Automated Reasoning policies with the new guardrail.</p>
|
|
160
|
-
* @public
|
|
161
|
-
*/
|
|
162
|
-
automatedReasoningPolicyConfig?: GuardrailAutomatedReasoningPolicyConfig | undefined;
|
|
163
|
-
/**
|
|
164
|
-
* <p>The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">Amazon Bedrock User Guide</a>.</p>
|
|
165
|
-
* @public
|
|
166
|
-
*/
|
|
167
|
-
crossRegionConfig?: GuardrailCrossRegionConfig | undefined;
|
|
168
|
-
/**
|
|
169
|
-
* <p>The message to return when the guardrail blocks a prompt.</p>
|
|
170
|
-
* @public
|
|
171
|
-
*/
|
|
172
|
-
blockedInputMessaging: string | undefined;
|
|
173
|
-
/**
|
|
174
|
-
* <p>The message to return when the guardrail blocks a model response.</p>
|
|
175
|
-
* @public
|
|
176
|
-
*/
|
|
177
|
-
blockedOutputsMessaging: string | undefined;
|
|
178
|
-
/**
|
|
179
|
-
* <p>The ARN of the KMS key that you use to encrypt the guardrail.</p>
|
|
180
|
-
* @public
|
|
181
|
-
*/
|
|
182
|
-
kmsKeyId?: string | undefined;
|
|
183
|
-
/**
|
|
184
|
-
* <p>The tags that you want to attach to the guardrail. </p>
|
|
185
|
-
* @public
|
|
186
|
-
*/
|
|
187
|
-
tags?: Tag[] | undefined;
|
|
188
|
-
/**
|
|
189
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, 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> in the <i>Amazon S3 User Guide</i>.</p>
|
|
190
|
-
* @public
|
|
191
|
-
*/
|
|
192
|
-
clientRequestToken?: string | undefined;
|
|
193
|
-
}
|
|
194
|
-
/**
|
|
195
|
-
* @public
|
|
196
|
-
*/
|
|
197
|
-
export interface CreateGuardrailResponse {
|
|
198
|
-
/**
|
|
199
|
-
* <p>The unique identifier of the guardrail that was created.</p>
|
|
200
|
-
* @public
|
|
201
|
-
*/
|
|
202
|
-
guardrailId: string | undefined;
|
|
203
|
-
/**
|
|
204
|
-
* <p>The ARN of the guardrail.</p>
|
|
205
|
-
* @public
|
|
206
|
-
*/
|
|
207
|
-
guardrailArn: string | undefined;
|
|
208
|
-
/**
|
|
209
|
-
* <p>The version of the guardrail that was created. This value will always be <code>DRAFT</code>.</p>
|
|
210
|
-
* @public
|
|
211
|
-
*/
|
|
212
|
-
version: string | undefined;
|
|
213
|
-
/**
|
|
214
|
-
* <p>The time at which the guardrail was created.</p>
|
|
215
|
-
* @public
|
|
216
|
-
*/
|
|
217
|
-
createdAt: Date | undefined;
|
|
218
|
-
}
|
|
219
|
-
/**
|
|
220
|
-
* @public
|
|
221
|
-
*/
|
|
222
|
-
export interface CreateGuardrailVersionRequest {
|
|
223
|
-
/**
|
|
224
|
-
* <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
|
|
225
|
-
* @public
|
|
226
|
-
*/
|
|
227
|
-
guardrailIdentifier: string | undefined;
|
|
228
|
-
/**
|
|
229
|
-
* <p>A description of the guardrail version.</p>
|
|
230
|
-
* @public
|
|
231
|
-
*/
|
|
232
|
-
description?: string | undefined;
|
|
233
|
-
/**
|
|
234
|
-
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, 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> in the <i>Amazon S3 User Guide</i>.</p>
|
|
235
|
-
* @public
|
|
236
|
-
*/
|
|
237
|
-
clientRequestToken?: string | undefined;
|
|
238
|
-
}
|
|
239
|
-
/**
|
|
240
|
-
* @public
|
|
241
|
-
*/
|
|
242
|
-
export interface CreateGuardrailVersionResponse {
|
|
243
|
-
/**
|
|
244
|
-
* <p>The unique identifier of the guardrail.</p>
|
|
245
|
-
* @public
|
|
246
|
-
*/
|
|
247
|
-
guardrailId: string | undefined;
|
|
248
|
-
/**
|
|
249
|
-
* <p>The number of the version of the guardrail.</p>
|
|
250
|
-
* @public
|
|
251
|
-
*/
|
|
252
|
-
version: string | undefined;
|
|
253
|
-
}
|
|
254
|
-
/**
|
|
255
|
-
* @public
|
|
256
|
-
*/
|
|
257
|
-
export interface DeleteGuardrailRequest {
|
|
258
|
-
/**
|
|
259
|
-
* <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
|
|
260
|
-
* @public
|
|
261
|
-
*/
|
|
262
|
-
guardrailIdentifier: string | undefined;
|
|
263
|
-
/**
|
|
264
|
-
* <p>The version of the guardrail.</p>
|
|
265
|
-
* @public
|
|
266
|
-
*/
|
|
267
|
-
guardrailVersion?: string | undefined;
|
|
268
|
-
}
|
|
269
|
-
/**
|
|
270
|
-
* @public
|
|
271
|
-
*/
|
|
272
|
-
export interface DeleteGuardrailResponse {
|
|
273
|
-
}
|
|
274
|
-
/**
|
|
275
|
-
* @public
|
|
276
|
-
*/
|
|
277
|
-
export interface GetGuardrailRequest {
|
|
278
|
-
/**
|
|
279
|
-
* <p>The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.</p>
|
|
280
|
-
* @public
|
|
281
|
-
*/
|
|
282
|
-
guardrailIdentifier: string | undefined;
|
|
283
|
-
/**
|
|
284
|
-
* <p>The version of the guardrail for which to get details. If you don't specify a version, the response returns details for the <code>DRAFT</code> version.</p>
|
|
285
|
-
* @public
|
|
286
|
-
*/
|
|
287
|
-
guardrailVersion?: string | undefined;
|
|
288
|
-
}
|
|
289
|
-
/**
|
|
290
|
-
* <p>Represents the configuration of Automated Reasoning policies within a Amazon Bedrock Guardrail, including the policies to apply and confidence thresholds.</p>
|
|
291
|
-
* @public
|
|
292
|
-
*/
|
|
293
|
-
export interface GuardrailAutomatedReasoningPolicy {
|
|
294
|
-
/**
|
|
295
|
-
* <p>The list of Automated Reasoning policy ARNs that should be applied as part of this guardrail configuration.</p>
|
|
296
|
-
* @public
|
|
297
|
-
*/
|
|
298
|
-
policies: string[] | undefined;
|
|
299
|
-
/**
|
|
300
|
-
* <p>The minimum confidence level required for Automated Reasoning policy violations to trigger guardrail actions. Values range from 0.0 to 1.0.</p>
|
|
301
|
-
* @public
|
|
302
|
-
*/
|
|
303
|
-
confidenceThreshold?: number | undefined;
|
|
304
|
-
}
|
|
305
|
-
/**
|
|
306
|
-
* <p>Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.</p> <ul> <li> <p> <b>Hate</b> – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).</p> </li> <li> <p> <b>Insults</b> – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.</p> </li> <li> <p> <b>Sexual</b> – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.</p> </li> <li> <p> <b>Violence</b> – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.</p> </li> </ul> <p>Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as <i>Hate</i> with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as <i>Hate</i> with HIGH confidence, <i>Insults</i> with LOW confidence, <i>Sexual</i> with NONE confidence, and <i>Violence</i> with MEDIUM confidence.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html">Guardrails content filters</a>.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
|
|
307
|
-
* @public
|
|
308
|
-
*/
|
|
309
|
-
export interface GuardrailContentFilter {
|
|
310
|
-
/**
|
|
311
|
-
* <p>The harmful category that the content filter is applied to.</p>
|
|
312
|
-
* @public
|
|
313
|
-
*/
|
|
314
|
-
type: GuardrailContentFilterType | undefined;
|
|
315
|
-
/**
|
|
316
|
-
* <p>The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.</p>
|
|
317
|
-
* @public
|
|
318
|
-
*/
|
|
319
|
-
inputStrength: GuardrailFilterStrength | undefined;
|
|
320
|
-
/**
|
|
321
|
-
* <p>The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.</p>
|
|
322
|
-
* @public
|
|
323
|
-
*/
|
|
324
|
-
outputStrength: GuardrailFilterStrength | undefined;
|
|
325
|
-
/**
|
|
326
|
-
* <p>The input modalities selected for the guardrail content filter.</p>
|
|
327
|
-
* @public
|
|
328
|
-
*/
|
|
329
|
-
inputModalities?: GuardrailModality[] | undefined;
|
|
330
|
-
/**
|
|
331
|
-
* <p>The output modalities selected for the guardrail content filter.</p>
|
|
332
|
-
* @public
|
|
333
|
-
*/
|
|
334
|
-
outputModalities?: GuardrailModality[] | undefined;
|
|
335
|
-
/**
|
|
336
|
-
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
337
|
-
* @public
|
|
338
|
-
*/
|
|
339
|
-
inputAction?: GuardrailContentFilterAction | undefined;
|
|
340
|
-
/**
|
|
341
|
-
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
342
|
-
* @public
|
|
343
|
-
*/
|
|
344
|
-
outputAction?: GuardrailContentFilterAction | undefined;
|
|
345
|
-
/**
|
|
346
|
-
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
347
|
-
* @public
|
|
348
|
-
*/
|
|
349
|
-
inputEnabled?: boolean | undefined;
|
|
350
|
-
/**
|
|
351
|
-
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
352
|
-
* @public
|
|
353
|
-
*/
|
|
354
|
-
outputEnabled?: boolean | undefined;
|
|
355
|
-
}
|
|
356
|
-
/**
|
|
357
|
-
* <p>The tier that your guardrail uses for content filters.</p>
|
|
358
|
-
* @public
|
|
359
|
-
*/
|
|
360
|
-
export interface GuardrailContentFiltersTier {
|
|
361
|
-
/**
|
|
362
|
-
* <p>The tier that your guardrail uses for content filters. Valid values include:</p> <ul> <li> <p> <code>CLASSIC</code> tier – Provides established guardrails functionality supporting English, French, and Spanish languages.</p> </li> <li> <p> <code>STANDARD</code> tier – Provides a more robust solution than the <code>CLASSIC</code> tier and has more comprehensive language support. This tier requires that your guardrail use <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">cross-Region inference</a>.</p> </li> </ul>
|
|
363
|
-
* @public
|
|
364
|
-
*/
|
|
365
|
-
tierName: GuardrailContentFiltersTierName | undefined;
|
|
366
|
-
}
|
|
367
|
-
/**
|
|
368
|
-
* <p>Contains details about how to handle harmful content.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
|
|
369
|
-
* @public
|
|
370
|
-
*/
|
|
371
|
-
export interface GuardrailContentPolicy {
|
|
372
|
-
/**
|
|
373
|
-
* <p>Contains the type of the content filter and how strongly it should apply to prompts and model responses.</p>
|
|
374
|
-
* @public
|
|
375
|
-
*/
|
|
376
|
-
filters?: GuardrailContentFilter[] | undefined;
|
|
377
|
-
/**
|
|
378
|
-
* <p>The tier that your guardrail uses for content filters.</p>
|
|
379
|
-
* @public
|
|
380
|
-
*/
|
|
381
|
-
tier?: GuardrailContentFiltersTier | undefined;
|
|
382
|
-
}
|
|
383
|
-
/**
|
|
384
|
-
* <p>The details for the guardrails contextual grounding filter.</p>
|
|
385
|
-
* @public
|
|
386
|
-
*/
|
|
387
|
-
export interface GuardrailContextualGroundingFilter {
|
|
388
|
-
/**
|
|
389
|
-
* <p>The filter type details for the guardrails contextual grounding filter.</p>
|
|
390
|
-
* @public
|
|
391
|
-
*/
|
|
392
|
-
type: GuardrailContextualGroundingFilterType | undefined;
|
|
393
|
-
/**
|
|
394
|
-
* <p>The threshold details for the guardrails contextual grounding filter.</p>
|
|
395
|
-
* @public
|
|
396
|
-
*/
|
|
397
|
-
threshold: number | undefined;
|
|
398
|
-
/**
|
|
399
|
-
* <p>The action to take when content fails the contextual grounding evaluation. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
400
|
-
* @public
|
|
401
|
-
*/
|
|
402
|
-
action?: GuardrailContextualGroundingAction | undefined;
|
|
403
|
-
/**
|
|
404
|
-
* <p>Indicates whether contextual grounding is enabled for evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
405
|
-
* @public
|
|
406
|
-
*/
|
|
407
|
-
enabled?: boolean | undefined;
|
|
408
|
-
}
|
|
409
|
-
/**
|
|
410
|
-
* <p>The details for the guardrails contextual grounding policy.</p>
|
|
411
|
-
* @public
|
|
412
|
-
*/
|
|
413
|
-
export interface GuardrailContextualGroundingPolicy {
|
|
414
|
-
/**
|
|
415
|
-
* <p>The filter details for the guardrails contextual grounding policy.</p>
|
|
416
|
-
* @public
|
|
417
|
-
*/
|
|
418
|
-
filters: GuardrailContextualGroundingFilter[] | undefined;
|
|
419
|
-
}
|
|
420
|
-
/**
|
|
421
|
-
* <p>Contains details about the system-defined guardrail profile that you're using with your guardrail for cross-Region inference.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">Amazon Bedrock User Guide</a>.</p>
|
|
422
|
-
* @public
|
|
423
|
-
*/
|
|
424
|
-
export interface GuardrailCrossRegionDetails {
|
|
425
|
-
/**
|
|
426
|
-
* <p>The ID of the guardrail profile that your guardrail is using. Profile availability depends on your current Amazon Web Services Region. For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region-support.html">Amazon Bedrock User Guide</a>.</p>
|
|
427
|
-
* @public
|
|
428
|
-
*/
|
|
429
|
-
guardrailProfileId?: string | undefined;
|
|
430
|
-
/**
|
|
431
|
-
* <p>The Amazon Resource Name (ARN) of the guardrail profile that you're using with your guardrail.</p>
|
|
432
|
-
* @public
|
|
433
|
-
*/
|
|
434
|
-
guardrailProfileArn?: string | undefined;
|
|
435
|
-
}
|
|
436
|
-
/**
|
|
437
|
-
* <p>The PII entity configured for the guardrail.</p>
|
|
438
|
-
* @public
|
|
439
|
-
*/
|
|
440
|
-
export interface GuardrailPiiEntity {
|
|
441
|
-
/**
|
|
442
|
-
* <p>The type of PII entity. For example, Social Security Number.</p>
|
|
443
|
-
* @public
|
|
444
|
-
*/
|
|
445
|
-
type: GuardrailPiiEntityType | undefined;
|
|
446
|
-
/**
|
|
447
|
-
* <p>The configured guardrail action when PII entity is detected.</p>
|
|
448
|
-
* @public
|
|
449
|
-
*/
|
|
450
|
-
action: GuardrailSensitiveInformationAction | undefined;
|
|
451
|
-
/**
|
|
452
|
-
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>ANONYMIZE</code> – Mask the content and replace it with identifier tags.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
453
|
-
* @public
|
|
454
|
-
*/
|
|
455
|
-
inputAction?: GuardrailSensitiveInformationAction | undefined;
|
|
456
|
-
/**
|
|
457
|
-
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>ANONYMIZE</code> – Mask the content and replace it with identifier tags.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
458
|
-
* @public
|
|
459
|
-
*/
|
|
460
|
-
outputAction?: GuardrailSensitiveInformationAction | undefined;
|
|
461
|
-
/**
|
|
462
|
-
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
463
|
-
* @public
|
|
464
|
-
*/
|
|
465
|
-
inputEnabled?: boolean | undefined;
|
|
466
|
-
/**
|
|
467
|
-
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
468
|
-
* @public
|
|
469
|
-
*/
|
|
470
|
-
outputEnabled?: boolean | undefined;
|
|
471
|
-
}
|
|
472
|
-
/**
|
|
473
|
-
* <p>The regular expression configured for the guardrail.</p>
|
|
474
|
-
* @public
|
|
475
|
-
*/
|
|
476
|
-
export interface GuardrailRegex {
|
|
477
|
-
/**
|
|
478
|
-
* <p>The name of the regular expression for the guardrail.</p>
|
|
479
|
-
* @public
|
|
480
|
-
*/
|
|
481
|
-
name: string | undefined;
|
|
482
|
-
/**
|
|
483
|
-
* <p>The description of the regular expression for the guardrail.</p>
|
|
484
|
-
* @public
|
|
485
|
-
*/
|
|
486
|
-
description?: string | undefined;
|
|
487
|
-
/**
|
|
488
|
-
* <p>The pattern of the regular expression configured for the guardrail.</p>
|
|
489
|
-
* @public
|
|
490
|
-
*/
|
|
491
|
-
pattern: string | undefined;
|
|
492
|
-
/**
|
|
493
|
-
* <p>The action taken when a match to the regular expression is detected.</p>
|
|
494
|
-
* @public
|
|
495
|
-
*/
|
|
496
|
-
action: GuardrailSensitiveInformationAction | undefined;
|
|
497
|
-
/**
|
|
498
|
-
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
499
|
-
* @public
|
|
500
|
-
*/
|
|
501
|
-
inputAction?: GuardrailSensitiveInformationAction | undefined;
|
|
502
|
-
/**
|
|
503
|
-
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
504
|
-
* @public
|
|
505
|
-
*/
|
|
506
|
-
outputAction?: GuardrailSensitiveInformationAction | undefined;
|
|
507
|
-
/**
|
|
508
|
-
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
509
|
-
* @public
|
|
510
|
-
*/
|
|
511
|
-
inputEnabled?: boolean | undefined;
|
|
512
|
-
/**
|
|
513
|
-
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
514
|
-
* @public
|
|
515
|
-
*/
|
|
516
|
-
outputEnabled?: boolean | undefined;
|
|
517
|
-
}
|
|
518
|
-
/**
|
|
519
|
-
* <p>Contains details about PII entities and regular expressions configured for the guardrail.</p>
|
|
520
|
-
* @public
|
|
521
|
-
*/
|
|
522
|
-
export interface GuardrailSensitiveInformationPolicy {
|
|
523
|
-
/**
|
|
524
|
-
* <p>The list of PII entities configured for the guardrail.</p>
|
|
525
|
-
* @public
|
|
526
|
-
*/
|
|
527
|
-
piiEntities?: GuardrailPiiEntity[] | undefined;
|
|
528
|
-
/**
|
|
529
|
-
* <p>The list of regular expressions configured for the guardrail.</p>
|
|
530
|
-
* @public
|
|
531
|
-
*/
|
|
532
|
-
regexes?: GuardrailRegex[] | undefined;
|
|
533
|
-
}
|
|
534
|
-
/**
|
|
535
|
-
* @public
|
|
536
|
-
* @enum
|
|
537
|
-
*/
|
|
538
|
-
export declare const GuardrailStatus: {
|
|
539
|
-
readonly CREATING: "CREATING";
|
|
540
|
-
readonly DELETING: "DELETING";
|
|
541
|
-
readonly FAILED: "FAILED";
|
|
542
|
-
readonly READY: "READY";
|
|
543
|
-
readonly UPDATING: "UPDATING";
|
|
544
|
-
readonly VERSIONING: "VERSIONING";
|
|
545
|
-
};
|
|
546
|
-
/**
|
|
547
|
-
* @public
|
|
548
|
-
*/
|
|
549
|
-
export type GuardrailStatus = (typeof GuardrailStatus)[keyof typeof GuardrailStatus];
|
|
550
|
-
/**
|
|
551
|
-
* <p>The tier that your guardrail uses for denied topic filters.</p>
|
|
552
|
-
* @public
|
|
553
|
-
*/
|
|
554
|
-
export interface GuardrailTopicsTier {
|
|
555
|
-
/**
|
|
556
|
-
* <p>The tier that your guardrail uses for denied topic filters. Valid values include:</p> <ul> <li> <p> <code>CLASSIC</code> tier – Provides established guardrails functionality supporting English, French, and Spanish languages.</p> </li> <li> <p> <code>STANDARD</code> tier – Provides a more robust solution than the <code>CLASSIC</code> tier and has more comprehensive language support. This tier requires that your guardrail use <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">cross-Region inference</a>.</p> </li> </ul>
|
|
557
|
-
* @public
|
|
558
|
-
*/
|
|
559
|
-
tierName: GuardrailTopicsTierName | undefined;
|
|
560
|
-
}
|
|
561
|
-
/**
|
|
562
|
-
* <p>Details about topics for the guardrail to identify and deny.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
|
|
563
|
-
* @public
|
|
564
|
-
*/
|
|
565
|
-
export interface GuardrailTopic {
|
|
566
|
-
/**
|
|
567
|
-
* <p>The name of the topic to deny.</p>
|
|
568
|
-
* @public
|
|
569
|
-
*/
|
|
570
|
-
name: string | undefined;
|
|
571
|
-
/**
|
|
572
|
-
* <p>A definition of the topic to deny.</p>
|
|
573
|
-
* @public
|
|
574
|
-
*/
|
|
575
|
-
definition: string | undefined;
|
|
576
|
-
/**
|
|
577
|
-
* <p>A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.</p>
|
|
578
|
-
* @public
|
|
579
|
-
*/
|
|
580
|
-
examples?: string[] | undefined;
|
|
581
|
-
/**
|
|
582
|
-
* <p>Specifies to deny the topic.</p>
|
|
583
|
-
* @public
|
|
584
|
-
*/
|
|
585
|
-
type?: GuardrailTopicType | undefined;
|
|
586
|
-
/**
|
|
587
|
-
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
588
|
-
* @public
|
|
589
|
-
*/
|
|
590
|
-
inputAction?: GuardrailTopicAction | undefined;
|
|
591
|
-
/**
|
|
592
|
-
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
593
|
-
* @public
|
|
594
|
-
*/
|
|
595
|
-
outputAction?: GuardrailTopicAction | undefined;
|
|
596
|
-
/**
|
|
597
|
-
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
598
|
-
* @public
|
|
599
|
-
*/
|
|
600
|
-
inputEnabled?: boolean | undefined;
|
|
601
|
-
/**
|
|
602
|
-
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
603
|
-
* @public
|
|
604
|
-
*/
|
|
605
|
-
outputEnabled?: boolean | undefined;
|
|
606
|
-
}
|
|
607
|
-
/**
|
|
608
|
-
* <p>Contains details about topics that the guardrail should identify and deny.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax">GetGuardrail response body</a> </p> </li> </ul>
|
|
609
|
-
* @public
|
|
610
|
-
*/
|
|
611
|
-
export interface GuardrailTopicPolicy {
|
|
612
|
-
/**
|
|
613
|
-
* <p>A list of policies related to topics that the guardrail should deny.</p>
|
|
614
|
-
* @public
|
|
615
|
-
*/
|
|
616
|
-
topics: GuardrailTopic[] | undefined;
|
|
617
|
-
/**
|
|
618
|
-
* <p>The tier that your guardrail uses for denied topic filters.</p>
|
|
619
|
-
* @public
|
|
620
|
-
*/
|
|
621
|
-
tier?: GuardrailTopicsTier | undefined;
|
|
622
|
-
}
|
|
623
|
-
/**
|
|
624
|
-
* <p>The managed word list that was configured for the guardrail. (This is a list of words that are pre-defined and managed by guardrails only.)</p>
|
|
625
|
-
* @public
|
|
626
|
-
*/
|
|
627
|
-
export interface GuardrailManagedWords {
|
|
628
|
-
/**
|
|
629
|
-
* <p>ManagedWords$type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)</p>
|
|
630
|
-
* @public
|
|
631
|
-
*/
|
|
632
|
-
type: GuardrailManagedWordsType | undefined;
|
|
633
|
-
/**
|
|
634
|
-
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
635
|
-
* @public
|
|
636
|
-
*/
|
|
637
|
-
inputAction?: GuardrailWordAction | undefined;
|
|
638
|
-
/**
|
|
639
|
-
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
640
|
-
* @public
|
|
641
|
-
*/
|
|
642
|
-
outputAction?: GuardrailWordAction | undefined;
|
|
643
|
-
/**
|
|
644
|
-
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
645
|
-
* @public
|
|
646
|
-
*/
|
|
647
|
-
inputEnabled?: boolean | undefined;
|
|
648
|
-
/**
|
|
649
|
-
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
650
|
-
* @public
|
|
651
|
-
*/
|
|
652
|
-
outputEnabled?: boolean | undefined;
|
|
653
|
-
}
|
|
654
|
-
/**
|
|
655
|
-
* <p>A word configured for the guardrail.</p>
|
|
656
|
-
* @public
|
|
657
|
-
*/
|
|
658
|
-
export interface GuardrailWord {
|
|
659
|
-
/**
|
|
660
|
-
* <p>Text of the word configured for the guardrail to block.</p>
|
|
661
|
-
* @public
|
|
662
|
-
*/
|
|
663
|
-
text: string | undefined;
|
|
664
|
-
/**
|
|
665
|
-
* <p>The action to take when harmful content is detected in the input. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
666
|
-
* @public
|
|
667
|
-
*/
|
|
668
|
-
inputAction?: GuardrailWordAction | undefined;
|
|
669
|
-
/**
|
|
670
|
-
* <p>The action to take when harmful content is detected in the output. Supported values include:</p> <ul> <li> <p> <code>BLOCK</code> – Block the content and replace it with blocked messaging.</p> </li> <li> <p> <code>NONE</code> – Take no action but return detection information in the trace response.</p> </li> </ul>
|
|
671
|
-
* @public
|
|
672
|
-
*/
|
|
673
|
-
outputAction?: GuardrailWordAction | undefined;
|
|
674
|
-
/**
|
|
675
|
-
* <p>Indicates whether guardrail evaluation is enabled on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
676
|
-
* @public
|
|
677
|
-
*/
|
|
678
|
-
inputEnabled?: boolean | undefined;
|
|
679
|
-
/**
|
|
680
|
-
* <p>Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.</p>
|
|
681
|
-
* @public
|
|
682
|
-
*/
|
|
683
|
-
outputEnabled?: boolean | undefined;
|
|
684
|
-
}
|
|
685
|
-
/**
|
|
686
|
-
* <p>Contains details about the word policy configured for the guardrail.</p>
|
|
687
|
-
* @public
|
|
688
|
-
*/
|
|
689
|
-
export interface GuardrailWordPolicy {
|
|
690
|
-
/**
|
|
691
|
-
* <p>A list of words configured for the guardrail.</p>
|
|
692
|
-
* @public
|
|
693
|
-
*/
|
|
694
|
-
words?: GuardrailWord[] | undefined;
|
|
695
|
-
/**
|
|
696
|
-
* <p>A list of managed words configured for the guardrail.</p>
|
|
697
|
-
* @public
|
|
698
|
-
*/
|
|
699
|
-
managedWordLists?: GuardrailManagedWords[] | undefined;
|
|
700
|
-
}
|
|
701
|
-
/**
|
|
702
|
-
* @public
|
|
703
|
-
*/
|
|
704
|
-
export interface GetGuardrailResponse {
|
|
705
|
-
/**
|
|
706
|
-
* <p>The name of the guardrail.</p>
|
|
707
|
-
* @public
|
|
708
|
-
*/
|
|
709
|
-
name: string | undefined;
|
|
710
|
-
/**
|
|
711
|
-
* <p>The description of the guardrail.</p>
|
|
712
|
-
* @public
|
|
713
|
-
*/
|
|
714
|
-
description?: string | undefined;
|
|
715
|
-
/**
|
|
716
|
-
* <p>The unique identifier of the guardrail.</p>
|
|
717
|
-
* @public
|
|
718
|
-
*/
|
|
719
|
-
guardrailId: string | undefined;
|
|
720
|
-
/**
|
|
721
|
-
* <p>The ARN of the guardrail.</p>
|
|
722
|
-
* @public
|
|
723
|
-
*/
|
|
724
|
-
guardrailArn: string | undefined;
|
|
725
|
-
/**
|
|
726
|
-
* <p>The version of the guardrail.</p>
|
|
727
|
-
* @public
|
|
728
|
-
*/
|
|
729
|
-
version: string | undefined;
|
|
730
|
-
/**
|
|
731
|
-
* <p>The status of the guardrail.</p>
|
|
732
|
-
* @public
|
|
733
|
-
*/
|
|
734
|
-
status: GuardrailStatus | undefined;
|
|
735
|
-
/**
|
|
736
|
-
* <p>The topic policy that was configured for the guardrail.</p>
|
|
737
|
-
* @public
|
|
738
|
-
*/
|
|
739
|
-
topicPolicy?: GuardrailTopicPolicy | undefined;
|
|
740
|
-
/**
|
|
741
|
-
* <p>The content policy that was configured for the guardrail.</p>
|
|
742
|
-
* @public
|
|
743
|
-
*/
|
|
744
|
-
contentPolicy?: GuardrailContentPolicy | undefined;
|
|
745
|
-
/**
|
|
746
|
-
* <p>The word policy that was configured for the guardrail.</p>
|
|
747
|
-
* @public
|
|
748
|
-
*/
|
|
749
|
-
wordPolicy?: GuardrailWordPolicy | undefined;
|
|
750
|
-
/**
|
|
751
|
-
* <p>The sensitive information policy that was configured for the guardrail.</p>
|
|
752
|
-
* @public
|
|
753
|
-
*/
|
|
754
|
-
sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicy | undefined;
|
|
755
|
-
/**
|
|
756
|
-
* <p>The contextual grounding policy used in the guardrail.</p>
|
|
757
|
-
* @public
|
|
758
|
-
*/
|
|
759
|
-
contextualGroundingPolicy?: GuardrailContextualGroundingPolicy | undefined;
|
|
760
|
-
/**
|
|
761
|
-
* <p>The current Automated Reasoning policy configuration for the guardrail, if any is configured.</p>
|
|
762
|
-
* @public
|
|
763
|
-
*/
|
|
764
|
-
automatedReasoningPolicy?: GuardrailAutomatedReasoningPolicy | undefined;
|
|
765
|
-
/**
|
|
766
|
-
* <p>Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).</p>
|
|
767
|
-
* @public
|
|
768
|
-
*/
|
|
769
|
-
crossRegionDetails?: GuardrailCrossRegionDetails | undefined;
|
|
770
|
-
/**
|
|
771
|
-
* <p>The date and time at which the guardrail was created.</p>
|
|
772
|
-
* @public
|
|
773
|
-
*/
|
|
774
|
-
createdAt: Date | undefined;
|
|
775
|
-
/**
|
|
776
|
-
* <p>The date and time at which the guardrail was updated.</p>
|
|
777
|
-
* @public
|
|
778
|
-
*/
|
|
779
|
-
updatedAt: Date | undefined;
|
|
780
|
-
/**
|
|
781
|
-
* <p>Appears if the <code>status</code> is <code>FAILED</code>. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.</p>
|
|
782
|
-
* @public
|
|
783
|
-
*/
|
|
784
|
-
statusReasons?: string[] | undefined;
|
|
785
|
-
/**
|
|
786
|
-
* <p>Appears if the <code>status</code> of the guardrail is <code>FAILED</code>. A list of recommendations to carry out before retrying the request.</p>
|
|
787
|
-
* @public
|
|
788
|
-
*/
|
|
789
|
-
failureRecommendations?: string[] | undefined;
|
|
790
|
-
/**
|
|
791
|
-
* <p>The message that the guardrail returns when it blocks a prompt.</p>
|
|
792
|
-
* @public
|
|
793
|
-
*/
|
|
794
|
-
blockedInputMessaging: string | undefined;
|
|
795
|
-
/**
|
|
796
|
-
* <p>The message that the guardrail returns when it blocks a model response.</p>
|
|
797
|
-
* @public
|
|
798
|
-
*/
|
|
799
|
-
blockedOutputsMessaging: string | undefined;
|
|
800
|
-
/**
|
|
801
|
-
* <p>The ARN of the KMS key that encrypts the guardrail.</p>
|
|
802
|
-
* @public
|
|
803
|
-
*/
|
|
804
|
-
kmsKeyArn?: string | undefined;
|
|
805
|
-
}
|
|
806
|
-
/**
|
|
807
|
-
* @public
|
|
808
|
-
*/
|
|
809
|
-
export interface ListGuardrailsRequest {
|
|
810
|
-
/**
|
|
811
|
-
* <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
|
|
812
|
-
* @public
|
|
813
|
-
*/
|
|
814
|
-
guardrailIdentifier?: string | undefined;
|
|
815
|
-
/**
|
|
816
|
-
* <p>The maximum number of results to return in the response.</p>
|
|
817
|
-
* @public
|
|
818
|
-
*/
|
|
819
|
-
maxResults?: number | undefined;
|
|
820
|
-
/**
|
|
821
|
-
* <p>If there are more results than were returned in the response, the response returns a <code>nextToken</code> that you can send in another <code>ListGuardrails</code> request to see the next batch of results.</p>
|
|
822
|
-
* @public
|
|
823
|
-
*/
|
|
824
|
-
nextToken?: string | undefined;
|
|
825
|
-
}
|
|
826
|
-
/**
|
|
827
|
-
* <p>Contains details about a guardrail.</p> <p>This data type is used in the following API operations:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListGuardrails.html#API_ListGuardrails_ResponseSyntax">ListGuardrails response body</a> </p> </li> </ul>
|
|
828
|
-
* @public
|
|
829
|
-
*/
|
|
830
|
-
export interface GuardrailSummary {
|
|
831
|
-
/**
|
|
832
|
-
* <p>The unique identifier of the guardrail.</p>
|
|
833
|
-
* @public
|
|
834
|
-
*/
|
|
835
|
-
id: string | undefined;
|
|
836
|
-
/**
|
|
837
|
-
* <p>The ARN of the guardrail.</p>
|
|
838
|
-
* @public
|
|
839
|
-
*/
|
|
840
|
-
arn: string | undefined;
|
|
841
|
-
/**
|
|
842
|
-
* <p>The status of the guardrail.</p>
|
|
843
|
-
* @public
|
|
844
|
-
*/
|
|
845
|
-
status: GuardrailStatus | undefined;
|
|
846
|
-
/**
|
|
847
|
-
* <p>The name of the guardrail.</p>
|
|
848
|
-
* @public
|
|
849
|
-
*/
|
|
850
|
-
name: string | undefined;
|
|
851
|
-
/**
|
|
852
|
-
* <p>A description of the guardrail.</p>
|
|
853
|
-
* @public
|
|
854
|
-
*/
|
|
855
|
-
description?: string | undefined;
|
|
856
|
-
/**
|
|
857
|
-
* <p>The version of the guardrail.</p>
|
|
858
|
-
* @public
|
|
859
|
-
*/
|
|
860
|
-
version: string | undefined;
|
|
861
|
-
/**
|
|
862
|
-
* <p>The date and time at which the guardrail was created.</p>
|
|
863
|
-
* @public
|
|
864
|
-
*/
|
|
865
|
-
createdAt: Date | undefined;
|
|
866
|
-
/**
|
|
867
|
-
* <p>The date and time at which the guardrail was last updated.</p>
|
|
868
|
-
* @public
|
|
869
|
-
*/
|
|
870
|
-
updatedAt: Date | undefined;
|
|
871
|
-
/**
|
|
872
|
-
* <p>Details about the system-defined guardrail profile that you're using with your guardrail, including the guardrail profile ID and Amazon Resource Name (ARN).</p>
|
|
873
|
-
* @public
|
|
874
|
-
*/
|
|
875
|
-
crossRegionDetails?: GuardrailCrossRegionDetails | undefined;
|
|
876
|
-
}
|
|
877
|
-
/**
|
|
878
|
-
* @public
|
|
879
|
-
*/
|
|
880
|
-
export interface ListGuardrailsResponse {
|
|
881
|
-
/**
|
|
882
|
-
* <p>A list of objects, each of which contains details about a guardrail.</p>
|
|
883
|
-
* @public
|
|
884
|
-
*/
|
|
885
|
-
guardrails: GuardrailSummary[] | undefined;
|
|
886
|
-
/**
|
|
887
|
-
* <p>If there are more results than were returned in the response, the response returns a <code>nextToken</code> that you can send in another <code>ListGuardrails</code> request to see the next batch of results.</p>
|
|
888
|
-
* @public
|
|
889
|
-
*/
|
|
890
|
-
nextToken?: string | undefined;
|
|
891
|
-
}
|
|
892
|
-
/**
|
|
893
|
-
* @public
|
|
894
|
-
*/
|
|
895
|
-
export interface UpdateGuardrailRequest {
|
|
896
|
-
/**
|
|
897
|
-
* <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
|
|
898
|
-
* @public
|
|
899
|
-
*/
|
|
900
|
-
guardrailIdentifier: string | undefined;
|
|
901
|
-
/**
|
|
902
|
-
* <p>A name for the guardrail.</p>
|
|
903
|
-
* @public
|
|
904
|
-
*/
|
|
905
|
-
name: string | undefined;
|
|
906
|
-
/**
|
|
907
|
-
* <p>A description of the guardrail.</p>
|
|
908
|
-
* @public
|
|
909
|
-
*/
|
|
910
|
-
description?: string | undefined;
|
|
911
|
-
/**
|
|
912
|
-
* <p>The topic policy to configure for the guardrail.</p>
|
|
913
|
-
* @public
|
|
914
|
-
*/
|
|
915
|
-
topicPolicyConfig?: GuardrailTopicPolicyConfig | undefined;
|
|
916
|
-
/**
|
|
917
|
-
* <p>The content policy to configure for the guardrail.</p>
|
|
918
|
-
* @public
|
|
919
|
-
*/
|
|
920
|
-
contentPolicyConfig?: GuardrailContentPolicyConfig | undefined;
|
|
921
|
-
/**
|
|
922
|
-
* <p>The word policy to configure for the guardrail.</p>
|
|
923
|
-
* @public
|
|
924
|
-
*/
|
|
925
|
-
wordPolicyConfig?: GuardrailWordPolicyConfig | undefined;
|
|
926
|
-
/**
|
|
927
|
-
* <p>The sensitive information policy to configure for the guardrail.</p>
|
|
928
|
-
* @public
|
|
929
|
-
*/
|
|
930
|
-
sensitiveInformationPolicyConfig?: GuardrailSensitiveInformationPolicyConfig | undefined;
|
|
931
|
-
/**
|
|
932
|
-
* <p>The contextual grounding policy configuration used to update a guardrail.</p>
|
|
933
|
-
* @public
|
|
934
|
-
*/
|
|
935
|
-
contextualGroundingPolicyConfig?: GuardrailContextualGroundingPolicyConfig | undefined;
|
|
936
|
-
/**
|
|
937
|
-
* <p>Updated configuration for Automated Reasoning policies associated with the guardrail.</p>
|
|
938
|
-
* @public
|
|
939
|
-
*/
|
|
940
|
-
automatedReasoningPolicyConfig?: GuardrailAutomatedReasoningPolicyConfig | undefined;
|
|
941
|
-
/**
|
|
942
|
-
* <p>The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination Amazon Web Services Regions where guardrail inference requests can be automatically routed.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html">Amazon Bedrock User Guide</a>.</p>
|
|
943
|
-
* @public
|
|
944
|
-
*/
|
|
945
|
-
crossRegionConfig?: GuardrailCrossRegionConfig | undefined;
|
|
946
|
-
/**
|
|
947
|
-
* <p>The message to return when the guardrail blocks a prompt.</p>
|
|
948
|
-
* @public
|
|
949
|
-
*/
|
|
950
|
-
blockedInputMessaging: string | undefined;
|
|
951
|
-
/**
|
|
952
|
-
* <p>The message to return when the guardrail blocks a model response.</p>
|
|
953
|
-
* @public
|
|
954
|
-
*/
|
|
955
|
-
blockedOutputsMessaging: string | undefined;
|
|
956
|
-
/**
|
|
957
|
-
* <p>The ARN of the KMS key with which to encrypt the guardrail.</p>
|
|
958
|
-
* @public
|
|
959
|
-
*/
|
|
960
|
-
kmsKeyId?: string | undefined;
|
|
961
|
-
}
|
|
962
|
-
/**
|
|
963
|
-
* @public
|
|
964
|
-
*/
|
|
965
|
-
export interface UpdateGuardrailResponse {
|
|
966
|
-
/**
|
|
967
|
-
* <p>The unique identifier of the guardrail</p>
|
|
968
|
-
* @public
|
|
969
|
-
*/
|
|
970
|
-
guardrailId: string | undefined;
|
|
971
|
-
/**
|
|
972
|
-
* <p>The ARN of the guardrail.</p>
|
|
973
|
-
* @public
|
|
974
|
-
*/
|
|
975
|
-
guardrailArn: string | undefined;
|
|
976
|
-
/**
|
|
977
|
-
* <p>The version of the guardrail.</p>
|
|
978
|
-
* @public
|
|
979
|
-
*/
|
|
980
|
-
version: string | undefined;
|
|
981
|
-
/**
|
|
982
|
-
* <p>The date and time at which the guardrail was updated.</p>
|
|
983
|
-
* @public
|
|
984
|
-
*/
|
|
985
|
-
updatedAt: Date | undefined;
|
|
986
|
-
}
|
|
987
|
-
/**
|
|
988
|
-
* <p>Contains information about the model or system-defined inference profile that is the source for an inference profile..</p>
|
|
989
|
-
* @public
|
|
990
|
-
*/
|
|
991
|
-
export type InferenceProfileModelSource = InferenceProfileModelSource.CopyFromMember | InferenceProfileModelSource.$UnknownMember;
|
|
992
|
-
/**
|
|
993
|
-
* @public
|
|
994
|
-
*/
|
|
995
|
-
export declare namespace InferenceProfileModelSource {
|
|
996
|
-
/**
|
|
997
|
-
* <p>The ARN of the model or system-defined inference profile that is the source for the inference profile.</p>
|
|
998
|
-
* @public
|
|
999
|
-
*/
|
|
1000
|
-
interface CopyFromMember {
|
|
1001
|
-
copyFrom: string;
|
|
1002
|
-
$unknown?: never;
|
|
1003
|
-
}
|
|
1004
|
-
/**
|
|
1005
|
-
* @public
|
|
1006
|
-
*/
|
|
1007
|
-
interface $UnknownMember {
|
|
1008
|
-
copyFrom?: never;
|
|
1009
|
-
$unknown: [string, any];
|
|
1010
|
-
}
|
|
1011
|
-
/**
|
|
1012
|
-
* @deprecated unused in schema-serde mode.
|
|
1013
|
-
*
|
|
1014
|
-
*/
|
|
1015
|
-
interface Visitor<T> {
|
|
1016
|
-
copyFrom: (value: string) => T;
|
|
1017
|
-
_: (name: string, value: any) => T;
|
|
1018
|
-
}
|
|
1019
|
-
}
|
|
1020
|
-
/**
|
|
1021
|
-
* @public
|
|
1022
|
-
*/
|
|
1023
|
-
export interface CreateInferenceProfileRequest {
|
|
1024
|
-
/**
|
|
1025
|
-
* <p>A name for the inference profile.</p>
|
|
1026
|
-
* @public
|
|
1027
|
-
*/
|
|
1028
|
-
inferenceProfileName: string | undefined;
|
|
1029
|
-
/**
|
|
1030
|
-
* <p>A description for the inference profile.</p>
|
|
1031
|
-
* @public
|
|
1032
|
-
*/
|
|
1033
|
-
description?: string | undefined;
|
|
1034
|
-
/**
|
|
1035
|
-
* <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, 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>
|
|
1036
|
-
* @public
|
|
1037
|
-
*/
|
|
1038
|
-
clientRequestToken?: string | undefined;
|
|
1039
|
-
/**
|
|
1040
|
-
* <p>The foundation model or system-defined inference profile that the inference profile will track metrics and costs for.</p>
|
|
1041
|
-
* @public
|
|
1042
|
-
*/
|
|
1043
|
-
modelSource: InferenceProfileModelSource | undefined;
|
|
1044
|
-
/**
|
|
1045
|
-
* <p>An array of objects, each of which contains a tag and its value. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Tagging resources</a> in the <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html">Amazon Bedrock User Guide</a>.</p>
|
|
1046
|
-
* @public
|
|
1047
|
-
*/
|
|
1048
|
-
tags?: Tag[] | undefined;
|
|
1049
|
-
}
|
|
1050
|
-
/**
|
|
1051
|
-
* @public
|
|
1052
|
-
* @enum
|
|
1053
|
-
*/
|
|
1054
|
-
export declare const InferenceProfileStatus: {
|
|
1055
|
-
readonly ACTIVE: "ACTIVE";
|
|
1056
|
-
};
|
|
1057
|
-
/**
|
|
1058
|
-
* @public
|
|
1059
|
-
*/
|
|
1060
|
-
export type InferenceProfileStatus = (typeof InferenceProfileStatus)[keyof typeof InferenceProfileStatus];
|
|
1061
|
-
/**
|
|
1062
|
-
* @public
|
|
1063
|
-
*/
|
|
1064
|
-
export interface CreateInferenceProfileResponse {
|
|
1065
|
-
/**
|
|
1066
|
-
* <p>The ARN of the inference profile that you created.</p>
|
|
1067
|
-
* @public
|
|
1068
|
-
*/
|
|
1069
|
-
inferenceProfileArn: string | undefined;
|
|
1070
|
-
/**
|
|
1071
|
-
* <p>The status of the inference profile. <code>ACTIVE</code> means that the inference profile is ready to be used.</p>
|
|
1072
|
-
* @public
|
|
1073
|
-
*/
|
|
1074
|
-
status?: InferenceProfileStatus | undefined;
|
|
1075
|
-
}
|
|
1076
|
-
/**
|
|
1077
|
-
* @public
|
|
1078
|
-
*/
|
|
1079
|
-
export interface DeleteInferenceProfileRequest {
|
|
1080
|
-
/**
|
|
1081
|
-
* <p>The Amazon Resource Name (ARN) or ID of the application inference profile to delete.</p>
|
|
1082
|
-
* @public
|
|
1083
|
-
*/
|
|
1084
|
-
inferenceProfileIdentifier: string | undefined;
|
|
1085
|
-
}
|
|
1086
|
-
/**
|
|
1087
|
-
* @public
|
|
1088
|
-
*/
|
|
1089
|
-
export interface DeleteInferenceProfileResponse {
|
|
1090
|
-
}
|
|
1091
|
-
/**
|
|
1092
|
-
* @public
|
|
1093
|
-
*/
|
|
1094
|
-
export interface GetInferenceProfileRequest {
|
|
1095
|
-
/**
|
|
1096
|
-
* <p>The ID or Amazon Resource Name (ARN) of the inference profile.</p>
|
|
1097
|
-
* @public
|
|
1098
|
-
*/
|
|
1099
|
-
inferenceProfileIdentifier: string | undefined;
|
|
1100
|
-
}
|
|
1101
|
-
/**
|
|
1102
|
-
* <p>Contains information about a model.</p>
|
|
1103
|
-
* @public
|
|
1104
|
-
*/
|
|
1105
|
-
export interface InferenceProfileModel {
|
|
1106
|
-
/**
|
|
1107
|
-
* <p>The Amazon Resource Name (ARN) of the model.</p>
|
|
1108
|
-
* @public
|
|
1109
|
-
*/
|
|
1110
|
-
modelArn?: string | undefined;
|
|
1111
|
-
}
|
|
1112
|
-
/**
|
|
1113
|
-
* @public
|
|
1114
|
-
* @enum
|
|
1115
|
-
*/
|
|
1116
|
-
export declare const InferenceProfileType: {
|
|
1117
|
-
readonly APPLICATION: "APPLICATION";
|
|
1118
|
-
readonly SYSTEM_DEFINED: "SYSTEM_DEFINED";
|
|
1119
|
-
};
|
|
1120
|
-
/**
|
|
1121
|
-
* @public
|
|
1122
|
-
*/
|
|
1123
|
-
export type InferenceProfileType = (typeof InferenceProfileType)[keyof typeof InferenceProfileType];
|
|
1124
|
-
/**
|
|
1125
|
-
* @public
|
|
1126
|
-
*/
|
|
1127
|
-
export interface GetInferenceProfileResponse {
|
|
1128
|
-
/**
|
|
1129
|
-
* <p>The name of the inference profile.</p>
|
|
1130
|
-
* @public
|
|
1131
|
-
*/
|
|
1132
|
-
inferenceProfileName: string | undefined;
|
|
1133
|
-
/**
|
|
1134
|
-
* <p>The description of the inference profile.</p>
|
|
1135
|
-
* @public
|
|
1136
|
-
*/
|
|
1137
|
-
description?: string | undefined;
|
|
1138
|
-
/**
|
|
1139
|
-
* <p>The time at which the inference profile was created.</p>
|
|
1140
|
-
* @public
|
|
1141
|
-
*/
|
|
1142
|
-
createdAt?: Date | undefined;
|
|
1143
|
-
/**
|
|
1144
|
-
* <p>The time at which the inference profile was last updated.</p>
|
|
1145
|
-
* @public
|
|
1146
|
-
*/
|
|
1147
|
-
updatedAt?: Date | undefined;
|
|
1148
|
-
/**
|
|
1149
|
-
* <p>The Amazon Resource Name (ARN) of the inference profile.</p>
|
|
1150
|
-
* @public
|
|
1151
|
-
*/
|
|
1152
|
-
inferenceProfileArn: string | undefined;
|
|
1153
|
-
/**
|
|
1154
|
-
* <p>A list of information about each model in the inference profile.</p>
|
|
1155
|
-
* @public
|
|
1156
|
-
*/
|
|
1157
|
-
models: InferenceProfileModel[] | undefined;
|
|
1158
|
-
/**
|
|
1159
|
-
* <p>The unique identifier of the inference profile.</p>
|
|
1160
|
-
* @public
|
|
1161
|
-
*/
|
|
1162
|
-
inferenceProfileId: string | undefined;
|
|
1163
|
-
/**
|
|
1164
|
-
* <p>The status of the inference profile. <code>ACTIVE</code> means that the inference profile is ready to be used.</p>
|
|
1165
|
-
* @public
|
|
1166
|
-
*/
|
|
1167
|
-
status: InferenceProfileStatus | undefined;
|
|
1168
|
-
/**
|
|
1169
|
-
* <p>The type of the inference profile. The following types are possible:</p> <ul> <li> <p> <code>SYSTEM_DEFINED</code> – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.</p> </li> <li> <p> <code>APPLICATION</code> – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.</p> </li> </ul>
|
|
1170
|
-
* @public
|
|
1171
|
-
*/
|
|
1172
|
-
type: InferenceProfileType | undefined;
|
|
1173
|
-
}
|
|
1174
|
-
/**
|
|
1175
|
-
* @public
|
|
1176
|
-
*/
|
|
1177
|
-
export interface ListInferenceProfilesRequest {
|
|
1178
|
-
/**
|
|
1179
|
-
* <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>
|
|
1180
|
-
* @public
|
|
1181
|
-
*/
|
|
1182
|
-
maxResults?: number | undefined;
|
|
1183
|
-
/**
|
|
1184
|
-
* <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>
|
|
1185
|
-
* @public
|
|
1186
|
-
*/
|
|
1187
|
-
nextToken?: string | undefined;
|
|
1188
|
-
/**
|
|
1189
|
-
* <p>Filters for inference profiles that match the type you specify.</p> <ul> <li> <p> <code>SYSTEM_DEFINED</code> – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.</p> </li> <li> <p> <code>APPLICATION</code> – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.</p> </li> </ul>
|
|
1190
|
-
* @public
|
|
1191
|
-
*/
|
|
1192
|
-
typeEquals?: InferenceProfileType | undefined;
|
|
1193
|
-
}
|
|
1194
|
-
/**
|
|
1195
|
-
* <p>Contains information about an inference profile.</p>
|
|
1196
|
-
* @public
|
|
1197
|
-
*/
|
|
1198
|
-
export interface InferenceProfileSummary {
|
|
1199
|
-
/**
|
|
1200
|
-
* <p>The name of the inference profile.</p>
|
|
1201
|
-
* @public
|
|
1202
|
-
*/
|
|
1203
|
-
inferenceProfileName: string | undefined;
|
|
1204
|
-
/**
|
|
1205
|
-
* <p>The description of the inference profile.</p>
|
|
1206
|
-
* @public
|
|
1207
|
-
*/
|
|
1208
|
-
description?: string | undefined;
|
|
1209
|
-
/**
|
|
1210
|
-
* <p>The time at which the inference profile was created.</p>
|
|
1211
|
-
* @public
|
|
1212
|
-
*/
|
|
1213
|
-
createdAt?: Date | undefined;
|
|
1214
|
-
/**
|
|
1215
|
-
* <p>The time at which the inference profile was last updated.</p>
|
|
1216
|
-
* @public
|
|
1217
|
-
*/
|
|
1218
|
-
updatedAt?: Date | undefined;
|
|
1219
|
-
/**
|
|
1220
|
-
* <p>The Amazon Resource Name (ARN) of the inference profile.</p>
|
|
1221
|
-
* @public
|
|
1222
|
-
*/
|
|
1223
|
-
inferenceProfileArn: string | undefined;
|
|
1224
|
-
/**
|
|
1225
|
-
* <p>A list of information about each model in the inference profile.</p>
|
|
1226
|
-
* @public
|
|
1227
|
-
*/
|
|
1228
|
-
models: InferenceProfileModel[] | undefined;
|
|
1229
|
-
/**
|
|
1230
|
-
* <p>The unique identifier of the inference profile.</p>
|
|
1231
|
-
* @public
|
|
1232
|
-
*/
|
|
1233
|
-
inferenceProfileId: string | undefined;
|
|
1234
|
-
/**
|
|
1235
|
-
* <p>The status of the inference profile. <code>ACTIVE</code> means that the inference profile is ready to be used.</p>
|
|
1236
|
-
* @public
|
|
1237
|
-
*/
|
|
1238
|
-
status: InferenceProfileStatus | undefined;
|
|
1239
|
-
/**
|
|
1240
|
-
* <p>The type of the inference profile. The following types are possible:</p> <ul> <li> <p> <code>SYSTEM_DEFINED</code> – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles.</p> </li> <li> <p> <code>APPLICATION</code> – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions.</p> </li> </ul>
|
|
1241
|
-
* @public
|
|
1242
|
-
*/
|
|
1243
|
-
type: InferenceProfileType | undefined;
|
|
1244
|
-
}
|
|
1245
|
-
/**
|
|
1246
|
-
* @public
|
|
1247
|
-
*/
|
|
1248
|
-
export interface ListInferenceProfilesResponse {
|
|
1249
|
-
/**
|
|
1250
|
-
* <p>A list of information about each inference profile that you can use.</p>
|
|
1251
|
-
* @public
|
|
1252
|
-
*/
|
|
1253
|
-
inferenceProfileSummaries?: InferenceProfileSummary[] | undefined;
|
|
1254
|
-
/**
|
|
1255
|
-
* <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>
|
|
1256
|
-
* @public
|
|
1257
|
-
*/
|
|
1258
|
-
nextToken?: string | undefined;
|
|
1259
|
-
}
|
|
1260
|
-
/**
|
|
1261
|
-
* @public
|
|
1262
|
-
*/
|
|
1263
|
-
export interface DeleteModelInvocationLoggingConfigurationRequest {
|
|
1264
|
-
}
|
|
1265
|
-
/**
|
|
1266
|
-
* @public
|
|
1267
|
-
*/
|
|
1268
|
-
export interface DeleteModelInvocationLoggingConfigurationResponse {
|
|
1269
|
-
}
|
|
1270
|
-
/**
|
|
1271
|
-
* @public
|
|
1272
|
-
*/
|
|
1273
|
-
export interface GetModelInvocationLoggingConfigurationRequest {
|
|
1274
|
-
}
|
|
1275
|
-
/**
|
|
1276
|
-
* <p>S3 configuration for storing log data.</p>
|
|
1277
|
-
* @public
|
|
1278
|
-
*/
|
|
1279
|
-
export interface S3Config {
|
|
1280
|
-
/**
|
|
1281
|
-
* <p>S3 bucket name.</p>
|
|
1282
|
-
* @public
|
|
1283
|
-
*/
|
|
1284
|
-
bucketName: string | undefined;
|
|
1285
|
-
/**
|
|
1286
|
-
* <p>S3 prefix. </p>
|
|
1287
|
-
* @public
|
|
1288
|
-
*/
|
|
1289
|
-
keyPrefix?: string | undefined;
|
|
1290
|
-
}
|
|
1291
|
-
/**
|
|
1292
|
-
* <p>CloudWatch logging configuration.</p>
|
|
1293
|
-
* @public
|
|
1294
|
-
*/
|
|
1295
|
-
export interface CloudWatchConfig {
|
|
1296
|
-
/**
|
|
1297
|
-
* <p>The log group name.</p>
|
|
1298
|
-
* @public
|
|
1299
|
-
*/
|
|
1300
|
-
logGroupName: string | undefined;
|
|
1301
|
-
/**
|
|
1302
|
-
* <p>The role Amazon Resource Name (ARN).</p>
|
|
1303
|
-
* @public
|
|
1304
|
-
*/
|
|
1305
|
-
roleArn: string | undefined;
|
|
1306
|
-
/**
|
|
1307
|
-
* <p>S3 configuration for delivering a large amount of data.</p>
|
|
1308
|
-
* @public
|
|
1309
|
-
*/
|
|
1310
|
-
largeDataDeliveryS3Config?: S3Config | undefined;
|
|
1311
|
-
}
|
|
1312
|
-
/**
|
|
1313
|
-
* <p>Configuration fields for invocation logging.</p>
|
|
1314
|
-
* @public
|
|
1315
|
-
*/
|
|
1316
|
-
export interface LoggingConfig {
|
|
1317
|
-
/**
|
|
1318
|
-
* <p>CloudWatch logging configuration.</p>
|
|
1319
|
-
* @public
|
|
1320
|
-
*/
|
|
1321
|
-
cloudWatchConfig?: CloudWatchConfig | undefined;
|
|
1322
|
-
/**
|
|
1323
|
-
* <p>S3 configuration for storing log data.</p>
|
|
1324
|
-
* @public
|
|
1325
|
-
*/
|
|
1326
|
-
s3Config?: S3Config | undefined;
|
|
1327
|
-
/**
|
|
1328
|
-
* <p>Set to include text data in the log delivery.</p>
|
|
1329
|
-
* @public
|
|
1330
|
-
*/
|
|
1331
|
-
textDataDeliveryEnabled?: boolean | undefined;
|
|
1332
|
-
/**
|
|
1333
|
-
* <p>Set to include image data in the log delivery.</p>
|
|
1334
|
-
* @public
|
|
1335
|
-
*/
|
|
1336
|
-
imageDataDeliveryEnabled?: boolean | undefined;
|
|
1337
|
-
/**
|
|
1338
|
-
* <p>Set to include embeddings data in the log delivery.</p>
|
|
1339
|
-
* @public
|
|
1340
|
-
*/
|
|
1341
|
-
embeddingDataDeliveryEnabled?: boolean | undefined;
|
|
1342
|
-
/**
|
|
1343
|
-
* <p>Set to include video data in the log delivery.</p>
|
|
1344
|
-
* @public
|
|
1345
|
-
*/
|
|
1346
|
-
videoDataDeliveryEnabled?: boolean | undefined;
|
|
1347
|
-
}
|
|
1348
|
-
/**
|
|
1349
|
-
* @public
|
|
1350
|
-
*/
|
|
1351
|
-
export interface GetModelInvocationLoggingConfigurationResponse {
|
|
1352
|
-
/**
|
|
1353
|
-
* <p>The current configuration values.</p>
|
|
1354
|
-
* @public
|
|
1355
|
-
*/
|
|
1356
|
-
loggingConfig?: LoggingConfig | undefined;
|
|
1357
|
-
}
|
|
1358
|
-
/**
|
|
1359
|
-
* @public
|
|
1360
|
-
*/
|
|
1361
|
-
export interface PutModelInvocationLoggingConfigurationRequest {
|
|
1362
|
-
/**
|
|
1363
|
-
* <p>The logging configuration values to set.</p>
|
|
1364
|
-
* @public
|
|
1365
|
-
*/
|
|
1366
|
-
loggingConfig: LoggingConfig | undefined;
|
|
1367
|
-
}
|
|
1
|
+
import { ApplicationType, AuthorizationStatus, CommitmentDuration, CustomizationType, EntitlementAvailability, EvaluationJobStatus, EvaluationJobType, FineTuningJobStatus, FoundationModelLifecycleStatus, InferenceType, JobStatusDetails, ModelCopyJobStatus, ModelCustomization, ModelCustomizationJobStatus, ModelImportJobStatus, ModelInvocationJobStatus, ModelModality, OfferType, PromptRouterStatus, PromptRouterType, ProvisionedModelStatus, RegionAvailability, RetrieveAndGenerateType, S3InputFormat, SearchType, SortByProvisionedModels, SortJobsBy, SortModelsBy, SortOrder } from "./enums";
|
|
2
|
+
import { AgreementAvailability, CustomizationConfig, EvaluationConfig, EvaluationModelConfig, EvaluationOutputDataConfig, EvaluationPrecomputedRagSourceConfig, ExternalSourcesRetrieveAndGenerateConfiguration, FilterAttribute, GenerationConfiguration, ImplicitFilterConfiguration, ModelDataSource, OrchestrationConfiguration, OutputDataConfig, Tag, TrainingDataConfig, TrainingMetrics, ValidationDataConfig, ValidatorMetric, VectorSearchRerankingConfiguration, VpcConfig } from "./models_0";
|
|
1368
3
|
/**
|
|
1369
4
|
* @public
|
|
1370
5
|
*/
|
|
@@ -1420,19 +55,6 @@ export interface GetModelCopyJobRequest {
|
|
|
1420
55
|
*/
|
|
1421
56
|
jobArn: string | undefined;
|
|
1422
57
|
}
|
|
1423
|
-
/**
|
|
1424
|
-
* @public
|
|
1425
|
-
* @enum
|
|
1426
|
-
*/
|
|
1427
|
-
export declare const ModelCopyJobStatus: {
|
|
1428
|
-
readonly COMPLETED: "Completed";
|
|
1429
|
-
readonly FAILED: "Failed";
|
|
1430
|
-
readonly IN_PROGRESS: "InProgress";
|
|
1431
|
-
};
|
|
1432
|
-
/**
|
|
1433
|
-
* @public
|
|
1434
|
-
*/
|
|
1435
|
-
export type ModelCopyJobStatus = (typeof ModelCopyJobStatus)[keyof typeof ModelCopyJobStatus];
|
|
1436
58
|
/**
|
|
1437
59
|
* @public
|
|
1438
60
|
*/
|
|
@@ -1790,19 +412,6 @@ export interface GetModelImportJobRequest {
|
|
|
1790
412
|
*/
|
|
1791
413
|
jobIdentifier: string | undefined;
|
|
1792
414
|
}
|
|
1793
|
-
/**
|
|
1794
|
-
* @public
|
|
1795
|
-
* @enum
|
|
1796
|
-
*/
|
|
1797
|
-
export declare const ModelImportJobStatus: {
|
|
1798
|
-
readonly COMPLETED: "Completed";
|
|
1799
|
-
readonly FAILED: "Failed";
|
|
1800
|
-
readonly IN_PROGRESS: "InProgress";
|
|
1801
|
-
};
|
|
1802
|
-
/**
|
|
1803
|
-
* @public
|
|
1804
|
-
*/
|
|
1805
|
-
export type ModelImportJobStatus = (typeof ModelImportJobStatus)[keyof typeof ModelImportJobStatus];
|
|
1806
415
|
/**
|
|
1807
416
|
* @public
|
|
1808
417
|
*/
|
|
@@ -2065,17 +674,6 @@ export interface ListModelImportJobsResponse {
|
|
|
2065
674
|
*/
|
|
2066
675
|
modelImportJobSummaries?: ModelImportJobSummary[] | undefined;
|
|
2067
676
|
}
|
|
2068
|
-
/**
|
|
2069
|
-
* @public
|
|
2070
|
-
* @enum
|
|
2071
|
-
*/
|
|
2072
|
-
export declare const S3InputFormat: {
|
|
2073
|
-
readonly JSONL: "JSONL";
|
|
2074
|
-
};
|
|
2075
|
-
/**
|
|
2076
|
-
* @public
|
|
2077
|
-
*/
|
|
2078
|
-
export type S3InputFormat = (typeof S3InputFormat)[keyof typeof S3InputFormat];
|
|
2079
677
|
/**
|
|
2080
678
|
* <p>Contains the configuration of the S3 location of the input data.</p>
|
|
2081
679
|
* @public
|
|
@@ -2254,26 +852,6 @@ export interface GetModelInvocationJobRequest {
|
|
|
2254
852
|
*/
|
|
2255
853
|
jobIdentifier: string | undefined;
|
|
2256
854
|
}
|
|
2257
|
-
/**
|
|
2258
|
-
* @public
|
|
2259
|
-
* @enum
|
|
2260
|
-
*/
|
|
2261
|
-
export declare const ModelInvocationJobStatus: {
|
|
2262
|
-
readonly COMPLETED: "Completed";
|
|
2263
|
-
readonly EXPIRED: "Expired";
|
|
2264
|
-
readonly FAILED: "Failed";
|
|
2265
|
-
readonly IN_PROGRESS: "InProgress";
|
|
2266
|
-
readonly PARTIALLY_COMPLETED: "PartiallyCompleted";
|
|
2267
|
-
readonly SCHEDULED: "Scheduled";
|
|
2268
|
-
readonly STOPPED: "Stopped";
|
|
2269
|
-
readonly STOPPING: "Stopping";
|
|
2270
|
-
readonly SUBMITTED: "Submitted";
|
|
2271
|
-
readonly VALIDATING: "Validating";
|
|
2272
|
-
};
|
|
2273
|
-
/**
|
|
2274
|
-
* @public
|
|
2275
|
-
*/
|
|
2276
|
-
export type ModelInvocationJobStatus = (typeof ModelInvocationJobStatus)[keyof typeof ModelInvocationJobStatus];
|
|
2277
855
|
/**
|
|
2278
856
|
* @public
|
|
2279
857
|
*/
|
|
@@ -2520,56 +1098,6 @@ export interface GetFoundationModelRequest {
|
|
|
2520
1098
|
*/
|
|
2521
1099
|
modelIdentifier: string | undefined;
|
|
2522
1100
|
}
|
|
2523
|
-
/**
|
|
2524
|
-
* @public
|
|
2525
|
-
* @enum
|
|
2526
|
-
*/
|
|
2527
|
-
export declare const ModelCustomization: {
|
|
2528
|
-
readonly CONTINUED_PRE_TRAINING: "CONTINUED_PRE_TRAINING";
|
|
2529
|
-
readonly DISTILLATION: "DISTILLATION";
|
|
2530
|
-
readonly FINE_TUNING: "FINE_TUNING";
|
|
2531
|
-
};
|
|
2532
|
-
/**
|
|
2533
|
-
* @public
|
|
2534
|
-
*/
|
|
2535
|
-
export type ModelCustomization = (typeof ModelCustomization)[keyof typeof ModelCustomization];
|
|
2536
|
-
/**
|
|
2537
|
-
* @public
|
|
2538
|
-
* @enum
|
|
2539
|
-
*/
|
|
2540
|
-
export declare const InferenceType: {
|
|
2541
|
-
readonly ON_DEMAND: "ON_DEMAND";
|
|
2542
|
-
readonly PROVISIONED: "PROVISIONED";
|
|
2543
|
-
};
|
|
2544
|
-
/**
|
|
2545
|
-
* @public
|
|
2546
|
-
*/
|
|
2547
|
-
export type InferenceType = (typeof InferenceType)[keyof typeof InferenceType];
|
|
2548
|
-
/**
|
|
2549
|
-
* @public
|
|
2550
|
-
* @enum
|
|
2551
|
-
*/
|
|
2552
|
-
export declare const ModelModality: {
|
|
2553
|
-
readonly EMBEDDING: "EMBEDDING";
|
|
2554
|
-
readonly IMAGE: "IMAGE";
|
|
2555
|
-
readonly TEXT: "TEXT";
|
|
2556
|
-
};
|
|
2557
|
-
/**
|
|
2558
|
-
* @public
|
|
2559
|
-
*/
|
|
2560
|
-
export type ModelModality = (typeof ModelModality)[keyof typeof ModelModality];
|
|
2561
|
-
/**
|
|
2562
|
-
* @public
|
|
2563
|
-
* @enum
|
|
2564
|
-
*/
|
|
2565
|
-
export declare const FoundationModelLifecycleStatus: {
|
|
2566
|
-
readonly ACTIVE: "ACTIVE";
|
|
2567
|
-
readonly LEGACY: "LEGACY";
|
|
2568
|
-
};
|
|
2569
|
-
/**
|
|
2570
|
-
* @public
|
|
2571
|
-
*/
|
|
2572
|
-
export type FoundationModelLifecycleStatus = (typeof FoundationModelLifecycleStatus)[keyof typeof FoundationModelLifecycleStatus];
|
|
2573
1101
|
/**
|
|
2574
1102
|
* <p>Details about whether a model version is available or deprecated.</p>
|
|
2575
1103
|
* @public
|
|
@@ -2835,29 +1363,6 @@ export interface GetPromptRouterRequest {
|
|
|
2835
1363
|
*/
|
|
2836
1364
|
promptRouterArn: string | undefined;
|
|
2837
1365
|
}
|
|
2838
|
-
/**
|
|
2839
|
-
* @public
|
|
2840
|
-
* @enum
|
|
2841
|
-
*/
|
|
2842
|
-
export declare const PromptRouterStatus: {
|
|
2843
|
-
readonly AVAILABLE: "AVAILABLE";
|
|
2844
|
-
};
|
|
2845
|
-
/**
|
|
2846
|
-
* @public
|
|
2847
|
-
*/
|
|
2848
|
-
export type PromptRouterStatus = (typeof PromptRouterStatus)[keyof typeof PromptRouterStatus];
|
|
2849
|
-
/**
|
|
2850
|
-
* @public
|
|
2851
|
-
* @enum
|
|
2852
|
-
*/
|
|
2853
|
-
export declare const PromptRouterType: {
|
|
2854
|
-
readonly CUSTOM: "custom";
|
|
2855
|
-
readonly DEFAULT: "default";
|
|
2856
|
-
};
|
|
2857
|
-
/**
|
|
2858
|
-
* @public
|
|
2859
|
-
*/
|
|
2860
|
-
export type PromptRouterType = (typeof PromptRouterType)[keyof typeof PromptRouterType];
|
|
2861
1366
|
/**
|
|
2862
1367
|
* @public
|
|
2863
1368
|
*/
|
|
@@ -3004,18 +1509,6 @@ export interface ListPromptRoutersResponse {
|
|
|
3004
1509
|
*/
|
|
3005
1510
|
nextToken?: string | undefined;
|
|
3006
1511
|
}
|
|
3007
|
-
/**
|
|
3008
|
-
* @public
|
|
3009
|
-
* @enum
|
|
3010
|
-
*/
|
|
3011
|
-
export declare const CommitmentDuration: {
|
|
3012
|
-
readonly ONE_MONTH: "OneMonth";
|
|
3013
|
-
readonly SIX_MONTHS: "SixMonths";
|
|
3014
|
-
};
|
|
3015
|
-
/**
|
|
3016
|
-
* @public
|
|
3017
|
-
*/
|
|
3018
|
-
export type CommitmentDuration = (typeof CommitmentDuration)[keyof typeof CommitmentDuration];
|
|
3019
1512
|
/**
|
|
3020
1513
|
* @public
|
|
3021
1514
|
*/
|
|
@@ -3086,20 +1579,6 @@ export interface GetProvisionedModelThroughputRequest {
|
|
|
3086
1579
|
*/
|
|
3087
1580
|
provisionedModelId: string | undefined;
|
|
3088
1581
|
}
|
|
3089
|
-
/**
|
|
3090
|
-
* @public
|
|
3091
|
-
* @enum
|
|
3092
|
-
*/
|
|
3093
|
-
export declare const ProvisionedModelStatus: {
|
|
3094
|
-
readonly CREATING: "Creating";
|
|
3095
|
-
readonly FAILED: "Failed";
|
|
3096
|
-
readonly IN_SERVICE: "InService";
|
|
3097
|
-
readonly UPDATING: "Updating";
|
|
3098
|
-
};
|
|
3099
|
-
/**
|
|
3100
|
-
* @public
|
|
3101
|
-
*/
|
|
3102
|
-
export type ProvisionedModelStatus = (typeof ProvisionedModelStatus)[keyof typeof ProvisionedModelStatus];
|
|
3103
1582
|
/**
|
|
3104
1583
|
* @public
|
|
3105
1584
|
*/
|
|
@@ -3170,17 +1649,6 @@ export interface GetProvisionedModelThroughputResponse {
|
|
|
3170
1649
|
*/
|
|
3171
1650
|
commitmentExpirationTime?: Date | undefined;
|
|
3172
1651
|
}
|
|
3173
|
-
/**
|
|
3174
|
-
* @public
|
|
3175
|
-
* @enum
|
|
3176
|
-
*/
|
|
3177
|
-
export declare const SortByProvisionedModels: {
|
|
3178
|
-
readonly CREATION_TIME: "CreationTime";
|
|
3179
|
-
};
|
|
3180
|
-
/**
|
|
3181
|
-
* @public
|
|
3182
|
-
*/
|
|
3183
|
-
export type SortByProvisionedModels = (typeof SortByProvisionedModels)[keyof typeof SortByProvisionedModels];
|
|
3184
1652
|
/**
|
|
3185
1653
|
* @public
|
|
3186
1654
|
*/
|
|
@@ -3387,42 +1855,6 @@ export interface GetFoundationModelAvailabilityRequest {
|
|
|
3387
1855
|
*/
|
|
3388
1856
|
modelId: string | undefined;
|
|
3389
1857
|
}
|
|
3390
|
-
/**
|
|
3391
|
-
* @public
|
|
3392
|
-
* @enum
|
|
3393
|
-
*/
|
|
3394
|
-
export declare const AuthorizationStatus: {
|
|
3395
|
-
readonly AUTHORIZED: "AUTHORIZED";
|
|
3396
|
-
readonly NOT_AUTHORIZED: "NOT_AUTHORIZED";
|
|
3397
|
-
};
|
|
3398
|
-
/**
|
|
3399
|
-
* @public
|
|
3400
|
-
*/
|
|
3401
|
-
export type AuthorizationStatus = (typeof AuthorizationStatus)[keyof typeof AuthorizationStatus];
|
|
3402
|
-
/**
|
|
3403
|
-
* @public
|
|
3404
|
-
* @enum
|
|
3405
|
-
*/
|
|
3406
|
-
export declare const EntitlementAvailability: {
|
|
3407
|
-
readonly AVAILABLE: "AVAILABLE";
|
|
3408
|
-
readonly NOT_AVAILABLE: "NOT_AVAILABLE";
|
|
3409
|
-
};
|
|
3410
|
-
/**
|
|
3411
|
-
* @public
|
|
3412
|
-
*/
|
|
3413
|
-
export type EntitlementAvailability = (typeof EntitlementAvailability)[keyof typeof EntitlementAvailability];
|
|
3414
|
-
/**
|
|
3415
|
-
* @public
|
|
3416
|
-
* @enum
|
|
3417
|
-
*/
|
|
3418
|
-
export declare const RegionAvailability: {
|
|
3419
|
-
readonly AVAILABLE: "AVAILABLE";
|
|
3420
|
-
readonly NOT_AVAILABLE: "NOT_AVAILABLE";
|
|
3421
|
-
};
|
|
3422
|
-
/**
|
|
3423
|
-
* @public
|
|
3424
|
-
*/
|
|
3425
|
-
export type RegionAvailability = (typeof RegionAvailability)[keyof typeof RegionAvailability];
|
|
3426
1858
|
/**
|
|
3427
1859
|
* @public
|
|
3428
1860
|
*/
|
|
@@ -3453,18 +1885,6 @@ export interface GetFoundationModelAvailabilityResponse {
|
|
|
3453
1885
|
*/
|
|
3454
1886
|
regionAvailability: RegionAvailability | undefined;
|
|
3455
1887
|
}
|
|
3456
|
-
/**
|
|
3457
|
-
* @public
|
|
3458
|
-
* @enum
|
|
3459
|
-
*/
|
|
3460
|
-
export declare const OfferType: {
|
|
3461
|
-
readonly ALL: "ALL";
|
|
3462
|
-
readonly PUBLIC: "PUBLIC";
|
|
3463
|
-
};
|
|
3464
|
-
/**
|
|
3465
|
-
* @public
|
|
3466
|
-
*/
|
|
3467
|
-
export type OfferType = (typeof OfferType)[keyof typeof OfferType];
|
|
3468
1888
|
/**
|
|
3469
1889
|
* @public
|
|
3470
1890
|
*/
|
|
@@ -3772,37 +2192,6 @@ export interface GetModelCustomizationJobRequest {
|
|
|
3772
2192
|
*/
|
|
3773
2193
|
jobIdentifier: string | undefined;
|
|
3774
2194
|
}
|
|
3775
|
-
/**
|
|
3776
|
-
* @public
|
|
3777
|
-
* @enum
|
|
3778
|
-
*/
|
|
3779
|
-
export declare const ModelCustomizationJobStatus: {
|
|
3780
|
-
readonly COMPLETED: "Completed";
|
|
3781
|
-
readonly FAILED: "Failed";
|
|
3782
|
-
readonly IN_PROGRESS: "InProgress";
|
|
3783
|
-
readonly STOPPED: "Stopped";
|
|
3784
|
-
readonly STOPPING: "Stopping";
|
|
3785
|
-
};
|
|
3786
|
-
/**
|
|
3787
|
-
* @public
|
|
3788
|
-
*/
|
|
3789
|
-
export type ModelCustomizationJobStatus = (typeof ModelCustomizationJobStatus)[keyof typeof ModelCustomizationJobStatus];
|
|
3790
|
-
/**
|
|
3791
|
-
* @public
|
|
3792
|
-
* @enum
|
|
3793
|
-
*/
|
|
3794
|
-
export declare const JobStatusDetails: {
|
|
3795
|
-
readonly COMPLETED: "Completed";
|
|
3796
|
-
readonly FAILED: "Failed";
|
|
3797
|
-
readonly IN_PROGRESS: "InProgress";
|
|
3798
|
-
readonly NOT_STARTED: "NotStarted";
|
|
3799
|
-
readonly STOPPED: "Stopped";
|
|
3800
|
-
readonly STOPPING: "Stopping";
|
|
3801
|
-
};
|
|
3802
|
-
/**
|
|
3803
|
-
* @public
|
|
3804
|
-
*/
|
|
3805
|
-
export type JobStatusDetails = (typeof JobStatusDetails)[keyof typeof JobStatusDetails];
|
|
3806
2195
|
/**
|
|
3807
2196
|
* <p>For a Distillation job, the status details for the data processing sub-task of the job.</p>
|
|
3808
2197
|
* @public
|
|
@@ -4007,21 +2396,6 @@ export interface GetModelCustomizationJobResponse {
|
|
|
4007
2396
|
*/
|
|
4008
2397
|
customizationConfig?: CustomizationConfig | undefined;
|
|
4009
2398
|
}
|
|
4010
|
-
/**
|
|
4011
|
-
* @public
|
|
4012
|
-
* @enum
|
|
4013
|
-
*/
|
|
4014
|
-
export declare const FineTuningJobStatus: {
|
|
4015
|
-
readonly COMPLETED: "Completed";
|
|
4016
|
-
readonly FAILED: "Failed";
|
|
4017
|
-
readonly IN_PROGRESS: "InProgress";
|
|
4018
|
-
readonly STOPPED: "Stopped";
|
|
4019
|
-
readonly STOPPING: "Stopping";
|
|
4020
|
-
};
|
|
4021
|
-
/**
|
|
4022
|
-
* @public
|
|
4023
|
-
*/
|
|
4024
|
-
export type FineTuningJobStatus = (typeof FineTuningJobStatus)[keyof typeof FineTuningJobStatus];
|
|
4025
2399
|
/**
|
|
4026
2400
|
* @public
|
|
4027
2401
|
*/
|