@aws-sdk/client-bedrock 3.995.0 → 3.997.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 +21 -18
- package/dist-cjs/schemas/schemas_0.js +220 -49
- package/dist-es/models/enums.js +4 -0
- package/dist-es/schemas/schemas_0.js +209 -38
- package/dist-types/commands/CreateInferenceProfileCommand.d.ts +1 -1
- package/dist-types/commands/GetAutomatedReasoningPolicyBuildWorkflowCommand.d.ts +1 -1
- package/dist-types/commands/GetAutomatedReasoningPolicyBuildWorkflowResultAssetsCommand.d.ts +85 -1
- package/dist-types/commands/GetGuardrailCommand.d.ts +2 -1
- package/dist-types/commands/ListAutomatedReasoningPolicyBuildWorkflowsCommand.d.ts +1 -1
- package/dist-types/commands/ListGuardrailsCommand.d.ts +1 -1
- package/dist-types/commands/StartAutomatedReasoningPolicyBuildWorkflowCommand.d.ts +11 -1
- package/dist-types/commands/UpdateGuardrailCommand.d.ts +1 -1
- package/dist-types/models/enums.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +447 -533
- package/dist-types/models/models_1.d.ts +506 -2
- package/dist-types/schemas/schemas_0.d.ts +14 -0
- package/dist-types/ts3.4/commands/CreateInferenceProfileCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetGuardrailCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListGuardrailsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateGuardrailCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/enums.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +178 -131
- package/dist-types/ts3.4/models/models_1.d.ts +147 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +14 -0
- package/package.json +38 -38
|
@@ -1,5 +1,509 @@
|
|
|
1
|
-
import { ApplicationType, AuthorizationStatus, CommitmentDuration, CustomizationType, EntitlementAvailability, EvaluationJobStatus, EvaluationJobType, FineTuningJobStatus, FoundationModelLifecycleStatus, InferenceProfileStatus, InferenceProfileType, InferenceType, JobStatusDetails, ModelCopyJobStatus, ModelCustomization, ModelCustomizationJobStatus, ModelImportJobStatus, ModelInvocationJobStatus, ModelModality, OfferType, PromptRouterStatus, PromptRouterType, ProvisionedModelStatus, RegionAvailability, RetrieveAndGenerateType, S3InputFormat, SearchType, SortByProvisionedModels, SortJobsBy, SortModelsBy, SortOrder } from "./enums";
|
|
2
|
-
import { type AgreementAvailability, type CustomizationConfig, type EvaluationConfig, type EvaluationOutputDataConfig, type ExternalSourcesRetrieveAndGenerateConfiguration, type GenerationConfiguration, type ImplicitFilterConfiguration, type ModelDataSource, type OrchestrationConfiguration, type OutputDataConfig, type TrainingDataConfig, type TrainingMetrics, type ValidationDataConfig, type VectorSearchRerankingConfiguration, type VpcConfig, EvaluationModelConfig, EvaluationPrecomputedRagSourceConfig, FilterAttribute, Tag, ValidatorMetric } from "./models_0";
|
|
1
|
+
import { ApplicationType, AuthorizationStatus, CommitmentDuration, CustomizationType, EntitlementAvailability, EvaluationJobStatus, EvaluationJobType, FineTuningJobStatus, FoundationModelLifecycleStatus, GuardrailManagedWordsType, GuardrailStatus, GuardrailTopicAction, GuardrailTopicType, GuardrailWordAction, InferenceProfileStatus, InferenceProfileType, InferenceType, JobStatusDetails, ModelCopyJobStatus, ModelCustomization, ModelCustomizationJobStatus, ModelImportJobStatus, ModelInvocationJobStatus, ModelModality, OfferType, PromptRouterStatus, PromptRouterType, ProvisionedModelStatus, RegionAvailability, RetrieveAndGenerateType, S3InputFormat, SearchType, SortByProvisionedModels, SortJobsBy, SortModelsBy, SortOrder } from "./enums";
|
|
2
|
+
import { type AgreementAvailability, type CustomizationConfig, type EvaluationConfig, type EvaluationOutputDataConfig, type ExternalSourcesRetrieveAndGenerateConfiguration, type GenerationConfiguration, type GuardrailAutomatedReasoningPolicy, type GuardrailAutomatedReasoningPolicyConfig, type GuardrailContentPolicy, type GuardrailContentPolicyConfig, type GuardrailContextualGroundingPolicy, type GuardrailContextualGroundingPolicyConfig, type GuardrailCrossRegionConfig, type GuardrailCrossRegionDetails, type GuardrailSensitiveInformationPolicy, type GuardrailSensitiveInformationPolicyConfig, type GuardrailTopicPolicyConfig, type GuardrailTopicsTier, type GuardrailWordPolicyConfig, type ImplicitFilterConfiguration, type ModelDataSource, type OrchestrationConfiguration, type OutputDataConfig, type TrainingDataConfig, type TrainingMetrics, type ValidationDataConfig, type VectorSearchRerankingConfiguration, type VpcConfig, EvaluationModelConfig, EvaluationPrecomputedRagSourceConfig, FilterAttribute, Tag, ValidatorMetric } from "./models_0";
|
|
3
|
+
/**
|
|
4
|
+
* <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>
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface GuardrailTopic {
|
|
8
|
+
/**
|
|
9
|
+
* <p>The name of the topic to deny.</p>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
name: string | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* <p>A definition of the topic to deny.</p>
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
definition: string | undefined;
|
|
18
|
+
/**
|
|
19
|
+
* <p>A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.</p>
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
examples?: string[] | undefined;
|
|
23
|
+
/**
|
|
24
|
+
* <p>Specifies to deny the topic.</p>
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
type?: GuardrailTopicType | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* <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>
|
|
30
|
+
* @public
|
|
31
|
+
*/
|
|
32
|
+
inputAction?: GuardrailTopicAction | undefined;
|
|
33
|
+
/**
|
|
34
|
+
* <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>
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
outputAction?: GuardrailTopicAction | undefined;
|
|
38
|
+
/**
|
|
39
|
+
* <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>
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
inputEnabled?: boolean | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* <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>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
outputEnabled?: boolean | undefined;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* <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>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
export interface GuardrailTopicPolicy {
|
|
54
|
+
/**
|
|
55
|
+
* <p>A list of policies related to topics that the guardrail should deny.</p>
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
topics: GuardrailTopic[] | undefined;
|
|
59
|
+
/**
|
|
60
|
+
* <p>The tier that your guardrail uses for denied topic filters.</p>
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
tier?: GuardrailTopicsTier | undefined;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* <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>
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
export interface GuardrailManagedWords {
|
|
70
|
+
/**
|
|
71
|
+
* <p>ManagedWords$type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)</p>
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
type: GuardrailManagedWordsType | undefined;
|
|
75
|
+
/**
|
|
76
|
+
* <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>
|
|
77
|
+
* @public
|
|
78
|
+
*/
|
|
79
|
+
inputAction?: GuardrailWordAction | undefined;
|
|
80
|
+
/**
|
|
81
|
+
* <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>
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
outputAction?: GuardrailWordAction | undefined;
|
|
85
|
+
/**
|
|
86
|
+
* <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>
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
inputEnabled?: boolean | undefined;
|
|
90
|
+
/**
|
|
91
|
+
* <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>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
outputEnabled?: boolean | undefined;
|
|
95
|
+
}
|
|
96
|
+
/**
|
|
97
|
+
* <p>A word configured for the guardrail.</p>
|
|
98
|
+
* @public
|
|
99
|
+
*/
|
|
100
|
+
export interface GuardrailWord {
|
|
101
|
+
/**
|
|
102
|
+
* <p>Text of the word configured for the guardrail to block.</p>
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
text: string | undefined;
|
|
106
|
+
/**
|
|
107
|
+
* <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>
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
inputAction?: GuardrailWordAction | undefined;
|
|
111
|
+
/**
|
|
112
|
+
* <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>
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
outputAction?: GuardrailWordAction | undefined;
|
|
116
|
+
/**
|
|
117
|
+
* <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>
|
|
118
|
+
* @public
|
|
119
|
+
*/
|
|
120
|
+
inputEnabled?: boolean | undefined;
|
|
121
|
+
/**
|
|
122
|
+
* <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>
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
outputEnabled?: boolean | undefined;
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* <p>Contains details about the word policy configured for the guardrail.</p>
|
|
129
|
+
* @public
|
|
130
|
+
*/
|
|
131
|
+
export interface GuardrailWordPolicy {
|
|
132
|
+
/**
|
|
133
|
+
* <p>A list of words configured for the guardrail.</p>
|
|
134
|
+
* @public
|
|
135
|
+
*/
|
|
136
|
+
words?: GuardrailWord[] | undefined;
|
|
137
|
+
/**
|
|
138
|
+
* <p>A list of managed words configured for the guardrail.</p>
|
|
139
|
+
* @public
|
|
140
|
+
*/
|
|
141
|
+
managedWordLists?: GuardrailManagedWords[] | undefined;
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* @public
|
|
145
|
+
*/
|
|
146
|
+
export interface GetGuardrailResponse {
|
|
147
|
+
/**
|
|
148
|
+
* <p>The name of the guardrail.</p>
|
|
149
|
+
* @public
|
|
150
|
+
*/
|
|
151
|
+
name: string | undefined;
|
|
152
|
+
/**
|
|
153
|
+
* <p>The description of the guardrail.</p>
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
description?: string | undefined;
|
|
157
|
+
/**
|
|
158
|
+
* <p>The unique identifier of the guardrail.</p>
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
guardrailId: string | undefined;
|
|
162
|
+
/**
|
|
163
|
+
* <p>The ARN of the guardrail.</p>
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
166
|
+
guardrailArn: string | undefined;
|
|
167
|
+
/**
|
|
168
|
+
* <p>The version of the guardrail.</p>
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
171
|
+
version: string | undefined;
|
|
172
|
+
/**
|
|
173
|
+
* <p>The status of the guardrail.</p>
|
|
174
|
+
* @public
|
|
175
|
+
*/
|
|
176
|
+
status: GuardrailStatus | undefined;
|
|
177
|
+
/**
|
|
178
|
+
* <p>The topic policy that was configured for the guardrail.</p>
|
|
179
|
+
* @public
|
|
180
|
+
*/
|
|
181
|
+
topicPolicy?: GuardrailTopicPolicy | undefined;
|
|
182
|
+
/**
|
|
183
|
+
* <p>The content policy that was configured for the guardrail.</p>
|
|
184
|
+
* @public
|
|
185
|
+
*/
|
|
186
|
+
contentPolicy?: GuardrailContentPolicy | undefined;
|
|
187
|
+
/**
|
|
188
|
+
* <p>The word policy that was configured for the guardrail.</p>
|
|
189
|
+
* @public
|
|
190
|
+
*/
|
|
191
|
+
wordPolicy?: GuardrailWordPolicy | undefined;
|
|
192
|
+
/**
|
|
193
|
+
* <p>The sensitive information policy that was configured for the guardrail.</p>
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicy | undefined;
|
|
197
|
+
/**
|
|
198
|
+
* <p>The contextual grounding policy used in the guardrail.</p>
|
|
199
|
+
* @public
|
|
200
|
+
*/
|
|
201
|
+
contextualGroundingPolicy?: GuardrailContextualGroundingPolicy | undefined;
|
|
202
|
+
/**
|
|
203
|
+
* <p>The current Automated Reasoning policy configuration for the guardrail, if any is configured.</p>
|
|
204
|
+
* @public
|
|
205
|
+
*/
|
|
206
|
+
automatedReasoningPolicy?: GuardrailAutomatedReasoningPolicy | undefined;
|
|
207
|
+
/**
|
|
208
|
+
* <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>
|
|
209
|
+
* @public
|
|
210
|
+
*/
|
|
211
|
+
crossRegionDetails?: GuardrailCrossRegionDetails | undefined;
|
|
212
|
+
/**
|
|
213
|
+
* <p>The date and time at which the guardrail was created.</p>
|
|
214
|
+
* @public
|
|
215
|
+
*/
|
|
216
|
+
createdAt: Date | undefined;
|
|
217
|
+
/**
|
|
218
|
+
* <p>The date and time at which the guardrail was updated.</p>
|
|
219
|
+
* @public
|
|
220
|
+
*/
|
|
221
|
+
updatedAt: Date | undefined;
|
|
222
|
+
/**
|
|
223
|
+
* <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>
|
|
224
|
+
* @public
|
|
225
|
+
*/
|
|
226
|
+
statusReasons?: string[] | undefined;
|
|
227
|
+
/**
|
|
228
|
+
* <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>
|
|
229
|
+
* @public
|
|
230
|
+
*/
|
|
231
|
+
failureRecommendations?: string[] | undefined;
|
|
232
|
+
/**
|
|
233
|
+
* <p>The message that the guardrail returns when it blocks a prompt.</p>
|
|
234
|
+
* @public
|
|
235
|
+
*/
|
|
236
|
+
blockedInputMessaging: string | undefined;
|
|
237
|
+
/**
|
|
238
|
+
* <p>The message that the guardrail returns when it blocks a model response.</p>
|
|
239
|
+
* @public
|
|
240
|
+
*/
|
|
241
|
+
blockedOutputsMessaging: string | undefined;
|
|
242
|
+
/**
|
|
243
|
+
* <p>The ARN of the KMS key that encrypts the guardrail.</p>
|
|
244
|
+
* @public
|
|
245
|
+
*/
|
|
246
|
+
kmsKeyArn?: string | undefined;
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
* @public
|
|
250
|
+
*/
|
|
251
|
+
export interface ListGuardrailsRequest {
|
|
252
|
+
/**
|
|
253
|
+
* <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
|
|
254
|
+
* @public
|
|
255
|
+
*/
|
|
256
|
+
guardrailIdentifier?: string | undefined;
|
|
257
|
+
/**
|
|
258
|
+
* <p>The maximum number of results to return in the response.</p>
|
|
259
|
+
* @public
|
|
260
|
+
*/
|
|
261
|
+
maxResults?: number | undefined;
|
|
262
|
+
/**
|
|
263
|
+
* <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>
|
|
264
|
+
* @public
|
|
265
|
+
*/
|
|
266
|
+
nextToken?: string | undefined;
|
|
267
|
+
}
|
|
268
|
+
/**
|
|
269
|
+
* <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>
|
|
270
|
+
* @public
|
|
271
|
+
*/
|
|
272
|
+
export interface GuardrailSummary {
|
|
273
|
+
/**
|
|
274
|
+
* <p>The unique identifier of the guardrail.</p>
|
|
275
|
+
* @public
|
|
276
|
+
*/
|
|
277
|
+
id: string | undefined;
|
|
278
|
+
/**
|
|
279
|
+
* <p>The ARN of the guardrail.</p>
|
|
280
|
+
* @public
|
|
281
|
+
*/
|
|
282
|
+
arn: string | undefined;
|
|
283
|
+
/**
|
|
284
|
+
* <p>The status of the guardrail.</p>
|
|
285
|
+
* @public
|
|
286
|
+
*/
|
|
287
|
+
status: GuardrailStatus | undefined;
|
|
288
|
+
/**
|
|
289
|
+
* <p>The name of the guardrail.</p>
|
|
290
|
+
* @public
|
|
291
|
+
*/
|
|
292
|
+
name: string | undefined;
|
|
293
|
+
/**
|
|
294
|
+
* <p>A description of the guardrail.</p>
|
|
295
|
+
* @public
|
|
296
|
+
*/
|
|
297
|
+
description?: string | undefined;
|
|
298
|
+
/**
|
|
299
|
+
* <p>The version of the guardrail.</p>
|
|
300
|
+
* @public
|
|
301
|
+
*/
|
|
302
|
+
version: string | undefined;
|
|
303
|
+
/**
|
|
304
|
+
* <p>The date and time at which the guardrail was created.</p>
|
|
305
|
+
* @public
|
|
306
|
+
*/
|
|
307
|
+
createdAt: Date | undefined;
|
|
308
|
+
/**
|
|
309
|
+
* <p>The date and time at which the guardrail was last updated.</p>
|
|
310
|
+
* @public
|
|
311
|
+
*/
|
|
312
|
+
updatedAt: Date | undefined;
|
|
313
|
+
/**
|
|
314
|
+
* <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>
|
|
315
|
+
* @public
|
|
316
|
+
*/
|
|
317
|
+
crossRegionDetails?: GuardrailCrossRegionDetails | undefined;
|
|
318
|
+
}
|
|
319
|
+
/**
|
|
320
|
+
* @public
|
|
321
|
+
*/
|
|
322
|
+
export interface ListGuardrailsResponse {
|
|
323
|
+
/**
|
|
324
|
+
* <p>A list of objects, each of which contains details about a guardrail.</p>
|
|
325
|
+
* @public
|
|
326
|
+
*/
|
|
327
|
+
guardrails: GuardrailSummary[] | undefined;
|
|
328
|
+
/**
|
|
329
|
+
* <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>
|
|
330
|
+
* @public
|
|
331
|
+
*/
|
|
332
|
+
nextToken?: string | undefined;
|
|
333
|
+
}
|
|
334
|
+
/**
|
|
335
|
+
* @public
|
|
336
|
+
*/
|
|
337
|
+
export interface UpdateGuardrailRequest {
|
|
338
|
+
/**
|
|
339
|
+
* <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
|
|
340
|
+
* @public
|
|
341
|
+
*/
|
|
342
|
+
guardrailIdentifier: string | undefined;
|
|
343
|
+
/**
|
|
344
|
+
* <p>A name for the guardrail.</p>
|
|
345
|
+
* @public
|
|
346
|
+
*/
|
|
347
|
+
name: string | undefined;
|
|
348
|
+
/**
|
|
349
|
+
* <p>A description of the guardrail.</p>
|
|
350
|
+
* @public
|
|
351
|
+
*/
|
|
352
|
+
description?: string | undefined;
|
|
353
|
+
/**
|
|
354
|
+
* <p>The topic policy to configure for the guardrail.</p>
|
|
355
|
+
* @public
|
|
356
|
+
*/
|
|
357
|
+
topicPolicyConfig?: GuardrailTopicPolicyConfig | undefined;
|
|
358
|
+
/**
|
|
359
|
+
* <p>The content policy to configure for the guardrail.</p>
|
|
360
|
+
* @public
|
|
361
|
+
*/
|
|
362
|
+
contentPolicyConfig?: GuardrailContentPolicyConfig | undefined;
|
|
363
|
+
/**
|
|
364
|
+
* <p>The word policy to configure for the guardrail.</p>
|
|
365
|
+
* @public
|
|
366
|
+
*/
|
|
367
|
+
wordPolicyConfig?: GuardrailWordPolicyConfig | undefined;
|
|
368
|
+
/**
|
|
369
|
+
* <p>The sensitive information policy to configure for the guardrail.</p>
|
|
370
|
+
* @public
|
|
371
|
+
*/
|
|
372
|
+
sensitiveInformationPolicyConfig?: GuardrailSensitiveInformationPolicyConfig | undefined;
|
|
373
|
+
/**
|
|
374
|
+
* <p>The contextual grounding policy configuration used to update a guardrail.</p>
|
|
375
|
+
* @public
|
|
376
|
+
*/
|
|
377
|
+
contextualGroundingPolicyConfig?: GuardrailContextualGroundingPolicyConfig | undefined;
|
|
378
|
+
/**
|
|
379
|
+
* <p>Updated configuration for Automated Reasoning policies associated with the guardrail.</p>
|
|
380
|
+
* @public
|
|
381
|
+
*/
|
|
382
|
+
automatedReasoningPolicyConfig?: GuardrailAutomatedReasoningPolicyConfig | undefined;
|
|
383
|
+
/**
|
|
384
|
+
* <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>
|
|
385
|
+
* @public
|
|
386
|
+
*/
|
|
387
|
+
crossRegionConfig?: GuardrailCrossRegionConfig | undefined;
|
|
388
|
+
/**
|
|
389
|
+
* <p>The message to return when the guardrail blocks a prompt.</p>
|
|
390
|
+
* @public
|
|
391
|
+
*/
|
|
392
|
+
blockedInputMessaging: string | undefined;
|
|
393
|
+
/**
|
|
394
|
+
* <p>The message to return when the guardrail blocks a model response.</p>
|
|
395
|
+
* @public
|
|
396
|
+
*/
|
|
397
|
+
blockedOutputsMessaging: string | undefined;
|
|
398
|
+
/**
|
|
399
|
+
* <p>The ARN of the KMS key with which to encrypt the guardrail.</p>
|
|
400
|
+
* @public
|
|
401
|
+
*/
|
|
402
|
+
kmsKeyId?: string | undefined;
|
|
403
|
+
}
|
|
404
|
+
/**
|
|
405
|
+
* @public
|
|
406
|
+
*/
|
|
407
|
+
export interface UpdateGuardrailResponse {
|
|
408
|
+
/**
|
|
409
|
+
* <p>The unique identifier of the guardrail</p>
|
|
410
|
+
* @public
|
|
411
|
+
*/
|
|
412
|
+
guardrailId: string | undefined;
|
|
413
|
+
/**
|
|
414
|
+
* <p>The ARN of the guardrail.</p>
|
|
415
|
+
* @public
|
|
416
|
+
*/
|
|
417
|
+
guardrailArn: string | undefined;
|
|
418
|
+
/**
|
|
419
|
+
* <p>The version of the guardrail.</p>
|
|
420
|
+
* @public
|
|
421
|
+
*/
|
|
422
|
+
version: string | undefined;
|
|
423
|
+
/**
|
|
424
|
+
* <p>The date and time at which the guardrail was updated.</p>
|
|
425
|
+
* @public
|
|
426
|
+
*/
|
|
427
|
+
updatedAt: Date | undefined;
|
|
428
|
+
}
|
|
429
|
+
/**
|
|
430
|
+
* <p>Contains information about the model or system-defined inference profile that is the source for an inference profile..</p>
|
|
431
|
+
* @public
|
|
432
|
+
*/
|
|
433
|
+
export type InferenceProfileModelSource = InferenceProfileModelSource.CopyFromMember | InferenceProfileModelSource.$UnknownMember;
|
|
434
|
+
/**
|
|
435
|
+
* @public
|
|
436
|
+
*/
|
|
437
|
+
export declare namespace InferenceProfileModelSource {
|
|
438
|
+
/**
|
|
439
|
+
* <p>The ARN of the model or system-defined inference profile that is the source for the inference profile.</p>
|
|
440
|
+
* @public
|
|
441
|
+
*/
|
|
442
|
+
interface CopyFromMember {
|
|
443
|
+
copyFrom: string;
|
|
444
|
+
$unknown?: never;
|
|
445
|
+
}
|
|
446
|
+
/**
|
|
447
|
+
* @public
|
|
448
|
+
*/
|
|
449
|
+
interface $UnknownMember {
|
|
450
|
+
copyFrom?: never;
|
|
451
|
+
$unknown: [string, any];
|
|
452
|
+
}
|
|
453
|
+
/**
|
|
454
|
+
* @deprecated unused in schema-serde mode.
|
|
455
|
+
*
|
|
456
|
+
*/
|
|
457
|
+
interface Visitor<T> {
|
|
458
|
+
copyFrom: (value: string) => T;
|
|
459
|
+
_: (name: string, value: any) => T;
|
|
460
|
+
}
|
|
461
|
+
}
|
|
462
|
+
/**
|
|
463
|
+
* @public
|
|
464
|
+
*/
|
|
465
|
+
export interface CreateInferenceProfileRequest {
|
|
466
|
+
/**
|
|
467
|
+
* <p>A name for the inference profile.</p>
|
|
468
|
+
* @public
|
|
469
|
+
*/
|
|
470
|
+
inferenceProfileName: string | undefined;
|
|
471
|
+
/**
|
|
472
|
+
* <p>A description for the inference profile.</p>
|
|
473
|
+
* @public
|
|
474
|
+
*/
|
|
475
|
+
description?: string | undefined;
|
|
476
|
+
/**
|
|
477
|
+
* <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>
|
|
478
|
+
* @public
|
|
479
|
+
*/
|
|
480
|
+
clientRequestToken?: string | undefined;
|
|
481
|
+
/**
|
|
482
|
+
* <p>The foundation model or system-defined inference profile that the inference profile will track metrics and costs for.</p>
|
|
483
|
+
* @public
|
|
484
|
+
*/
|
|
485
|
+
modelSource: InferenceProfileModelSource | undefined;
|
|
486
|
+
/**
|
|
487
|
+
* <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>
|
|
488
|
+
* @public
|
|
489
|
+
*/
|
|
490
|
+
tags?: Tag[] | undefined;
|
|
491
|
+
}
|
|
492
|
+
/**
|
|
493
|
+
* @public
|
|
494
|
+
*/
|
|
495
|
+
export interface CreateInferenceProfileResponse {
|
|
496
|
+
/**
|
|
497
|
+
* <p>The ARN of the inference profile that you created.</p>
|
|
498
|
+
* @public
|
|
499
|
+
*/
|
|
500
|
+
inferenceProfileArn: string | undefined;
|
|
501
|
+
/**
|
|
502
|
+
* <p>The status of the inference profile. <code>ACTIVE</code> means that the inference profile is ready to be used.</p>
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
505
|
+
status?: InferenceProfileStatus | undefined;
|
|
506
|
+
}
|
|
3
507
|
/**
|
|
4
508
|
* @public
|
|
5
509
|
*/
|
|
@@ -44,8 +44,13 @@ export declare var AutomatedReasoningPolicyAddTypeMutation$: StaticStructureSche
|
|
|
44
44
|
export declare var AutomatedReasoningPolicyAddTypeValue$: StaticStructureSchema;
|
|
45
45
|
export declare var AutomatedReasoningPolicyAddVariableAnnotation$: StaticStructureSchema;
|
|
46
46
|
export declare var AutomatedReasoningPolicyAddVariableMutation$: StaticStructureSchema;
|
|
47
|
+
export declare var AutomatedReasoningPolicyAnnotatedChunk$: StaticStructureSchema;
|
|
48
|
+
export declare var AutomatedReasoningPolicyAnnotatedLine$: StaticStructureSchema;
|
|
49
|
+
export declare var AutomatedReasoningPolicyAtomicStatement$: StaticStructureSchema;
|
|
47
50
|
export declare var AutomatedReasoningPolicyBuildLog$: StaticStructureSchema;
|
|
48
51
|
export declare var AutomatedReasoningPolicyBuildLogEntry$: StaticStructureSchema;
|
|
52
|
+
export declare var AutomatedReasoningPolicyBuildResultAssetManifest$: StaticStructureSchema;
|
|
53
|
+
export declare var AutomatedReasoningPolicyBuildResultAssetManifestEntry$: StaticStructureSchema;
|
|
49
54
|
export declare var AutomatedReasoningPolicyBuildStep$: StaticStructureSchema;
|
|
50
55
|
export declare var AutomatedReasoningPolicyBuildStepMessage$: StaticStructureSchema;
|
|
51
56
|
export declare var AutomatedReasoningPolicyBuildWorkflowDocument$: StaticStructureSchema;
|
|
@@ -67,12 +72,18 @@ export declare var AutomatedReasoningPolicyDeleteTypeValue$: StaticStructureSche
|
|
|
67
72
|
export declare var AutomatedReasoningPolicyDeleteVariableAnnotation$: StaticStructureSchema;
|
|
68
73
|
export declare var AutomatedReasoningPolicyDeleteVariableMutation$: StaticStructureSchema;
|
|
69
74
|
export declare var AutomatedReasoningPolicyDisjointRuleSet$: StaticStructureSchema;
|
|
75
|
+
export declare var AutomatedReasoningPolicyFidelityReport$: StaticStructureSchema;
|
|
70
76
|
export declare var AutomatedReasoningPolicyGeneratedTestCase$: StaticStructureSchema;
|
|
71
77
|
export declare var AutomatedReasoningPolicyGeneratedTestCases$: StaticStructureSchema;
|
|
72
78
|
export declare var AutomatedReasoningPolicyIngestContentAnnotation$: StaticStructureSchema;
|
|
73
79
|
export declare var AutomatedReasoningPolicyPlanning$: StaticStructureSchema;
|
|
80
|
+
export declare var AutomatedReasoningPolicyReportSourceDocument$: StaticStructureSchema;
|
|
81
|
+
export declare var AutomatedReasoningPolicyRuleReport$: StaticStructureSchema;
|
|
74
82
|
export declare var AutomatedReasoningPolicyScenario$: StaticStructureSchema;
|
|
75
83
|
export declare var AutomatedReasoningPolicyScenarios$: StaticStructureSchema;
|
|
84
|
+
export declare var AutomatedReasoningPolicySourceDocument$: StaticStructureSchema;
|
|
85
|
+
export declare var AutomatedReasoningPolicyStatementLocation$: StaticStructureSchema;
|
|
86
|
+
export declare var AutomatedReasoningPolicyStatementReference$: StaticStructureSchema;
|
|
76
87
|
export declare var AutomatedReasoningPolicySummary$: StaticStructureSchema;
|
|
77
88
|
export declare var AutomatedReasoningPolicyTestCase$: StaticStructureSchema;
|
|
78
89
|
export declare var AutomatedReasoningPolicyTestResult$: StaticStructureSchema;
|
|
@@ -85,6 +96,7 @@ export declare var AutomatedReasoningPolicyUpdateTypeMutation$: StaticStructureS
|
|
|
85
96
|
export declare var AutomatedReasoningPolicyUpdateTypeValue$: StaticStructureSchema;
|
|
86
97
|
export declare var AutomatedReasoningPolicyUpdateVariableAnnotation$: StaticStructureSchema;
|
|
87
98
|
export declare var AutomatedReasoningPolicyUpdateVariableMutation$: StaticStructureSchema;
|
|
99
|
+
export declare var AutomatedReasoningPolicyVariableReport$: StaticStructureSchema;
|
|
88
100
|
export declare var BatchDeleteEvaluationJobError$: StaticStructureSchema;
|
|
89
101
|
export declare var BatchDeleteEvaluationJobItem$: StaticStructureSchema;
|
|
90
102
|
export declare var BatchDeleteEvaluationJobRequest$: StaticStructureSchema;
|
|
@@ -416,10 +428,12 @@ export declare var VectorSearchRerankingConfiguration$: StaticStructureSchema;
|
|
|
416
428
|
export declare var VpcConfig$: StaticStructureSchema;
|
|
417
429
|
export declare var AutomatedEvaluationCustomMetricSource$: StaticUnionSchema;
|
|
418
430
|
export declare var AutomatedReasoningCheckFinding$: StaticUnionSchema;
|
|
431
|
+
export declare var AutomatedReasoningPolicyAnnotatedContent$: StaticUnionSchema;
|
|
419
432
|
export declare var AutomatedReasoningPolicyAnnotation$: StaticUnionSchema;
|
|
420
433
|
export declare var AutomatedReasoningPolicyBuildResultAssets$: StaticUnionSchema;
|
|
421
434
|
export declare var AutomatedReasoningPolicyBuildStepContext$: StaticUnionSchema;
|
|
422
435
|
export declare var AutomatedReasoningPolicyDefinitionElement$: StaticUnionSchema;
|
|
436
|
+
export declare var AutomatedReasoningPolicyGenerateFidelityReportContent$: StaticUnionSchema;
|
|
423
437
|
export declare var AutomatedReasoningPolicyMutation$: StaticUnionSchema;
|
|
424
438
|
export declare var AutomatedReasoningPolicyTypeValueAnnotation$: StaticUnionSchema;
|
|
425
439
|
export declare var AutomatedReasoningPolicyWorkflowTypeContent$: StaticUnionSchema;
|
|
@@ -5,7 +5,8 @@ import {
|
|
|
5
5
|
ServiceInputTypes,
|
|
6
6
|
ServiceOutputTypes,
|
|
7
7
|
} from "../BedrockClient";
|
|
8
|
-
import { GetGuardrailRequest
|
|
8
|
+
import { GetGuardrailRequest } from "../models/models_0";
|
|
9
|
+
import { GetGuardrailResponse } from "../models/models_1";
|
|
9
10
|
export { __MetadataBearer };
|
|
10
11
|
export { $Command };
|
|
11
12
|
export interface GetGuardrailCommandInput extends GetGuardrailRequest {}
|
|
@@ -8,7 +8,7 @@ import {
|
|
|
8
8
|
import {
|
|
9
9
|
ListGuardrailsRequest,
|
|
10
10
|
ListGuardrailsResponse,
|
|
11
|
-
} from "../models/
|
|
11
|
+
} from "../models/models_1";
|
|
12
12
|
export { __MetadataBearer };
|
|
13
13
|
export { $Command };
|
|
14
14
|
export interface ListGuardrailsCommandInput extends ListGuardrailsRequest {}
|
|
@@ -8,7 +8,7 @@ import {
|
|
|
8
8
|
import {
|
|
9
9
|
UpdateGuardrailRequest,
|
|
10
10
|
UpdateGuardrailResponse,
|
|
11
|
-
} from "../models/
|
|
11
|
+
} from "../models/models_1";
|
|
12
12
|
export { __MetadataBearer };
|
|
13
13
|
export { $Command };
|
|
14
14
|
export interface UpdateGuardrailCommandInput extends UpdateGuardrailRequest {}
|
|
@@ -28,6 +28,7 @@ export declare const AutomatedReasoningCheckResult: {
|
|
|
28
28
|
export type AutomatedReasoningCheckResult =
|
|
29
29
|
(typeof AutomatedReasoningCheckResult)[keyof typeof AutomatedReasoningCheckResult];
|
|
30
30
|
export declare const AutomatedReasoningPolicyBuildWorkflowType: {
|
|
31
|
+
readonly GENERATE_FIDELITY_REPORT: "GENERATE_FIDELITY_REPORT";
|
|
31
32
|
readonly IMPORT_POLICY: "IMPORT_POLICY";
|
|
32
33
|
readonly INGEST_CONTENT: "INGEST_CONTENT";
|
|
33
34
|
readonly REFINE_POLICY: "REFINE_POLICY";
|
|
@@ -53,11 +54,14 @@ export declare const AutomatedReasoningPolicyBuildWorkflowStatus: {
|
|
|
53
54
|
export type AutomatedReasoningPolicyBuildWorkflowStatus =
|
|
54
55
|
(typeof AutomatedReasoningPolicyBuildWorkflowStatus)[keyof typeof AutomatedReasoningPolicyBuildWorkflowStatus];
|
|
55
56
|
export declare const AutomatedReasoningPolicyBuildResultAssetType: {
|
|
57
|
+
readonly ASSET_MANIFEST: "ASSET_MANIFEST";
|
|
56
58
|
readonly BUILD_LOG: "BUILD_LOG";
|
|
59
|
+
readonly FIDELITY_REPORT: "FIDELITY_REPORT";
|
|
57
60
|
readonly GENERATED_TEST_CASES: "GENERATED_TEST_CASES";
|
|
58
61
|
readonly POLICY_DEFINITION: "POLICY_DEFINITION";
|
|
59
62
|
readonly POLICY_SCENARIOS: "POLICY_SCENARIOS";
|
|
60
63
|
readonly QUALITY_REPORT: "QUALITY_REPORT";
|
|
64
|
+
readonly SOURCE_DOCUMENT: "SOURCE_DOCUMENT";
|
|
61
65
|
};
|
|
62
66
|
export type AutomatedReasoningPolicyBuildResultAssetType =
|
|
63
67
|
(typeof AutomatedReasoningPolicyBuildResultAssetType)[keyof typeof AutomatedReasoningPolicyBuildResultAssetType];
|