@aws-sdk/client-bedrock-agent-runtime 3.576.0 → 3.580.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.
@@ -915,6 +915,388 @@ export interface FailureTrace {
915
915
  */
916
916
  failureReason?: string;
917
917
  }
918
+ /**
919
+ * @public
920
+ * @enum
921
+ */
922
+ export declare const GuardrailAction: {
923
+ readonly INTERVENED: "INTERVENED";
924
+ readonly NONE: "NONE";
925
+ };
926
+ /**
927
+ * @public
928
+ */
929
+ export type GuardrailAction = (typeof GuardrailAction)[keyof typeof GuardrailAction];
930
+ /**
931
+ * @public
932
+ * @enum
933
+ */
934
+ export declare const GuardrailContentPolicyAction: {
935
+ readonly BLOCKED: "BLOCKED";
936
+ };
937
+ /**
938
+ * @public
939
+ */
940
+ export type GuardrailContentPolicyAction = (typeof GuardrailContentPolicyAction)[keyof typeof GuardrailContentPolicyAction];
941
+ /**
942
+ * @public
943
+ * @enum
944
+ */
945
+ export declare const GuardrailContentFilterConfidence: {
946
+ readonly HIGH: "HIGH";
947
+ readonly LOW: "LOW";
948
+ readonly MEDIUM: "MEDIUM";
949
+ readonly NONE: "NONE";
950
+ };
951
+ /**
952
+ * @public
953
+ */
954
+ export type GuardrailContentFilterConfidence = (typeof GuardrailContentFilterConfidence)[keyof typeof GuardrailContentFilterConfidence];
955
+ /**
956
+ * @public
957
+ * @enum
958
+ */
959
+ export declare const GuardrailContentFilterType: {
960
+ readonly HATE: "HATE";
961
+ readonly INSULTS: "INSULTS";
962
+ readonly MISCONDUCT: "MISCONDUCT";
963
+ readonly PROMPT_ATTACK: "PROMPT_ATTACK";
964
+ readonly SEXUAL: "SEXUAL";
965
+ readonly VIOLENCE: "VIOLENCE";
966
+ };
967
+ /**
968
+ * @public
969
+ */
970
+ export type GuardrailContentFilterType = (typeof GuardrailContentFilterType)[keyof typeof GuardrailContentFilterType];
971
+ /**
972
+ * <p>Details of the content filter used in the Guardrail.</p>
973
+ * @public
974
+ */
975
+ export interface GuardrailContentFilter {
976
+ /**
977
+ * <p>The type of content detected in the filter by the Guardrail.</p>
978
+ * @public
979
+ */
980
+ type?: GuardrailContentFilterType;
981
+ /**
982
+ * <p>The confidence level regarding the content detected in the filter by the Guardrail.</p>
983
+ * @public
984
+ */
985
+ confidence?: GuardrailContentFilterConfidence;
986
+ /**
987
+ * <p>The action placed on the content by the Guardrail filter.</p>
988
+ * @public
989
+ */
990
+ action?: GuardrailContentPolicyAction;
991
+ }
992
+ /**
993
+ * <p>The details of the policy assessment in the Guardrails filter.</p>
994
+ * @public
995
+ */
996
+ export interface GuardrailContentPolicyAssessment {
997
+ /**
998
+ * <p>The filter details of the policy assessment used in the Guardrails filter.</p>
999
+ * @public
1000
+ */
1001
+ filters?: GuardrailContentFilter[];
1002
+ }
1003
+ /**
1004
+ * @public
1005
+ * @enum
1006
+ */
1007
+ export declare const GuardrailSensitiveInformationPolicyAction: {
1008
+ readonly ANONYMIZED: "ANONYMIZED";
1009
+ readonly BLOCKED: "BLOCKED";
1010
+ };
1011
+ /**
1012
+ * @public
1013
+ */
1014
+ export type GuardrailSensitiveInformationPolicyAction = (typeof GuardrailSensitiveInformationPolicyAction)[keyof typeof GuardrailSensitiveInformationPolicyAction];
1015
+ /**
1016
+ * @public
1017
+ * @enum
1018
+ */
1019
+ export declare const GuardrailPiiEntityType: {
1020
+ readonly ADDRESS: "ADDRESS";
1021
+ readonly AGE: "AGE";
1022
+ readonly AWS_ACCESS_KEY: "AWS_ACCESS_KEY";
1023
+ readonly AWS_SECRET_KEY: "AWS_SECRET_KEY";
1024
+ readonly CA_HEALTH_NUMBER: "CA_HEALTH_NUMBER";
1025
+ readonly CA_SOCIAL_INSURANCE_NUMBER: "CA_SOCIAL_INSURANCE_NUMBER";
1026
+ readonly CREDIT_DEBIT_CARD_CVV: "CREDIT_DEBIT_CARD_CVV";
1027
+ readonly CREDIT_DEBIT_CARD_EXPIRY: "CREDIT_DEBIT_CARD_EXPIRY";
1028
+ readonly CREDIT_DEBIT_CARD_NUMBER: "CREDIT_DEBIT_CARD_NUMBER";
1029
+ readonly DRIVER_ID: "DRIVER_ID";
1030
+ readonly EMAIL: "EMAIL";
1031
+ readonly INTERNATIONAL_BANK_ACCOUNT_NUMBER: "INTERNATIONAL_BANK_ACCOUNT_NUMBER";
1032
+ readonly IP_ADDRESS: "IP_ADDRESS";
1033
+ readonly LICENSE_PLATE: "LICENSE_PLATE";
1034
+ readonly MAC_ADDRESS: "MAC_ADDRESS";
1035
+ readonly NAME: "NAME";
1036
+ readonly PASSWORD: "PASSWORD";
1037
+ readonly PHONE: "PHONE";
1038
+ readonly PIN: "PIN";
1039
+ readonly SWIFT_CODE: "SWIFT_CODE";
1040
+ readonly UK_NATIONAL_HEALTH_SERVICE_NUMBER: "UK_NATIONAL_HEALTH_SERVICE_NUMBER";
1041
+ readonly UK_NATIONAL_INSURANCE_NUMBER: "UK_NATIONAL_INSURANCE_NUMBER";
1042
+ readonly UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER: "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER";
1043
+ readonly URL: "URL";
1044
+ readonly USERNAME: "USERNAME";
1045
+ readonly US_BANK_ACCOUNT_NUMBER: "US_BANK_ACCOUNT_NUMBER";
1046
+ readonly US_BANK_ROUTING_NUMBER: "US_BANK_ROUTING_NUMBER";
1047
+ readonly US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER: "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER";
1048
+ readonly US_PASSPORT_NUMBER: "US_PASSPORT_NUMBER";
1049
+ readonly US_SOCIAL_SECURITY_NUMBER: "US_SOCIAL_SECURITY_NUMBER";
1050
+ readonly VEHICLE_IDENTIFICATION_NUMBER: "VEHICLE_IDENTIFICATION_NUMBER";
1051
+ };
1052
+ /**
1053
+ * @public
1054
+ */
1055
+ export type GuardrailPiiEntityType = (typeof GuardrailPiiEntityType)[keyof typeof GuardrailPiiEntityType];
1056
+ /**
1057
+ * <p>The Guardrail filter to identify and remove personally identifiable information (PII).</p>
1058
+ * @public
1059
+ */
1060
+ export interface GuardrailPiiEntityFilter {
1061
+ /**
1062
+ * <p>The type of PII the Guardrail filter has identified and removed.</p>
1063
+ * @public
1064
+ */
1065
+ type?: GuardrailPiiEntityType;
1066
+ /**
1067
+ * <p>The match to settings in the Guardrail filter to identify and remove PII.</p>
1068
+ * @public
1069
+ */
1070
+ match?: string;
1071
+ /**
1072
+ * <p>The action of the Guardrail filter to identify and remove PII.</p>
1073
+ * @public
1074
+ */
1075
+ action?: GuardrailSensitiveInformationPolicyAction;
1076
+ }
1077
+ /**
1078
+ * <p>The details for the regex filter used in the Guardrail.</p>
1079
+ * @public
1080
+ */
1081
+ export interface GuardrailRegexFilter {
1082
+ /**
1083
+ * <p>The name details for the regex filter used in the Guardrail.</p>
1084
+ * @public
1085
+ */
1086
+ name?: string;
1087
+ /**
1088
+ * <p>The regex details for the regex filter used in the Guardrail.</p>
1089
+ * @public
1090
+ */
1091
+ regex?: string;
1092
+ /**
1093
+ * <p>The match details for the regex filter used in the Guardrail.</p>
1094
+ * @public
1095
+ */
1096
+ match?: string;
1097
+ /**
1098
+ * <p>The action details for the regex filter used in the Guardrail.</p>
1099
+ * @public
1100
+ */
1101
+ action?: GuardrailSensitiveInformationPolicyAction;
1102
+ }
1103
+ /**
1104
+ * <p>The details of the sensitive policy assessment used in the Guardrail.</p>
1105
+ * @public
1106
+ */
1107
+ export interface GuardrailSensitiveInformationPolicyAssessment {
1108
+ /**
1109
+ * <p>The details of the PII entities used in the sensitive policy assessment for the Guardrail.</p>
1110
+ * @public
1111
+ */
1112
+ piiEntities?: GuardrailPiiEntityFilter[];
1113
+ /**
1114
+ * <p>The details of the regexes used in the sensitive policy assessment for the Guardrail.</p>
1115
+ * @public
1116
+ */
1117
+ regexes?: GuardrailRegexFilter[];
1118
+ }
1119
+ /**
1120
+ * @public
1121
+ * @enum
1122
+ */
1123
+ export declare const GuardrailTopicPolicyAction: {
1124
+ readonly BLOCKED: "BLOCKED";
1125
+ };
1126
+ /**
1127
+ * @public
1128
+ */
1129
+ export type GuardrailTopicPolicyAction = (typeof GuardrailTopicPolicyAction)[keyof typeof GuardrailTopicPolicyAction];
1130
+ /**
1131
+ * @public
1132
+ * @enum
1133
+ */
1134
+ export declare const GuardrailTopicType: {
1135
+ readonly DENY: "DENY";
1136
+ };
1137
+ /**
1138
+ * @public
1139
+ */
1140
+ export type GuardrailTopicType = (typeof GuardrailTopicType)[keyof typeof GuardrailTopicType];
1141
+ /**
1142
+ * <p>The details for a specific topic defined in the Guardrail.</p>
1143
+ * @public
1144
+ */
1145
+ export interface GuardrailTopic {
1146
+ /**
1147
+ * <p>The name details on a specific topic in the Guardrail.</p>
1148
+ * @public
1149
+ */
1150
+ name?: string;
1151
+ /**
1152
+ * <p>The type details on a specific topic in the Guardrail.</p>
1153
+ * @public
1154
+ */
1155
+ type?: GuardrailTopicType;
1156
+ /**
1157
+ * <p>The action details on a specific topic in the Guardrail.</p>
1158
+ * @public
1159
+ */
1160
+ action?: GuardrailTopicPolicyAction;
1161
+ }
1162
+ /**
1163
+ * <p>The details of the policy assessment used in the Guardrail.</p>
1164
+ * @public
1165
+ */
1166
+ export interface GuardrailTopicPolicyAssessment {
1167
+ /**
1168
+ * <p>The topic details of the policy assessment used in the Guardrail.</p>
1169
+ * @public
1170
+ */
1171
+ topics?: GuardrailTopic[];
1172
+ }
1173
+ /**
1174
+ * @public
1175
+ * @enum
1176
+ */
1177
+ export declare const GuardrailWordPolicyAction: {
1178
+ readonly BLOCKED: "BLOCKED";
1179
+ };
1180
+ /**
1181
+ * @public
1182
+ */
1183
+ export type GuardrailWordPolicyAction = (typeof GuardrailWordPolicyAction)[keyof typeof GuardrailWordPolicyAction];
1184
+ /**
1185
+ * <p>The custom word details for the filter in the Guardrail.</p>
1186
+ * @public
1187
+ */
1188
+ export interface GuardrailCustomWord {
1189
+ /**
1190
+ * <p>The match details for the custom word filter in the Guardrail.</p>
1191
+ * @public
1192
+ */
1193
+ match?: string;
1194
+ /**
1195
+ * <p>The action details for the custom word filter in the Guardrail.</p>
1196
+ * @public
1197
+ */
1198
+ action?: GuardrailWordPolicyAction;
1199
+ }
1200
+ /**
1201
+ * @public
1202
+ * @enum
1203
+ */
1204
+ export declare const GuardrailManagedWordType: {
1205
+ readonly PROFANITY: "PROFANITY";
1206
+ };
1207
+ /**
1208
+ * @public
1209
+ */
1210
+ export type GuardrailManagedWordType = (typeof GuardrailManagedWordType)[keyof typeof GuardrailManagedWordType];
1211
+ /**
1212
+ * <p>The managed word details for the filter in the Guardrail.</p>
1213
+ * @public
1214
+ */
1215
+ export interface GuardrailManagedWord {
1216
+ /**
1217
+ * <p>The match details for the managed word filter in the Guardrail.</p>
1218
+ * @public
1219
+ */
1220
+ match?: string;
1221
+ /**
1222
+ * <p>The type details for the managed word filter in the Guardrail.</p>
1223
+ * @public
1224
+ */
1225
+ type?: GuardrailManagedWordType;
1226
+ /**
1227
+ * <p>The action details for the managed word filter in the Guardrail.</p>
1228
+ * @public
1229
+ */
1230
+ action?: GuardrailWordPolicyAction;
1231
+ }
1232
+ /**
1233
+ * <p>The assessment details for words defined in the Guardrail filter.</p>
1234
+ * @public
1235
+ */
1236
+ export interface GuardrailWordPolicyAssessment {
1237
+ /**
1238
+ * <p>The custom word details for words defined in the Guardrail filter.</p>
1239
+ * @public
1240
+ */
1241
+ customWords?: GuardrailCustomWord[];
1242
+ /**
1243
+ * <p>The managed word lists for words defined in the Guardrail filter.</p>
1244
+ * @public
1245
+ */
1246
+ managedWordLists?: GuardrailManagedWord[];
1247
+ }
1248
+ /**
1249
+ * <p>Assessment details of the content analyzed by Guardrails.</p>
1250
+ * @public
1251
+ */
1252
+ export interface GuardrailAssessment {
1253
+ /**
1254
+ * <p>Topic policy details of the Guardrail.</p>
1255
+ * @public
1256
+ */
1257
+ topicPolicy?: GuardrailTopicPolicyAssessment;
1258
+ /**
1259
+ * <p>Content policy details of the Guardrail.</p>
1260
+ * @public
1261
+ */
1262
+ contentPolicy?: GuardrailContentPolicyAssessment;
1263
+ /**
1264
+ * <p>Word policy details of the Guardrail.</p>
1265
+ * @public
1266
+ */
1267
+ wordPolicy?: GuardrailWordPolicyAssessment;
1268
+ /**
1269
+ * <p>Sensitive Information policy details of Guardrail.</p>
1270
+ * @public
1271
+ */
1272
+ sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment;
1273
+ }
1274
+ /**
1275
+ * <p>The trace details used in the Guardrail.</p>
1276
+ * @public
1277
+ */
1278
+ export interface GuardrailTrace {
1279
+ /**
1280
+ * <p>The trace action details used with the Guardrail.</p>
1281
+ * @public
1282
+ */
1283
+ action?: GuardrailAction;
1284
+ /**
1285
+ * <p>The details of the trace Id used in the Guardrail Trace.</p>
1286
+ * @public
1287
+ */
1288
+ traceId?: string;
1289
+ /**
1290
+ * <p>The details of the input assessments used in the Guardrail Trace.</p>
1291
+ * @public
1292
+ */
1293
+ inputAssessments?: GuardrailAssessment[];
1294
+ /**
1295
+ * <p>The details of the output assessments used in the Guardrail Trace.</p>
1296
+ * @public
1297
+ */
1298
+ outputAssessments?: GuardrailAssessment[];
1299
+ }
918
1300
  /**
919
1301
  * @public
920
1302
  * @enum
@@ -1471,16 +1853,29 @@ export declare namespace PreProcessingTrace {
1471
1853
  * <p>Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement">Trace enablement</a>.</p>
1472
1854
  * @public
1473
1855
  */
1474
- export type Trace = Trace.FailureTraceMember | Trace.OrchestrationTraceMember | Trace.PostProcessingTraceMember | Trace.PreProcessingTraceMember | Trace.$UnknownMember;
1856
+ export type Trace = Trace.FailureTraceMember | Trace.GuardrailTraceMember | Trace.OrchestrationTraceMember | Trace.PostProcessingTraceMember | Trace.PreProcessingTraceMember | Trace.$UnknownMember;
1475
1857
  /**
1476
1858
  * @public
1477
1859
  */
1478
1860
  export declare namespace Trace {
1861
+ /**
1862
+ * <p>The trace details for a trace defined in the Guardrail filter.</p>
1863
+ * @public
1864
+ */
1865
+ interface GuardrailTraceMember {
1866
+ guardrailTrace: GuardrailTrace;
1867
+ preProcessingTrace?: never;
1868
+ orchestrationTrace?: never;
1869
+ postProcessingTrace?: never;
1870
+ failureTrace?: never;
1871
+ $unknown?: never;
1872
+ }
1479
1873
  /**
1480
1874
  * <p>Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.</p>
1481
1875
  * @public
1482
1876
  */
1483
1877
  interface PreProcessingTraceMember {
1878
+ guardrailTrace?: never;
1484
1879
  preProcessingTrace: PreProcessingTrace;
1485
1880
  orchestrationTrace?: never;
1486
1881
  postProcessingTrace?: never;
@@ -1492,6 +1887,7 @@ export declare namespace Trace {
1492
1887
  * @public
1493
1888
  */
1494
1889
  interface OrchestrationTraceMember {
1890
+ guardrailTrace?: never;
1495
1891
  preProcessingTrace?: never;
1496
1892
  orchestrationTrace: OrchestrationTrace;
1497
1893
  postProcessingTrace?: never;
@@ -1503,6 +1899,7 @@ export declare namespace Trace {
1503
1899
  * @public
1504
1900
  */
1505
1901
  interface PostProcessingTraceMember {
1902
+ guardrailTrace?: never;
1506
1903
  preProcessingTrace?: never;
1507
1904
  orchestrationTrace?: never;
1508
1905
  postProcessingTrace: PostProcessingTrace;
@@ -1514,6 +1911,7 @@ export declare namespace Trace {
1514
1911
  * @public
1515
1912
  */
1516
1913
  interface FailureTraceMember {
1914
+ guardrailTrace?: never;
1517
1915
  preProcessingTrace?: never;
1518
1916
  orchestrationTrace?: never;
1519
1917
  postProcessingTrace?: never;
@@ -1524,6 +1922,7 @@ export declare namespace Trace {
1524
1922
  * @public
1525
1923
  */
1526
1924
  interface $UnknownMember {
1925
+ guardrailTrace?: never;
1527
1926
  preProcessingTrace?: never;
1528
1927
  orchestrationTrace?: never;
1529
1928
  postProcessingTrace?: never;
@@ -1531,6 +1930,7 @@ export declare namespace Trace {
1531
1930
  $unknown: [string, any];
1532
1931
  }
1533
1932
  interface Visitor<T> {
1933
+ guardrailTrace: (value: GuardrailTrace) => T;
1534
1934
  preProcessingTrace: (value: PreProcessingTrace) => T;
1535
1935
  orchestrationTrace: (value: OrchestrationTrace) => T;
1536
1936
  postProcessingTrace: (value: PostProcessingTrace) => T;
@@ -2323,7 +2723,7 @@ export interface RetrieveResponse {
2323
2723
  nextToken?: string;
2324
2724
  }
2325
2725
  /**
2326
- * <p>Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
2726
+ * <p>Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>. See the examples below to see how to use these filters.</p>
2327
2727
  * <p>This data type is used in the following API operations:</p>
2328
2728
  * <ul>
2329
2729
  * <li>
@@ -2337,13 +2737,17 @@ export interface RetrieveResponse {
2337
2737
  * </ul>
2338
2738
  * @public
2339
2739
  */
2340
- export type RetrievalFilter = RetrievalFilter.AndAllMember | RetrievalFilter.EqualsMember | RetrievalFilter.GreaterThanMember | RetrievalFilter.GreaterThanOrEqualsMember | RetrievalFilter.InMember | RetrievalFilter.LessThanMember | RetrievalFilter.LessThanOrEqualsMember | RetrievalFilter.NotEqualsMember | RetrievalFilter.NotInMember | RetrievalFilter.OrAllMember | RetrievalFilter.StartsWithMember | RetrievalFilter.$UnknownMember;
2740
+ export type RetrievalFilter = RetrievalFilter.AndAllMember | RetrievalFilter.EqualsMember | RetrievalFilter.GreaterThanMember | RetrievalFilter.GreaterThanOrEqualsMember | RetrievalFilter.InMember | RetrievalFilter.LessThanMember | RetrievalFilter.LessThanOrEqualsMember | RetrievalFilter.ListContainsMember | RetrievalFilter.NotEqualsMember | RetrievalFilter.NotInMember | RetrievalFilter.OrAllMember | RetrievalFilter.StartsWithMember | RetrievalFilter.StringContainsMember | RetrievalFilter.$UnknownMember;
2341
2741
  /**
2342
2742
  * @public
2343
2743
  */
2344
2744
  export declare namespace RetrievalFilter {
2345
2745
  /**
2346
- * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value matches the <code>value</code> in this object are returned.</p>
2746
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value matches the <code>value</code> in this object.</p>
2747
+ * <p>The following example would return data sources with an <code>animal</code> attribute whose value is <code>cat</code>:</p>
2748
+ * <p>
2749
+ * <code>"equals": \{ "key": "animal", "value": "cat" \}</code>
2750
+ * </p>
2347
2751
  * @public
2348
2752
  */
2349
2753
  interface EqualsMember {
@@ -2356,12 +2760,18 @@ export declare namespace RetrievalFilter {
2356
2760
  in?: never;
2357
2761
  notIn?: never;
2358
2762
  startsWith?: never;
2763
+ listContains?: never;
2764
+ stringContains?: never;
2359
2765
  andAll?: never;
2360
2766
  orAll?: never;
2361
2767
  $unknown?: never;
2362
2768
  }
2363
2769
  /**
2364
2770
  * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value doesn't match the <code>value</code> in this object are returned.</p>
2771
+ * <p>The following example would return data sources that don't contain an <code>animal</code> attribute whose value is <code>cat</code>.</p>
2772
+ * <p>
2773
+ * <code>"notEquals": \{ "key": "animal", "value": "cat" \}</code>
2774
+ * </p>
2365
2775
  * @public
2366
2776
  */
2367
2777
  interface NotEqualsMember {
@@ -2374,12 +2784,18 @@ export declare namespace RetrievalFilter {
2374
2784
  in?: never;
2375
2785
  notIn?: never;
2376
2786
  startsWith?: never;
2787
+ listContains?: never;
2788
+ stringContains?: never;
2377
2789
  andAll?: never;
2378
2790
  orAll?: never;
2379
2791
  $unknown?: never;
2380
2792
  }
2381
2793
  /**
2382
- * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than the <code>value</code> in this object are returned.</p>
2794
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than the <code>value</code> in this object.</p>
2795
+ * <p>The following example would return data sources with an <code>year</code> attribute whose value is greater than <code>1989</code>:</p>
2796
+ * <p>
2797
+ * <code>"greaterThan": \{ "key": "year", "value": 1989 \}</code>
2798
+ * </p>
2383
2799
  * @public
2384
2800
  */
2385
2801
  interface GreaterThanMember {
@@ -2392,12 +2808,18 @@ export declare namespace RetrievalFilter {
2392
2808
  in?: never;
2393
2809
  notIn?: never;
2394
2810
  startsWith?: never;
2811
+ listContains?: never;
2812
+ stringContains?: never;
2395
2813
  andAll?: never;
2396
2814
  orAll?: never;
2397
2815
  $unknown?: never;
2398
2816
  }
2399
2817
  /**
2400
- * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than or equal to the <code>value</code> in this object are returned.</p>
2818
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than or equal to the <code>value</code> in this object.</p>
2819
+ * <p>The following example would return data sources with an <code>year</code> attribute whose value is greater than or equal to <code>1989</code>:</p>
2820
+ * <p>
2821
+ * <code>"greaterThanOrEquals": \{ "key": "year", "value": 1989 \}</code>
2822
+ * </p>
2401
2823
  * @public
2402
2824
  */
2403
2825
  interface GreaterThanOrEqualsMember {
@@ -2410,12 +2832,18 @@ export declare namespace RetrievalFilter {
2410
2832
  in?: never;
2411
2833
  notIn?: never;
2412
2834
  startsWith?: never;
2835
+ listContains?: never;
2836
+ stringContains?: never;
2413
2837
  andAll?: never;
2414
2838
  orAll?: never;
2415
2839
  $unknown?: never;
2416
2840
  }
2417
2841
  /**
2418
- * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is less than the <code>value</code> in this object are returned.</p>
2842
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is less than the <code>value</code> in this object.</p>
2843
+ * <p>The following example would return data sources with an <code>year</code> attribute whose value is less than to <code>1989</code>.</p>
2844
+ * <p>
2845
+ * <code>"lessThan": \{ "key": "year", "value": 1989 \}</code>
2846
+ * </p>
2419
2847
  * @public
2420
2848
  */
2421
2849
  interface LessThanMember {
@@ -2428,12 +2856,18 @@ export declare namespace RetrievalFilter {
2428
2856
  in?: never;
2429
2857
  notIn?: never;
2430
2858
  startsWith?: never;
2859
+ listContains?: never;
2860
+ stringContains?: never;
2431
2861
  andAll?: never;
2432
2862
  orAll?: never;
2433
2863
  $unknown?: never;
2434
2864
  }
2435
2865
  /**
2436
- * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is less than or equal to the <code>value</code> in this object are returned.</p>
2866
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is less than or equal to the <code>value</code> in this object.</p>
2867
+ * <p>The following example would return data sources with an <code>year</code> attribute whose value is less than or equal to <code>1989</code>.</p>
2868
+ * <p>
2869
+ * <code>"lessThanOrEquals": \{ "key": "year", "value": 1989 \}</code>
2870
+ * </p>
2437
2871
  * @public
2438
2872
  */
2439
2873
  interface LessThanOrEqualsMember {
@@ -2446,12 +2880,18 @@ export declare namespace RetrievalFilter {
2446
2880
  in?: never;
2447
2881
  notIn?: never;
2448
2882
  startsWith?: never;
2883
+ listContains?: never;
2884
+ stringContains?: never;
2449
2885
  andAll?: never;
2450
2886
  orAll?: never;
2451
2887
  $unknown?: never;
2452
2888
  }
2453
2889
  /**
2454
- * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value is in the list specified in the <code>value</code> in this object are returned.</p>
2890
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is in the list specified in the <code>value</code> in this object.</p>
2891
+ * <p>The following example would return data sources with an <code>animal</code> attribute that is either <code>cat</code> or <code>dog</code>:</p>
2892
+ * <p>
2893
+ * <code>"in": \{ "key": "animal", "value": ["cat", "dog"] \}</code>
2894
+ * </p>
2455
2895
  * @public
2456
2896
  */
2457
2897
  interface InMember {
@@ -2464,12 +2904,18 @@ export declare namespace RetrievalFilter {
2464
2904
  in: FilterAttribute;
2465
2905
  notIn?: never;
2466
2906
  startsWith?: never;
2907
+ listContains?: never;
2908
+ stringContains?: never;
2467
2909
  andAll?: never;
2468
2910
  orAll?: never;
2469
2911
  $unknown?: never;
2470
2912
  }
2471
2913
  /**
2472
- * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value isn't in the list specified in the <code>value</code> in this object are returned.</p>
2914
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value isn't in the list specified in the <code>value</code> in this object.</p>
2915
+ * <p>The following example would return data sources whose <code>animal</code> attribute is neither <code>cat</code> nor <code>dog</code>.</p>
2916
+ * <p>
2917
+ * <code>"notIn": \{ "key": "animal", "value": ["cat", "dog"] \}</code>
2918
+ * </p>
2473
2919
  * @public
2474
2920
  */
2475
2921
  interface NotInMember {
@@ -2482,12 +2928,18 @@ export declare namespace RetrievalFilter {
2482
2928
  in?: never;
2483
2929
  notIn: FilterAttribute;
2484
2930
  startsWith?: never;
2931
+ listContains?: never;
2932
+ stringContains?: never;
2485
2933
  andAll?: never;
2486
2934
  orAll?: never;
2487
2935
  $unknown?: never;
2488
2936
  }
2489
2937
  /**
2490
- * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value starts with the <code>value</code> in this object are returned. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.</p>
2938
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value starts with the <code>value</code> in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.</p>
2939
+ * <p>The following example would return data sources with an <code>animal</code> attribute starts with <code>ca</code> (for example, <code>cat</code> or <code>camel</code>).</p>
2940
+ * <p>
2941
+ * <code>"startsWith": \{ "key": "animal", "value": "ca" \}</code>
2942
+ * </p>
2491
2943
  * @public
2492
2944
  */
2493
2945
  interface StartsWithMember {
@@ -2500,12 +2952,72 @@ export declare namespace RetrievalFilter {
2500
2952
  in?: never;
2501
2953
  notIn?: never;
2502
2954
  startsWith: FilterAttribute;
2955
+ listContains?: never;
2956
+ stringContains?: never;
2957
+ andAll?: never;
2958
+ orAll?: never;
2959
+ $unknown?: never;
2960
+ }
2961
+ /**
2962
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is a list that contains the <code>value</code> as one of its members.</p>
2963
+ * <p>The following example would return data sources with an <code>animals</code> attribute that is a list containing a <code>cat</code> member (for example <code>["dog", "cat"]</code>).</p>
2964
+ * <p>
2965
+ * <code>"listContains": \{ "key": "animals", "value": "cat" \}</code>
2966
+ * </p>
2967
+ * @public
2968
+ */
2969
+ interface ListContainsMember {
2970
+ equals?: never;
2971
+ notEquals?: never;
2972
+ greaterThan?: never;
2973
+ greaterThanOrEquals?: never;
2974
+ lessThan?: never;
2975
+ lessThanOrEquals?: never;
2976
+ in?: never;
2977
+ notIn?: never;
2978
+ startsWith?: never;
2979
+ listContains: FilterAttribute;
2980
+ stringContains?: never;
2503
2981
  andAll?: never;
2504
2982
  orAll?: never;
2505
2983
  $unknown?: never;
2506
2984
  }
2507
2985
  /**
2508
- * <p>Knowledge base data sources whose metadata attributes fulfill all the filter conditions inside this list are returned.</p>
2986
+ * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is one of the following:</p>
2987
+ * <ul>
2988
+ * <li>
2989
+ * <p>A string that contains the <code>value</code> as a substring. The following example would return data sources with an <code>animal</code> attribute that contains the substring <code>at</code> (for example <code>cat</code>).</p>
2990
+ * <p>
2991
+ * <code>"stringContains": \{ "key": "animal", "value": "at" \}</code>
2992
+ * </p>
2993
+ * </li>
2994
+ * <li>
2995
+ * <p>A list with a member that contains the <code>value</code> as a substring. The following example would return data sources with an <code>animals</code> attribute that is a list containing a member that contains the substring <code>at</code> (for example <code>["dog", "cat"]</code>).</p>
2996
+ * <p>
2997
+ * <code>"stringContains": \{ "key": "animals", "value": "at" \}</code>
2998
+ * </p>
2999
+ * </li>
3000
+ * </ul>
3001
+ * @public
3002
+ */
3003
+ interface StringContainsMember {
3004
+ equals?: never;
3005
+ notEquals?: never;
3006
+ greaterThan?: never;
3007
+ greaterThanOrEquals?: never;
3008
+ lessThan?: never;
3009
+ lessThanOrEquals?: never;
3010
+ in?: never;
3011
+ notIn?: never;
3012
+ startsWith?: never;
3013
+ listContains?: never;
3014
+ stringContains: FilterAttribute;
3015
+ andAll?: never;
3016
+ orAll?: never;
3017
+ $unknown?: never;
3018
+ }
3019
+ /**
3020
+ * <p>Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.</p>
2509
3021
  * @public
2510
3022
  */
2511
3023
  interface AndAllMember {
@@ -2518,12 +3030,14 @@ export declare namespace RetrievalFilter {
2518
3030
  in?: never;
2519
3031
  notIn?: never;
2520
3032
  startsWith?: never;
3033
+ listContains?: never;
3034
+ stringContains?: never;
2521
3035
  andAll: RetrievalFilter[];
2522
3036
  orAll?: never;
2523
3037
  $unknown?: never;
2524
3038
  }
2525
3039
  /**
2526
- * <p>Knowledge base data sources whose metadata attributes fulfill at least one of the filter conditions inside this list are returned.</p>
3040
+ * <p>Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.</p>
2527
3041
  * @public
2528
3042
  */
2529
3043
  interface OrAllMember {
@@ -2536,6 +3050,8 @@ export declare namespace RetrievalFilter {
2536
3050
  in?: never;
2537
3051
  notIn?: never;
2538
3052
  startsWith?: never;
3053
+ listContains?: never;
3054
+ stringContains?: never;
2539
3055
  andAll?: never;
2540
3056
  orAll: RetrievalFilter[];
2541
3057
  $unknown?: never;
@@ -2553,6 +3069,8 @@ export declare namespace RetrievalFilter {
2553
3069
  in?: never;
2554
3070
  notIn?: never;
2555
3071
  startsWith?: never;
3072
+ listContains?: never;
3073
+ stringContains?: never;
2556
3074
  andAll?: never;
2557
3075
  orAll?: never;
2558
3076
  $unknown: [string, any];
@@ -2567,6 +3085,8 @@ export declare namespace RetrievalFilter {
2567
3085
  in: (value: FilterAttribute) => T;
2568
3086
  notIn: (value: FilterAttribute) => T;
2569
3087
  startsWith: (value: FilterAttribute) => T;
3088
+ listContains: (value: FilterAttribute) => T;
3089
+ stringContains: (value: FilterAttribute) => T;
2570
3090
  andAll: (value: RetrievalFilter[]) => T;
2571
3091
  orAll: (value: RetrievalFilter[]) => T;
2572
3092
  _: (name: string, value: any) => T;
@@ -2814,6 +3334,54 @@ export declare const ReturnControlPayloadFilterSensitiveLog: (obj: ReturnControl
2814
3334
  * @internal
2815
3335
  */
2816
3336
  export declare const FailureTraceFilterSensitiveLog: (obj: FailureTrace) => any;
3337
+ /**
3338
+ * @internal
3339
+ */
3340
+ export declare const GuardrailContentFilterFilterSensitiveLog: (obj: GuardrailContentFilter) => any;
3341
+ /**
3342
+ * @internal
3343
+ */
3344
+ export declare const GuardrailContentPolicyAssessmentFilterSensitiveLog: (obj: GuardrailContentPolicyAssessment) => any;
3345
+ /**
3346
+ * @internal
3347
+ */
3348
+ export declare const GuardrailPiiEntityFilterFilterSensitiveLog: (obj: GuardrailPiiEntityFilter) => any;
3349
+ /**
3350
+ * @internal
3351
+ */
3352
+ export declare const GuardrailRegexFilterFilterSensitiveLog: (obj: GuardrailRegexFilter) => any;
3353
+ /**
3354
+ * @internal
3355
+ */
3356
+ export declare const GuardrailSensitiveInformationPolicyAssessmentFilterSensitiveLog: (obj: GuardrailSensitiveInformationPolicyAssessment) => any;
3357
+ /**
3358
+ * @internal
3359
+ */
3360
+ export declare const GuardrailTopicFilterSensitiveLog: (obj: GuardrailTopic) => any;
3361
+ /**
3362
+ * @internal
3363
+ */
3364
+ export declare const GuardrailTopicPolicyAssessmentFilterSensitiveLog: (obj: GuardrailTopicPolicyAssessment) => any;
3365
+ /**
3366
+ * @internal
3367
+ */
3368
+ export declare const GuardrailCustomWordFilterSensitiveLog: (obj: GuardrailCustomWord) => any;
3369
+ /**
3370
+ * @internal
3371
+ */
3372
+ export declare const GuardrailManagedWordFilterSensitiveLog: (obj: GuardrailManagedWord) => any;
3373
+ /**
3374
+ * @internal
3375
+ */
3376
+ export declare const GuardrailWordPolicyAssessmentFilterSensitiveLog: (obj: GuardrailWordPolicyAssessment) => any;
3377
+ /**
3378
+ * @internal
3379
+ */
3380
+ export declare const GuardrailAssessmentFilterSensitiveLog: (obj: GuardrailAssessment) => any;
3381
+ /**
3382
+ * @internal
3383
+ */
3384
+ export declare const GuardrailTraceFilterSensitiveLog: (obj: GuardrailTrace) => any;
2817
3385
  /**
2818
3386
  * @internal
2819
3387
  */