@aws-sdk/client-bedrock 3.1046.0 → 3.1047.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.
Files changed (55) hide show
  1. package/README.md +35 -0
  2. package/dist-cjs/index.js +91 -7
  3. package/dist-cjs/models/errors.js +14 -14
  4. package/dist-cjs/schemas/schemas_0.js +192 -46
  5. package/dist-es/Bedrock.js +12 -0
  6. package/dist-es/commands/BatchDeleteAdvancedPromptOptimizationJobCommand.js +16 -0
  7. package/dist-es/commands/CreateAdvancedPromptOptimizationJobCommand.js +16 -0
  8. package/dist-es/commands/GetAdvancedPromptOptimizationJobCommand.js +16 -0
  9. package/dist-es/commands/ListAdvancedPromptOptimizationJobsCommand.js +16 -0
  10. package/dist-es/commands/StopAdvancedPromptOptimizationJobCommand.js +16 -0
  11. package/dist-es/commands/index.js +5 -0
  12. package/dist-es/models/enums.js +16 -7
  13. package/dist-es/models/errors.js +12 -12
  14. package/dist-es/pagination/ListAdvancedPromptOptimizationJobsPaginator.js +4 -0
  15. package/dist-es/pagination/index.js +1 -0
  16. package/dist-es/schemas/schemas_0.js +180 -34
  17. package/dist-types/Bedrock.d.ts +43 -0
  18. package/dist-types/BedrockClient.d.ts +7 -2
  19. package/dist-types/commands/BatchDeleteAdvancedPromptOptimizationJobCommand.d.ts +102 -0
  20. package/dist-types/commands/CreateAdvancedPromptOptimizationJobCommand.d.ts +131 -0
  21. package/dist-types/commands/CreateGuardrailCommand.d.ts +1 -1
  22. package/dist-types/commands/CreateGuardrailVersionCommand.d.ts +1 -1
  23. package/dist-types/commands/DeleteGuardrailCommand.d.ts +1 -1
  24. package/dist-types/commands/GetAdvancedPromptOptimizationJobCommand.d.ts +120 -0
  25. package/dist-types/commands/GetGuardrailCommand.d.ts +1 -2
  26. package/dist-types/commands/ListAdvancedPromptOptimizationJobsCommand.d.ts +100 -0
  27. package/dist-types/commands/StopAdvancedPromptOptimizationJobCommand.d.ts +92 -0
  28. package/dist-types/commands/index.d.ts +5 -0
  29. package/dist-types/models/enums.d.ts +40 -23
  30. package/dist-types/models/errors.d.ts +12 -12
  31. package/dist-types/models/models_0.d.ts +3481 -3544
  32. package/dist-types/models/models_1.d.ts +417 -2
  33. package/dist-types/pagination/ListAdvancedPromptOptimizationJobsPaginator.d.ts +7 -0
  34. package/dist-types/pagination/index.d.ts +1 -0
  35. package/dist-types/schemas/schemas_0.d.ts +22 -0
  36. package/dist-types/ts3.4/Bedrock.d.ts +117 -0
  37. package/dist-types/ts3.4/BedrockClient.d.ts +30 -0
  38. package/dist-types/ts3.4/commands/BatchDeleteAdvancedPromptOptimizationJobCommand.d.ts +53 -0
  39. package/dist-types/ts3.4/commands/CreateAdvancedPromptOptimizationJobCommand.d.ts +53 -0
  40. package/dist-types/ts3.4/commands/CreateGuardrailCommand.d.ts +1 -1
  41. package/dist-types/ts3.4/commands/CreateGuardrailVersionCommand.d.ts +1 -1
  42. package/dist-types/ts3.4/commands/DeleteGuardrailCommand.d.ts +1 -1
  43. package/dist-types/ts3.4/commands/GetAdvancedPromptOptimizationJobCommand.d.ts +53 -0
  44. package/dist-types/ts3.4/commands/GetGuardrailCommand.d.ts +1 -2
  45. package/dist-types/ts3.4/commands/ListAdvancedPromptOptimizationJobsCommand.d.ts +53 -0
  46. package/dist-types/ts3.4/commands/StopAdvancedPromptOptimizationJobCommand.d.ts +53 -0
  47. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  48. package/dist-types/ts3.4/models/enums.d.ts +20 -9
  49. package/dist-types/ts3.4/models/errors.d.ts +7 -7
  50. package/dist-types/ts3.4/models/models_0.d.ts +90 -107
  51. package/dist-types/ts3.4/models/models_1.d.ts +114 -7
  52. package/dist-types/ts3.4/pagination/ListAdvancedPromptOptimizationJobsPaginator.d.ts +11 -0
  53. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  54. package/dist-types/ts3.4/schemas/schemas_0.d.ts +22 -0
  55. package/package.json +6 -6
@@ -1,5 +1,420 @@
1
- import type { ApplicationType, AuthorizationStatus, CommitmentDuration, CustomizationType, EntitlementAvailability, EvaluationJobStatus, EvaluationJobType, FineTuningJobStatus, FoundationModelLifecycleStatus, GuardrailManagedWordsType, GuardrailStatus, GuardrailTopicAction, GuardrailTopicsTierName, GuardrailTopicType, GuardrailWordAction, InferenceProfileStatus, InferenceProfileType, InferenceType, JobStatusDetails, ModelCopyJobStatus, ModelCustomization, ModelCustomizationJobStatus, ModelImportJobStatus, ModelInvocationJobStatus, ModelInvocationType, ModelModality, OfferType, PromptRouterStatus, PromptRouterType, ProvisionedModelStatus, RegionAvailability, RetrieveAndGenerateType, S3InputFormat, SearchType, SortByProvisionedModels, SortJobsBy, SortModelsBy, SortOrder } from "./enums";
2
- import type { AgreementAvailability, CustomizationConfig, EvaluationConfig, EvaluationModelConfig, EvaluationOutputDataConfig, EvaluationPrecomputedRagSourceConfig, ExternalSourcesRetrieveAndGenerateConfiguration, FilterAttribute, GenerationConfiguration, GuardrailAutomatedReasoningPolicy, GuardrailAutomatedReasoningPolicyConfig, GuardrailContentPolicy, GuardrailContentPolicyConfig, GuardrailContextualGroundingPolicy, GuardrailContextualGroundingPolicyConfig, GuardrailCrossRegionConfig, GuardrailCrossRegionDetails, GuardrailPiiEntity, GuardrailRegex, GuardrailSensitiveInformationPolicyConfig, GuardrailTopicPolicyConfig, GuardrailWordPolicyConfig, ImplicitFilterConfiguration, ModelDataSource, OrchestrationConfiguration, OutputDataConfig, Tag, TrainingDataConfig, TrainingMetrics, ValidationDataConfig, ValidatorMetric, VectorSearchRerankingConfiguration, VpcConfig } from "./models_0";
1
+ import type { ApplicationType, AuthorizationStatus, CommitmentDuration, CustomizationType, EntitlementAvailability, EvaluationJobStatus, EvaluationJobType, FineTuningJobStatus, FoundationModelLifecycleStatus, GuardrailContentFilterAction, GuardrailContentFiltersTierName, GuardrailContentFilterType, GuardrailContextualGroundingAction, GuardrailContextualGroundingFilterType, GuardrailFilterStrength, GuardrailManagedWordsType, GuardrailModality, GuardrailPiiEntityType, GuardrailSensitiveInformationAction, GuardrailStatus, GuardrailTopicAction, GuardrailTopicsTierName, GuardrailTopicType, GuardrailWordAction, InferenceProfileStatus, InferenceProfileType, InferenceType, JobStatusDetails, ModelCopyJobStatus, ModelCustomization, ModelCustomizationJobStatus, ModelImportJobStatus, ModelInvocationJobStatus, ModelInvocationType, ModelModality, OfferType, PromptRouterStatus, PromptRouterType, ProvisionedModelStatus, RegionAvailability, RetrieveAndGenerateType, S3InputFormat, SearchType, SortByProvisionedModels, SortJobsBy, SortModelsBy, SortOrder } from "./enums";
2
+ import type { AgreementAvailability, CustomizationConfig, EvaluationConfig, EvaluationModelConfig, EvaluationOutputDataConfig, EvaluationPrecomputedRagSourceConfig, ExternalSourcesRetrieveAndGenerateConfiguration, FilterAttribute, GenerationConfiguration, GuardrailAutomatedReasoningPolicyConfig, GuardrailContentPolicyConfig, GuardrailContextualGroundingPolicyConfig, GuardrailCrossRegionConfig, GuardrailManagedWordsConfig, GuardrailSensitiveInformationPolicyConfig, GuardrailTopicPolicyConfig, GuardrailWordConfig, ImplicitFilterConfiguration, ModelDataSource, OrchestrationConfiguration, OutputDataConfig, Tag, TrainingDataConfig, TrainingMetrics, ValidationDataConfig, ValidatorMetric, VectorSearchRerankingConfiguration, VpcConfig } from "./models_0";
3
+ /**
4
+ * <p>Contains details about the word policy to configured for the guardrail.</p>
5
+ * @public
6
+ */
7
+ export interface GuardrailWordPolicyConfig {
8
+ /**
9
+ * <p>A list of words to configure for the guardrail.</p>
10
+ * @public
11
+ */
12
+ wordsConfig?: GuardrailWordConfig[] | undefined;
13
+ /**
14
+ * <p>A list of managed words to configure for the guardrail.</p>
15
+ * @public
16
+ */
17
+ managedWordListsConfig?: GuardrailManagedWordsConfig[] | undefined;
18
+ }
19
+ /**
20
+ * @public
21
+ */
22
+ export interface CreateGuardrailRequest {
23
+ /**
24
+ * <p>The name to give the guardrail.</p>
25
+ * @public
26
+ */
27
+ name: string | undefined;
28
+ /**
29
+ * <p>A description of the guardrail.</p>
30
+ * @public
31
+ */
32
+ description?: string | undefined;
33
+ /**
34
+ * <p>The topic policies to configure for the guardrail.</p>
35
+ * @public
36
+ */
37
+ topicPolicyConfig?: GuardrailTopicPolicyConfig | undefined;
38
+ /**
39
+ * <p>The content filter policies to configure for the guardrail.</p>
40
+ * @public
41
+ */
42
+ contentPolicyConfig?: GuardrailContentPolicyConfig | undefined;
43
+ /**
44
+ * <p>The word policy you configure for the guardrail.</p>
45
+ * @public
46
+ */
47
+ wordPolicyConfig?: GuardrailWordPolicyConfig | undefined;
48
+ /**
49
+ * <p>The sensitive information policy to configure for the guardrail.</p>
50
+ * @public
51
+ */
52
+ sensitiveInformationPolicyConfig?: GuardrailSensitiveInformationPolicyConfig | undefined;
53
+ /**
54
+ * <p>The contextual grounding policy configuration used to create a guardrail.</p>
55
+ * @public
56
+ */
57
+ contextualGroundingPolicyConfig?: GuardrailContextualGroundingPolicyConfig | undefined;
58
+ /**
59
+ * <p>Optional configuration for integrating Automated Reasoning policies with the new guardrail.</p>
60
+ * @public
61
+ */
62
+ automatedReasoningPolicyConfig?: GuardrailAutomatedReasoningPolicyConfig | undefined;
63
+ /**
64
+ * <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>
65
+ * @public
66
+ */
67
+ crossRegionConfig?: GuardrailCrossRegionConfig | undefined;
68
+ /**
69
+ * <p>The message to return when the guardrail blocks a prompt.</p>
70
+ * @public
71
+ */
72
+ blockedInputMessaging: string | undefined;
73
+ /**
74
+ * <p>The message to return when the guardrail blocks a model response.</p>
75
+ * @public
76
+ */
77
+ blockedOutputsMessaging: string | undefined;
78
+ /**
79
+ * <p>The ARN of the KMS key that you use to encrypt the guardrail.</p>
80
+ * @public
81
+ */
82
+ kmsKeyId?: string | undefined;
83
+ /**
84
+ * <p>The tags that you want to attach to the guardrail. </p>
85
+ * @public
86
+ */
87
+ tags?: Tag[] | undefined;
88
+ /**
89
+ * <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>
90
+ * @public
91
+ */
92
+ clientRequestToken?: string | undefined;
93
+ }
94
+ /**
95
+ * @public
96
+ */
97
+ export interface CreateGuardrailResponse {
98
+ /**
99
+ * <p>The unique identifier of the guardrail that was created.</p>
100
+ * @public
101
+ */
102
+ guardrailId: string | undefined;
103
+ /**
104
+ * <p>The ARN of the guardrail.</p>
105
+ * @public
106
+ */
107
+ guardrailArn: string | undefined;
108
+ /**
109
+ * <p>The version of the guardrail that was created. This value will always be <code>DRAFT</code>.</p>
110
+ * @public
111
+ */
112
+ version: string | undefined;
113
+ /**
114
+ * <p>The time at which the guardrail was created.</p>
115
+ * @public
116
+ */
117
+ createdAt: Date | undefined;
118
+ }
119
+ /**
120
+ * @public
121
+ */
122
+ export interface CreateGuardrailVersionRequest {
123
+ /**
124
+ * <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
125
+ * @public
126
+ */
127
+ guardrailIdentifier: string | undefined;
128
+ /**
129
+ * <p>A description of the guardrail version.</p>
130
+ * @public
131
+ */
132
+ description?: string | undefined;
133
+ /**
134
+ * <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>
135
+ * @public
136
+ */
137
+ clientRequestToken?: string | undefined;
138
+ }
139
+ /**
140
+ * @public
141
+ */
142
+ export interface CreateGuardrailVersionResponse {
143
+ /**
144
+ * <p>The unique identifier of the guardrail.</p>
145
+ * @public
146
+ */
147
+ guardrailId: string | undefined;
148
+ /**
149
+ * <p>The number of the version of the guardrail.</p>
150
+ * @public
151
+ */
152
+ version: string | undefined;
153
+ }
154
+ /**
155
+ * @public
156
+ */
157
+ export interface DeleteGuardrailRequest {
158
+ /**
159
+ * <p>The unique identifier of the guardrail. This can be an ID or the ARN.</p>
160
+ * @public
161
+ */
162
+ guardrailIdentifier: string | undefined;
163
+ /**
164
+ * <p>The version of the guardrail.</p>
165
+ * @public
166
+ */
167
+ guardrailVersion?: string | undefined;
168
+ }
169
+ /**
170
+ * @public
171
+ */
172
+ export interface DeleteGuardrailResponse {
173
+ }
174
+ /**
175
+ * @public
176
+ */
177
+ export interface GetGuardrailRequest {
178
+ /**
179
+ * <p>The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.</p>
180
+ * @public
181
+ */
182
+ guardrailIdentifier: string | undefined;
183
+ /**
184
+ * <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>
185
+ * @public
186
+ */
187
+ guardrailVersion?: string | undefined;
188
+ }
189
+ /**
190
+ * <p>Represents the configuration of Automated Reasoning policies within a Amazon Bedrock Guardrail, including the policies to apply and confidence thresholds.</p>
191
+ * @public
192
+ */
193
+ export interface GuardrailAutomatedReasoningPolicy {
194
+ /**
195
+ * <p>The list of Automated Reasoning policy ARNs that should be applied as part of this guardrail configuration.</p>
196
+ * @public
197
+ */
198
+ policies: string[] | undefined;
199
+ /**
200
+ * <p>The minimum confidence level required for Automated Reasoning policy violations to trigger guardrail actions. Values range from 0.0 to 1.0.</p>
201
+ * @public
202
+ */
203
+ confidenceThreshold?: number | undefined;
204
+ }
205
+ /**
206
+ * <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>
207
+ * @public
208
+ */
209
+ export interface GuardrailContentFilter {
210
+ /**
211
+ * <p>The harmful category that the content filter is applied to.</p>
212
+ * @public
213
+ */
214
+ type: GuardrailContentFilterType | undefined;
215
+ /**
216
+ * <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>
217
+ * @public
218
+ */
219
+ inputStrength: GuardrailFilterStrength | undefined;
220
+ /**
221
+ * <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>
222
+ * @public
223
+ */
224
+ outputStrength: GuardrailFilterStrength | undefined;
225
+ /**
226
+ * <p>The input modalities selected for the guardrail content filter.</p>
227
+ * @public
228
+ */
229
+ inputModalities?: GuardrailModality[] | undefined;
230
+ /**
231
+ * <p>The output modalities selected for the guardrail content filter.</p>
232
+ * @public
233
+ */
234
+ outputModalities?: GuardrailModality[] | undefined;
235
+ /**
236
+ * <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>
237
+ * @public
238
+ */
239
+ inputAction?: GuardrailContentFilterAction | undefined;
240
+ /**
241
+ * <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>
242
+ * @public
243
+ */
244
+ outputAction?: GuardrailContentFilterAction | undefined;
245
+ /**
246
+ * <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>
247
+ * @public
248
+ */
249
+ inputEnabled?: boolean | undefined;
250
+ /**
251
+ * <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>
252
+ * @public
253
+ */
254
+ outputEnabled?: boolean | undefined;
255
+ }
256
+ /**
257
+ * <p>The tier that your guardrail uses for content filters.</p>
258
+ * @public
259
+ */
260
+ export interface GuardrailContentFiltersTier {
261
+ /**
262
+ * <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>
263
+ * @public
264
+ */
265
+ tierName: GuardrailContentFiltersTierName | undefined;
266
+ }
267
+ /**
268
+ * <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>
269
+ * @public
270
+ */
271
+ export interface GuardrailContentPolicy {
272
+ /**
273
+ * <p>Contains the type of the content filter and how strongly it should apply to prompts and model responses.</p>
274
+ * @public
275
+ */
276
+ filters?: GuardrailContentFilter[] | undefined;
277
+ /**
278
+ * <p>The tier that your guardrail uses for content filters.</p>
279
+ * @public
280
+ */
281
+ tier?: GuardrailContentFiltersTier | undefined;
282
+ }
283
+ /**
284
+ * <p>The details for the guardrails contextual grounding filter.</p>
285
+ * @public
286
+ */
287
+ export interface GuardrailContextualGroundingFilter {
288
+ /**
289
+ * <p>The filter type details for the guardrails contextual grounding filter.</p>
290
+ * @public
291
+ */
292
+ type: GuardrailContextualGroundingFilterType | undefined;
293
+ /**
294
+ * <p>The threshold details for the guardrails contextual grounding filter.</p>
295
+ * @public
296
+ */
297
+ threshold: number | undefined;
298
+ /**
299
+ * <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>
300
+ * @public
301
+ */
302
+ action?: GuardrailContextualGroundingAction | undefined;
303
+ /**
304
+ * <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>
305
+ * @public
306
+ */
307
+ enabled?: boolean | undefined;
308
+ }
309
+ /**
310
+ * <p>The details for the guardrails contextual grounding policy.</p>
311
+ * @public
312
+ */
313
+ export interface GuardrailContextualGroundingPolicy {
314
+ /**
315
+ * <p>The filter details for the guardrails contextual grounding policy.</p>
316
+ * @public
317
+ */
318
+ filters: GuardrailContextualGroundingFilter[] | undefined;
319
+ }
320
+ /**
321
+ * <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>
322
+ * @public
323
+ */
324
+ export interface GuardrailCrossRegionDetails {
325
+ /**
326
+ * <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>
327
+ * @public
328
+ */
329
+ guardrailProfileId?: string | undefined;
330
+ /**
331
+ * <p>The Amazon Resource Name (ARN) of the guardrail profile that you're using with your guardrail.</p>
332
+ * @public
333
+ */
334
+ guardrailProfileArn?: string | undefined;
335
+ }
336
+ /**
337
+ * <p>The PII entity configured for the guardrail.</p>
338
+ * @public
339
+ */
340
+ export interface GuardrailPiiEntity {
341
+ /**
342
+ * <p>The type of PII entity. For example, Social Security Number.</p>
343
+ * @public
344
+ */
345
+ type: GuardrailPiiEntityType | undefined;
346
+ /**
347
+ * <p>The configured guardrail action when PII entity is detected.</p>
348
+ * @public
349
+ */
350
+ action: GuardrailSensitiveInformationAction | undefined;
351
+ /**
352
+ * <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>
353
+ * @public
354
+ */
355
+ inputAction?: GuardrailSensitiveInformationAction | undefined;
356
+ /**
357
+ * <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>
358
+ * @public
359
+ */
360
+ outputAction?: GuardrailSensitiveInformationAction | undefined;
361
+ /**
362
+ * <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>
363
+ * @public
364
+ */
365
+ inputEnabled?: boolean | undefined;
366
+ /**
367
+ * <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>
368
+ * @public
369
+ */
370
+ outputEnabled?: boolean | undefined;
371
+ }
372
+ /**
373
+ * <p>The regular expression configured for the guardrail.</p>
374
+ * @public
375
+ */
376
+ export interface GuardrailRegex {
377
+ /**
378
+ * <p>The name of the regular expression for the guardrail.</p>
379
+ * @public
380
+ */
381
+ name: string | undefined;
382
+ /**
383
+ * <p>The description of the regular expression for the guardrail.</p>
384
+ * @public
385
+ */
386
+ description?: string | undefined;
387
+ /**
388
+ * <p>The pattern of the regular expression configured for the guardrail.</p>
389
+ * @public
390
+ */
391
+ pattern: string | undefined;
392
+ /**
393
+ * <p>The action taken when a match to the regular expression is detected.</p>
394
+ * @public
395
+ */
396
+ action: GuardrailSensitiveInformationAction | undefined;
397
+ /**
398
+ * <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>
399
+ * @public
400
+ */
401
+ inputAction?: GuardrailSensitiveInformationAction | undefined;
402
+ /**
403
+ * <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>
404
+ * @public
405
+ */
406
+ outputAction?: GuardrailSensitiveInformationAction | undefined;
407
+ /**
408
+ * <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>
409
+ * @public
410
+ */
411
+ inputEnabled?: boolean | undefined;
412
+ /**
413
+ * <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>
414
+ * @public
415
+ */
416
+ outputEnabled?: boolean | undefined;
417
+ }
3
418
  /**
4
419
  * <p>Contains details about PII entities and regular expressions configured for the guardrail.</p>
5
420
  * @public
@@ -0,0 +1,7 @@
1
+ import type { Paginator } from "@smithy/types";
2
+ import { ListAdvancedPromptOptimizationJobsCommandInput, ListAdvancedPromptOptimizationJobsCommandOutput } from "../commands/ListAdvancedPromptOptimizationJobsCommand";
3
+ import type { BedrockPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare const paginateListAdvancedPromptOptimizationJobs: (config: BedrockPaginationConfiguration, input: ListAdvancedPromptOptimizationJobsCommandInput, ...rest: any[]) => Paginator<ListAdvancedPromptOptimizationJobsCommandOutput>;
@@ -1,4 +1,5 @@
1
1
  export * from "./Interfaces";
2
+ export * from "./ListAdvancedPromptOptimizationJobsPaginator";
2
3
  export * from "./ListAutomatedReasoningPoliciesPaginator";
3
4
  export * from "./ListAutomatedReasoningPolicyBuildWorkflowsPaginator";
4
5
  export * from "./ListAutomatedReasoningPolicyTestCasesPaginator";
@@ -19,6 +19,9 @@ export declare var ValidationException$: StaticErrorSchema;
19
19
  export declare const errorTypeRegistries: TypeRegistry[];
20
20
  export declare var AccountEnforcedGuardrailInferenceInputConfiguration$: StaticStructureSchema;
21
21
  export declare var AccountEnforcedGuardrailOutputConfiguration$: StaticStructureSchema;
22
+ export declare var AdvancedPromptOptimizationInputConfig$: StaticStructureSchema;
23
+ export declare var AdvancedPromptOptimizationJobSummary$: StaticStructureSchema;
24
+ export declare var AdvancedPromptOptimizationOutputConfig$: StaticStructureSchema;
22
25
  export declare var AgreementAvailability$: StaticStructureSchema;
23
26
  export declare var AutomatedEvaluationConfig$: StaticStructureSchema;
24
27
  export declare var AutomatedEvaluationCustomMetricConfig$: StaticStructureSchema;
@@ -97,6 +100,10 @@ export declare var AutomatedReasoningPolicyUpdateTypeValue$: StaticStructureSche
97
100
  export declare var AutomatedReasoningPolicyUpdateVariableAnnotation$: StaticStructureSchema;
98
101
  export declare var AutomatedReasoningPolicyUpdateVariableMutation$: StaticStructureSchema;
99
102
  export declare var AutomatedReasoningPolicyVariableReport$: StaticStructureSchema;
103
+ export declare var BatchDeleteAdvancedPromptOptimizationJobError$: StaticStructureSchema;
104
+ export declare var BatchDeleteAdvancedPromptOptimizationJobItem$: StaticStructureSchema;
105
+ export declare var BatchDeleteAdvancedPromptOptimizationJobRequest$: StaticStructureSchema;
106
+ export declare var BatchDeleteAdvancedPromptOptimizationJobResponse$: StaticStructureSchema;
100
107
  export declare var BatchDeleteEvaluationJobError$: StaticStructureSchema;
101
108
  export declare var BatchDeleteEvaluationJobItem$: StaticStructureSchema;
102
109
  export declare var BatchDeleteEvaluationJobRequest$: StaticStructureSchema;
@@ -106,6 +113,8 @@ export declare var ByteContentDoc$: StaticStructureSchema;
106
113
  export declare var CancelAutomatedReasoningPolicyBuildWorkflowRequest$: StaticStructureSchema;
107
114
  export declare var CancelAutomatedReasoningPolicyBuildWorkflowResponse$: StaticStructureSchema;
108
115
  export declare var CloudWatchConfig$: StaticStructureSchema;
116
+ export declare var CreateAdvancedPromptOptimizationJobRequest$: StaticStructureSchema;
117
+ export declare var CreateAdvancedPromptOptimizationJobResponse$: StaticStructureSchema;
109
118
  export declare var CreateAutomatedReasoningPolicyRequest$: StaticStructureSchema;
110
119
  export declare var CreateAutomatedReasoningPolicyResponse$: StaticStructureSchema;
111
120
  export declare var CreateAutomatedReasoningPolicyTestCaseRequest$: StaticStructureSchema;
@@ -204,6 +213,8 @@ export declare var FoundationModelDetails$: StaticStructureSchema;
204
213
  export declare var FoundationModelLifecycle$: StaticStructureSchema;
205
214
  export declare var FoundationModelSummary$: StaticStructureSchema;
206
215
  export declare var GenerationConfiguration$: StaticStructureSchema;
216
+ export declare var GetAdvancedPromptOptimizationJobRequest$: StaticStructureSchema;
217
+ export declare var GetAdvancedPromptOptimizationJobResponse$: StaticStructureSchema;
207
218
  export declare var GetAutomatedReasoningPolicyAnnotationsRequest$: StaticStructureSchema;
208
219
  export declare var GetAutomatedReasoningPolicyAnnotationsResponse$: StaticStructureSchema;
209
220
  export declare var GetAutomatedReasoningPolicyBuildWorkflowRequest$: StaticStructureSchema;
@@ -293,6 +304,7 @@ export declare var HumanEvaluationCustomMetric$: StaticStructureSchema;
293
304
  export declare var HumanWorkflowConfig$: StaticStructureSchema;
294
305
  export declare var ImplicitFilterConfiguration$: StaticStructureSchema;
295
306
  export declare var ImportedModelSummary$: StaticStructureSchema;
307
+ export declare var InferenceConfiguration$: StaticStructureSchema;
296
308
  export declare var InferenceProfileModel$: StaticStructureSchema;
297
309
  export declare var InferenceProfileSummary$: StaticStructureSchema;
298
310
  export declare var InvocationLogsConfig$: StaticStructureSchema;
@@ -302,6 +314,8 @@ export declare var KnowledgeBaseRetrieveAndGenerateConfiguration$: StaticStructu
302
314
  export declare var KnowledgeBaseVectorSearchConfiguration$: StaticStructureSchema;
303
315
  export declare var LambdaGraderConfig$: StaticStructureSchema;
304
316
  export declare var LegalTerm$: StaticStructureSchema;
317
+ export declare var ListAdvancedPromptOptimizationJobsRequest$: StaticStructureSchema;
318
+ export declare var ListAdvancedPromptOptimizationJobsResponse$: StaticStructureSchema;
305
319
  export declare var ListAutomatedReasoningPoliciesRequest$: StaticStructureSchema;
306
320
  export declare var ListAutomatedReasoningPoliciesResponse$: StaticStructureSchema;
307
321
  export declare var ListAutomatedReasoningPolicyBuildWorkflowsRequest$: StaticStructureSchema;
@@ -349,6 +363,7 @@ export declare var MarketplaceModelEndpoint$: StaticStructureSchema;
349
363
  export declare var MarketplaceModelEndpointSummary$: StaticStructureSchema;
350
364
  export declare var MetadataAttributeSchema$: StaticStructureSchema;
351
365
  export declare var MetadataConfigurationForReranking$: StaticStructureSchema;
366
+ export declare var ModelConfiguration$: StaticStructureSchema;
352
367
  export declare var ModelCopyJobSummary$: StaticStructureSchema;
353
368
  export declare var ModelCustomizationJobSummary$: StaticStructureSchema;
354
369
  export declare var ModelEnforcement$: StaticStructureSchema;
@@ -393,6 +408,8 @@ export declare var StartAutomatedReasoningPolicyBuildWorkflowResponse$: StaticSt
393
408
  export declare var StartAutomatedReasoningPolicyTestWorkflowRequest$: StaticStructureSchema;
394
409
  export declare var StartAutomatedReasoningPolicyTestWorkflowResponse$: StaticStructureSchema;
395
410
  export declare var StatusDetails$: StaticStructureSchema;
411
+ export declare var StopAdvancedPromptOptimizationJobRequest$: StaticStructureSchema;
412
+ export declare var StopAdvancedPromptOptimizationJobResponse$: StaticStructureSchema;
396
413
  export declare var StopEvaluationJobRequest$: StaticStructureSchema;
397
414
  export declare var StopEvaluationJobResponse$: StaticStructureSchema;
398
415
  export declare var StopModelCustomizationJobRequest$: StaticStructureSchema;
@@ -465,8 +482,10 @@ export declare var RatingScaleItemValue$: StaticUnionSchema;
465
482
  export declare var RequestMetadataFilters$: StaticUnionSchema;
466
483
  export declare var RerankingMetadataSelectiveModeConfiguration$: StaticUnionSchema;
467
484
  export declare var RetrievalFilter$: StaticUnionSchema;
485
+ export declare var BatchDeleteAdvancedPromptOptimizationJob$: StaticOperationSchema;
468
486
  export declare var BatchDeleteEvaluationJob$: StaticOperationSchema;
469
487
  export declare var CancelAutomatedReasoningPolicyBuildWorkflow$: StaticOperationSchema;
488
+ export declare var CreateAdvancedPromptOptimizationJob$: StaticOperationSchema;
470
489
  export declare var CreateAutomatedReasoningPolicy$: StaticOperationSchema;
471
490
  export declare var CreateAutomatedReasoningPolicyTestCase$: StaticOperationSchema;
472
491
  export declare var CreateAutomatedReasoningPolicyVersion$: StaticOperationSchema;
@@ -501,6 +520,7 @@ export declare var DeleteProvisionedModelThroughput$: StaticOperationSchema;
501
520
  export declare var DeleteResourcePolicy$: StaticOperationSchema;
502
521
  export declare var DeregisterMarketplaceModelEndpoint$: StaticOperationSchema;
503
522
  export declare var ExportAutomatedReasoningPolicyVersion$: StaticOperationSchema;
523
+ export declare var GetAdvancedPromptOptimizationJob$: StaticOperationSchema;
504
524
  export declare var GetAutomatedReasoningPolicy$: StaticOperationSchema;
505
525
  export declare var GetAutomatedReasoningPolicyAnnotations$: StaticOperationSchema;
506
526
  export declare var GetAutomatedReasoningPolicyBuildWorkflow$: StaticOperationSchema;
@@ -526,6 +546,7 @@ export declare var GetPromptRouter$: StaticOperationSchema;
526
546
  export declare var GetProvisionedModelThroughput$: StaticOperationSchema;
527
547
  export declare var GetResourcePolicy$: StaticOperationSchema;
528
548
  export declare var GetUseCaseForModelAccess$: StaticOperationSchema;
549
+ export declare var ListAdvancedPromptOptimizationJobs$: StaticOperationSchema;
529
550
  export declare var ListAutomatedReasoningPolicies$: StaticOperationSchema;
530
551
  export declare var ListAutomatedReasoningPolicyBuildWorkflows$: StaticOperationSchema;
531
552
  export declare var ListAutomatedReasoningPolicyTestCases$: StaticOperationSchema;
@@ -554,6 +575,7 @@ export declare var PutUseCaseForModelAccess$: StaticOperationSchema;
554
575
  export declare var RegisterMarketplaceModelEndpoint$: StaticOperationSchema;
555
576
  export declare var StartAutomatedReasoningPolicyBuildWorkflow$: StaticOperationSchema;
556
577
  export declare var StartAutomatedReasoningPolicyTestWorkflow$: StaticOperationSchema;
578
+ export declare var StopAdvancedPromptOptimizationJob$: StaticOperationSchema;
557
579
  export declare var StopEvaluationJob$: StaticOperationSchema;
558
580
  export declare var StopModelCustomizationJob$: StaticOperationSchema;
559
581
  export declare var StopModelInvocationJob$: StaticOperationSchema;