@aws-sdk/client-bedrock-runtime 3.598.0 → 3.602.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 +187 -0
- package/dist-es/models/models_0.js +110 -0
- package/dist-es/protocols/Aws_restJson1.js +50 -1
- package/dist-types/commands/ConverseCommand.d.ts +173 -2
- package/dist-types/commands/ConverseStreamCommand.d.ts +154 -4
- package/dist-types/models/models_0.d.ts +690 -109
- package/dist-types/ts3.4/models/models_0.d.ts +287 -0
- package/package.json +4 -4
|
@@ -31,7 +31,13 @@ declare const ConverseCommand_base: {
|
|
|
31
31
|
* a consistent interface that works with all models that
|
|
32
32
|
* support messages. This allows you to write code once and use it with different models.
|
|
33
33
|
* Should a model have unique inference parameters, you can also pass those unique parameters
|
|
34
|
-
* to the model
|
|
34
|
+
* to the model.</p>
|
|
35
|
+
* <p>For information about the Converse API, see <i>Use the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
|
|
36
|
+
* To use a guardrail, see <i>Use a guardrail with the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
|
|
37
|
+
* To use a tool with a model, see <i>Tool use (Function calling)</i> in the <i>Amazon Bedrock User Guide</i>
|
|
38
|
+
* </p>
|
|
39
|
+
* <p>For example code, see <i>Converse API examples</i> in the <i>Amazon Bedrock User Guide</i>.
|
|
40
|
+
* </p>
|
|
35
41
|
* <p>This operation requires permission for the <code>bedrock:InvokeModel</code> action. </p>
|
|
36
42
|
* @example
|
|
37
43
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -53,6 +59,13 @@ declare const ConverseCommand_base: {
|
|
|
53
59
|
* bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
54
60
|
* },
|
|
55
61
|
* },
|
|
62
|
+
* document: { // DocumentBlock
|
|
63
|
+
* format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md", // required
|
|
64
|
+
* name: "STRING_VALUE", // required
|
|
65
|
+
* source: { // DocumentSource Union: only one key present
|
|
66
|
+
* bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
67
|
+
* },
|
|
68
|
+
* },
|
|
56
69
|
* toolUse: { // ToolUseBlock
|
|
57
70
|
* toolUseId: "STRING_VALUE", // required
|
|
58
71
|
* name: "STRING_VALUE", // required
|
|
@@ -70,10 +83,22 @@ declare const ConverseCommand_base: {
|
|
|
70
83
|
* bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
71
84
|
* },
|
|
72
85
|
* },
|
|
86
|
+
* document: {
|
|
87
|
+
* format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md", // required
|
|
88
|
+
* name: "STRING_VALUE", // required
|
|
89
|
+
* source: {// Union: only one key present
|
|
90
|
+
* bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
91
|
+
* },
|
|
92
|
+
* },
|
|
73
93
|
* },
|
|
74
94
|
* ],
|
|
75
95
|
* status: "success" || "error",
|
|
76
96
|
* },
|
|
97
|
+
* guardContent: { // GuardrailConverseContentBlock Union: only one key present
|
|
98
|
+
* text: { // GuardrailConverseTextBlock
|
|
99
|
+
* text: "STRING_VALUE", // required
|
|
100
|
+
* },
|
|
101
|
+
* },
|
|
77
102
|
* },
|
|
78
103
|
* ],
|
|
79
104
|
* },
|
|
@@ -81,6 +106,11 @@ declare const ConverseCommand_base: {
|
|
|
81
106
|
* system: [ // SystemContentBlocks
|
|
82
107
|
* { // SystemContentBlock Union: only one key present
|
|
83
108
|
* text: "STRING_VALUE",
|
|
109
|
+
* guardContent: {// Union: only one key present
|
|
110
|
+
* text: {
|
|
111
|
+
* text: "STRING_VALUE", // required
|
|
112
|
+
* },
|
|
113
|
+
* },
|
|
84
114
|
* },
|
|
85
115
|
* ],
|
|
86
116
|
* inferenceConfig: { // InferenceConfiguration
|
|
@@ -111,6 +141,11 @@ declare const ConverseCommand_base: {
|
|
|
111
141
|
* },
|
|
112
142
|
* },
|
|
113
143
|
* },
|
|
144
|
+
* guardrailConfig: { // GuardrailConfiguration
|
|
145
|
+
* guardrailIdentifier: "STRING_VALUE", // required
|
|
146
|
+
* guardrailVersion: "STRING_VALUE", // required
|
|
147
|
+
* trace: "enabled" || "disabled",
|
|
148
|
+
* },
|
|
114
149
|
* additionalModelRequestFields: "DOCUMENT_VALUE",
|
|
115
150
|
* additionalModelResponseFieldPaths: [ // AdditionalModelResponseFieldPaths
|
|
116
151
|
* "STRING_VALUE",
|
|
@@ -131,6 +166,13 @@ declare const ConverseCommand_base: {
|
|
|
131
166
|
* // bytes: new Uint8Array(),
|
|
132
167
|
* // },
|
|
133
168
|
* // },
|
|
169
|
+
* // document: { // DocumentBlock
|
|
170
|
+
* // format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md", // required
|
|
171
|
+
* // name: "STRING_VALUE", // required
|
|
172
|
+
* // source: { // DocumentSource Union: only one key present
|
|
173
|
+
* // bytes: new Uint8Array(),
|
|
174
|
+
* // },
|
|
175
|
+
* // },
|
|
134
176
|
* // toolUse: { // ToolUseBlock
|
|
135
177
|
* // toolUseId: "STRING_VALUE", // required
|
|
136
178
|
* // name: "STRING_VALUE", // required
|
|
@@ -148,15 +190,27 @@ declare const ConverseCommand_base: {
|
|
|
148
190
|
* // bytes: new Uint8Array(),
|
|
149
191
|
* // },
|
|
150
192
|
* // },
|
|
193
|
+
* // document: {
|
|
194
|
+
* // format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md", // required
|
|
195
|
+
* // name: "STRING_VALUE", // required
|
|
196
|
+
* // source: {// Union: only one key present
|
|
197
|
+
* // bytes: new Uint8Array(),
|
|
198
|
+
* // },
|
|
199
|
+
* // },
|
|
151
200
|
* // },
|
|
152
201
|
* // ],
|
|
153
202
|
* // status: "success" || "error",
|
|
154
203
|
* // },
|
|
204
|
+
* // guardContent: { // GuardrailConverseContentBlock Union: only one key present
|
|
205
|
+
* // text: { // GuardrailConverseTextBlock
|
|
206
|
+
* // text: "STRING_VALUE", // required
|
|
207
|
+
* // },
|
|
208
|
+
* // },
|
|
155
209
|
* // },
|
|
156
210
|
* // ],
|
|
157
211
|
* // },
|
|
158
212
|
* // },
|
|
159
|
-
* // stopReason: "end_turn" || "tool_use" || "max_tokens" || "stop_sequence" || "content_filtered", // required
|
|
213
|
+
* // stopReason: "end_turn" || "tool_use" || "max_tokens" || "stop_sequence" || "guardrail_intervened" || "content_filtered", // required
|
|
160
214
|
* // usage: { // TokenUsage
|
|
161
215
|
* // inputTokens: Number("int"), // required
|
|
162
216
|
* // outputTokens: Number("int"), // required
|
|
@@ -166,6 +220,123 @@ declare const ConverseCommand_base: {
|
|
|
166
220
|
* // latencyMs: Number("long"), // required
|
|
167
221
|
* // },
|
|
168
222
|
* // additionalModelResponseFields: "DOCUMENT_VALUE",
|
|
223
|
+
* // trace: { // ConverseTrace
|
|
224
|
+
* // guardrail: { // GuardrailTraceAssessment
|
|
225
|
+
* // modelOutput: [ // ModelOutputs
|
|
226
|
+
* // "STRING_VALUE",
|
|
227
|
+
* // ],
|
|
228
|
+
* // inputAssessment: { // GuardrailAssessmentMap
|
|
229
|
+
* // "<keys>": { // GuardrailAssessment
|
|
230
|
+
* // topicPolicy: { // GuardrailTopicPolicyAssessment
|
|
231
|
+
* // topics: [ // GuardrailTopicList // required
|
|
232
|
+
* // { // GuardrailTopic
|
|
233
|
+
* // name: "STRING_VALUE", // required
|
|
234
|
+
* // type: "DENY", // required
|
|
235
|
+
* // action: "BLOCKED", // required
|
|
236
|
+
* // },
|
|
237
|
+
* // ],
|
|
238
|
+
* // },
|
|
239
|
+
* // contentPolicy: { // GuardrailContentPolicyAssessment
|
|
240
|
+
* // filters: [ // GuardrailContentFilterList // required
|
|
241
|
+
* // { // GuardrailContentFilter
|
|
242
|
+
* // type: "INSULTS" || "HATE" || "SEXUAL" || "VIOLENCE" || "MISCONDUCT" || "PROMPT_ATTACK", // required
|
|
243
|
+
* // confidence: "NONE" || "LOW" || "MEDIUM" || "HIGH", // required
|
|
244
|
+
* // action: "BLOCKED", // required
|
|
245
|
+
* // },
|
|
246
|
+
* // ],
|
|
247
|
+
* // },
|
|
248
|
+
* // wordPolicy: { // GuardrailWordPolicyAssessment
|
|
249
|
+
* // customWords: [ // GuardrailCustomWordList // required
|
|
250
|
+
* // { // GuardrailCustomWord
|
|
251
|
+
* // match: "STRING_VALUE", // required
|
|
252
|
+
* // action: "BLOCKED", // required
|
|
253
|
+
* // },
|
|
254
|
+
* // ],
|
|
255
|
+
* // managedWordLists: [ // GuardrailManagedWordList // required
|
|
256
|
+
* // { // GuardrailManagedWord
|
|
257
|
+
* // match: "STRING_VALUE", // required
|
|
258
|
+
* // type: "PROFANITY", // required
|
|
259
|
+
* // action: "BLOCKED", // required
|
|
260
|
+
* // },
|
|
261
|
+
* // ],
|
|
262
|
+
* // },
|
|
263
|
+
* // sensitiveInformationPolicy: { // GuardrailSensitiveInformationPolicyAssessment
|
|
264
|
+
* // piiEntities: [ // GuardrailPiiEntityFilterList // required
|
|
265
|
+
* // { // GuardrailPiiEntityFilter
|
|
266
|
+
* // match: "STRING_VALUE", // required
|
|
267
|
+
* // type: "ADDRESS" || "AGE" || "AWS_ACCESS_KEY" || "AWS_SECRET_KEY" || "CA_HEALTH_NUMBER" || "CA_SOCIAL_INSURANCE_NUMBER" || "CREDIT_DEBIT_CARD_CVV" || "CREDIT_DEBIT_CARD_EXPIRY" || "CREDIT_DEBIT_CARD_NUMBER" || "DRIVER_ID" || "EMAIL" || "INTERNATIONAL_BANK_ACCOUNT_NUMBER" || "IP_ADDRESS" || "LICENSE_PLATE" || "MAC_ADDRESS" || "NAME" || "PASSWORD" || "PHONE" || "PIN" || "SWIFT_CODE" || "UK_NATIONAL_HEALTH_SERVICE_NUMBER" || "UK_NATIONAL_INSURANCE_NUMBER" || "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" || "URL" || "USERNAME" || "US_BANK_ACCOUNT_NUMBER" || "US_BANK_ROUTING_NUMBER" || "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" || "US_PASSPORT_NUMBER" || "US_SOCIAL_SECURITY_NUMBER" || "VEHICLE_IDENTIFICATION_NUMBER", // required
|
|
268
|
+
* // action: "ANONYMIZED" || "BLOCKED", // required
|
|
269
|
+
* // },
|
|
270
|
+
* // ],
|
|
271
|
+
* // regexes: [ // GuardrailRegexFilterList // required
|
|
272
|
+
* // { // GuardrailRegexFilter
|
|
273
|
+
* // name: "STRING_VALUE",
|
|
274
|
+
* // match: "STRING_VALUE",
|
|
275
|
+
* // regex: "STRING_VALUE",
|
|
276
|
+
* // action: "ANONYMIZED" || "BLOCKED", // required
|
|
277
|
+
* // },
|
|
278
|
+
* // ],
|
|
279
|
+
* // },
|
|
280
|
+
* // },
|
|
281
|
+
* // },
|
|
282
|
+
* // outputAssessments: { // GuardrailAssessmentListMap
|
|
283
|
+
* // "<keys>": [ // GuardrailAssessmentList
|
|
284
|
+
* // {
|
|
285
|
+
* // topicPolicy: {
|
|
286
|
+
* // topics: [ // required
|
|
287
|
+
* // {
|
|
288
|
+
* // name: "STRING_VALUE", // required
|
|
289
|
+
* // type: "DENY", // required
|
|
290
|
+
* // action: "BLOCKED", // required
|
|
291
|
+
* // },
|
|
292
|
+
* // ],
|
|
293
|
+
* // },
|
|
294
|
+
* // contentPolicy: {
|
|
295
|
+
* // filters: [ // required
|
|
296
|
+
* // {
|
|
297
|
+
* // type: "INSULTS" || "HATE" || "SEXUAL" || "VIOLENCE" || "MISCONDUCT" || "PROMPT_ATTACK", // required
|
|
298
|
+
* // confidence: "NONE" || "LOW" || "MEDIUM" || "HIGH", // required
|
|
299
|
+
* // action: "BLOCKED", // required
|
|
300
|
+
* // },
|
|
301
|
+
* // ],
|
|
302
|
+
* // },
|
|
303
|
+
* // wordPolicy: {
|
|
304
|
+
* // customWords: [ // required
|
|
305
|
+
* // {
|
|
306
|
+
* // match: "STRING_VALUE", // required
|
|
307
|
+
* // action: "BLOCKED", // required
|
|
308
|
+
* // },
|
|
309
|
+
* // ],
|
|
310
|
+
* // managedWordLists: [ // required
|
|
311
|
+
* // {
|
|
312
|
+
* // match: "STRING_VALUE", // required
|
|
313
|
+
* // type: "PROFANITY", // required
|
|
314
|
+
* // action: "BLOCKED", // required
|
|
315
|
+
* // },
|
|
316
|
+
* // ],
|
|
317
|
+
* // },
|
|
318
|
+
* // sensitiveInformationPolicy: {
|
|
319
|
+
* // piiEntities: [ // required
|
|
320
|
+
* // {
|
|
321
|
+
* // match: "STRING_VALUE", // required
|
|
322
|
+
* // type: "ADDRESS" || "AGE" || "AWS_ACCESS_KEY" || "AWS_SECRET_KEY" || "CA_HEALTH_NUMBER" || "CA_SOCIAL_INSURANCE_NUMBER" || "CREDIT_DEBIT_CARD_CVV" || "CREDIT_DEBIT_CARD_EXPIRY" || "CREDIT_DEBIT_CARD_NUMBER" || "DRIVER_ID" || "EMAIL" || "INTERNATIONAL_BANK_ACCOUNT_NUMBER" || "IP_ADDRESS" || "LICENSE_PLATE" || "MAC_ADDRESS" || "NAME" || "PASSWORD" || "PHONE" || "PIN" || "SWIFT_CODE" || "UK_NATIONAL_HEALTH_SERVICE_NUMBER" || "UK_NATIONAL_INSURANCE_NUMBER" || "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" || "URL" || "USERNAME" || "US_BANK_ACCOUNT_NUMBER" || "US_BANK_ROUTING_NUMBER" || "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" || "US_PASSPORT_NUMBER" || "US_SOCIAL_SECURITY_NUMBER" || "VEHICLE_IDENTIFICATION_NUMBER", // required
|
|
323
|
+
* // action: "ANONYMIZED" || "BLOCKED", // required
|
|
324
|
+
* // },
|
|
325
|
+
* // ],
|
|
326
|
+
* // regexes: [ // required
|
|
327
|
+
* // {
|
|
328
|
+
* // name: "STRING_VALUE",
|
|
329
|
+
* // match: "STRING_VALUE",
|
|
330
|
+
* // regex: "STRING_VALUE",
|
|
331
|
+
* // action: "ANONYMIZED" || "BLOCKED", // required
|
|
332
|
+
* // },
|
|
333
|
+
* // ],
|
|
334
|
+
* // },
|
|
335
|
+
* // },
|
|
336
|
+
* // ],
|
|
337
|
+
* // },
|
|
338
|
+
* // },
|
|
339
|
+
* // },
|
|
169
340
|
* // };
|
|
170
341
|
*
|
|
171
342
|
* ```
|
|
@@ -32,11 +32,14 @@ declare const ConverseStreamCommand_base: {
|
|
|
32
32
|
* that works with all Amazon Bedrock models that support messages.
|
|
33
33
|
* This allows you to write code once and use it with different models. Should a
|
|
34
34
|
* model have unique inference parameters, you can also pass those unique parameters to the
|
|
35
|
-
* model.
|
|
35
|
+
* model. </p>
|
|
36
36
|
* <p>To find out if a model supports streaming, call <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html">GetFoundationModel</a>
|
|
37
37
|
* and check the <code>responseStreamingSupported</code> field in the response.</p>
|
|
38
|
-
* <p>For
|
|
39
|
-
*
|
|
38
|
+
* <p>For information about the Converse API, see <i>Use the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
|
|
39
|
+
* To use a guardrail, see <i>Use a guardrail with the Converse API</i> in the <i>Amazon Bedrock User Guide</i>.
|
|
40
|
+
* To use a tool with a model, see <i>Tool use (Function calling)</i> in the <i>Amazon Bedrock User Guide</i>
|
|
41
|
+
* </p>
|
|
42
|
+
* <p>For example code, see <i>Conversation streaming example</i> in the <i>Amazon Bedrock User Guide</i>.
|
|
40
43
|
* </p>
|
|
41
44
|
* <p>This operation requires permission for the <code>bedrock:InvokeModelWithResponseStream</code> action.</p>
|
|
42
45
|
* @example
|
|
@@ -59,6 +62,13 @@ declare const ConverseStreamCommand_base: {
|
|
|
59
62
|
* bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
60
63
|
* },
|
|
61
64
|
* },
|
|
65
|
+
* document: { // DocumentBlock
|
|
66
|
+
* format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md", // required
|
|
67
|
+
* name: "STRING_VALUE", // required
|
|
68
|
+
* source: { // DocumentSource Union: only one key present
|
|
69
|
+
* bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
70
|
+
* },
|
|
71
|
+
* },
|
|
62
72
|
* toolUse: { // ToolUseBlock
|
|
63
73
|
* toolUseId: "STRING_VALUE", // required
|
|
64
74
|
* name: "STRING_VALUE", // required
|
|
@@ -76,10 +86,22 @@ declare const ConverseStreamCommand_base: {
|
|
|
76
86
|
* bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
77
87
|
* },
|
|
78
88
|
* },
|
|
89
|
+
* document: {
|
|
90
|
+
* format: "pdf" || "csv" || "doc" || "docx" || "xls" || "xlsx" || "html" || "txt" || "md", // required
|
|
91
|
+
* name: "STRING_VALUE", // required
|
|
92
|
+
* source: {// Union: only one key present
|
|
93
|
+
* bytes: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("")
|
|
94
|
+
* },
|
|
95
|
+
* },
|
|
79
96
|
* },
|
|
80
97
|
* ],
|
|
81
98
|
* status: "success" || "error",
|
|
82
99
|
* },
|
|
100
|
+
* guardContent: { // GuardrailConverseContentBlock Union: only one key present
|
|
101
|
+
* text: { // GuardrailConverseTextBlock
|
|
102
|
+
* text: "STRING_VALUE", // required
|
|
103
|
+
* },
|
|
104
|
+
* },
|
|
83
105
|
* },
|
|
84
106
|
* ],
|
|
85
107
|
* },
|
|
@@ -87,6 +109,11 @@ declare const ConverseStreamCommand_base: {
|
|
|
87
109
|
* system: [ // SystemContentBlocks
|
|
88
110
|
* { // SystemContentBlock Union: only one key present
|
|
89
111
|
* text: "STRING_VALUE",
|
|
112
|
+
* guardContent: {// Union: only one key present
|
|
113
|
+
* text: {
|
|
114
|
+
* text: "STRING_VALUE", // required
|
|
115
|
+
* },
|
|
116
|
+
* },
|
|
90
117
|
* },
|
|
91
118
|
* ],
|
|
92
119
|
* inferenceConfig: { // InferenceConfiguration
|
|
@@ -117,6 +144,12 @@ declare const ConverseStreamCommand_base: {
|
|
|
117
144
|
* },
|
|
118
145
|
* },
|
|
119
146
|
* },
|
|
147
|
+
* guardrailConfig: { // GuardrailStreamConfiguration
|
|
148
|
+
* guardrailIdentifier: "STRING_VALUE", // required
|
|
149
|
+
* guardrailVersion: "STRING_VALUE", // required
|
|
150
|
+
* trace: "enabled" || "disabled",
|
|
151
|
+
* streamProcessingMode: "sync" || "async",
|
|
152
|
+
* },
|
|
120
153
|
* additionalModelRequestFields: "DOCUMENT_VALUE",
|
|
121
154
|
* additionalModelResponseFieldPaths: [ // AdditionalModelResponseFieldPaths
|
|
122
155
|
* "STRING_VALUE",
|
|
@@ -151,7 +184,7 @@ declare const ConverseStreamCommand_base: {
|
|
|
151
184
|
* // contentBlockIndex: Number("int"), // required
|
|
152
185
|
* // },
|
|
153
186
|
* // messageStop: { // MessageStopEvent
|
|
154
|
-
* // stopReason: "end_turn" || "tool_use" || "max_tokens" || "stop_sequence" || "content_filtered", // required
|
|
187
|
+
* // stopReason: "end_turn" || "tool_use" || "max_tokens" || "stop_sequence" || "guardrail_intervened" || "content_filtered", // required
|
|
155
188
|
* // additionalModelResponseFields: "DOCUMENT_VALUE",
|
|
156
189
|
* // },
|
|
157
190
|
* // metadata: { // ConverseStreamMetadataEvent
|
|
@@ -163,6 +196,123 @@ declare const ConverseStreamCommand_base: {
|
|
|
163
196
|
* // metrics: { // ConverseStreamMetrics
|
|
164
197
|
* // latencyMs: Number("long"), // required
|
|
165
198
|
* // },
|
|
199
|
+
* // trace: { // ConverseStreamTrace
|
|
200
|
+
* // guardrail: { // GuardrailTraceAssessment
|
|
201
|
+
* // modelOutput: [ // ModelOutputs
|
|
202
|
+
* // "STRING_VALUE",
|
|
203
|
+
* // ],
|
|
204
|
+
* // inputAssessment: { // GuardrailAssessmentMap
|
|
205
|
+
* // "<keys>": { // GuardrailAssessment
|
|
206
|
+
* // topicPolicy: { // GuardrailTopicPolicyAssessment
|
|
207
|
+
* // topics: [ // GuardrailTopicList // required
|
|
208
|
+
* // { // GuardrailTopic
|
|
209
|
+
* // name: "STRING_VALUE", // required
|
|
210
|
+
* // type: "DENY", // required
|
|
211
|
+
* // action: "BLOCKED", // required
|
|
212
|
+
* // },
|
|
213
|
+
* // ],
|
|
214
|
+
* // },
|
|
215
|
+
* // contentPolicy: { // GuardrailContentPolicyAssessment
|
|
216
|
+
* // filters: [ // GuardrailContentFilterList // required
|
|
217
|
+
* // { // GuardrailContentFilter
|
|
218
|
+
* // type: "INSULTS" || "HATE" || "SEXUAL" || "VIOLENCE" || "MISCONDUCT" || "PROMPT_ATTACK", // required
|
|
219
|
+
* // confidence: "NONE" || "LOW" || "MEDIUM" || "HIGH", // required
|
|
220
|
+
* // action: "BLOCKED", // required
|
|
221
|
+
* // },
|
|
222
|
+
* // ],
|
|
223
|
+
* // },
|
|
224
|
+
* // wordPolicy: { // GuardrailWordPolicyAssessment
|
|
225
|
+
* // customWords: [ // GuardrailCustomWordList // required
|
|
226
|
+
* // { // GuardrailCustomWord
|
|
227
|
+
* // match: "STRING_VALUE", // required
|
|
228
|
+
* // action: "BLOCKED", // required
|
|
229
|
+
* // },
|
|
230
|
+
* // ],
|
|
231
|
+
* // managedWordLists: [ // GuardrailManagedWordList // required
|
|
232
|
+
* // { // GuardrailManagedWord
|
|
233
|
+
* // match: "STRING_VALUE", // required
|
|
234
|
+
* // type: "PROFANITY", // required
|
|
235
|
+
* // action: "BLOCKED", // required
|
|
236
|
+
* // },
|
|
237
|
+
* // ],
|
|
238
|
+
* // },
|
|
239
|
+
* // sensitiveInformationPolicy: { // GuardrailSensitiveInformationPolicyAssessment
|
|
240
|
+
* // piiEntities: [ // GuardrailPiiEntityFilterList // required
|
|
241
|
+
* // { // GuardrailPiiEntityFilter
|
|
242
|
+
* // match: "STRING_VALUE", // required
|
|
243
|
+
* // type: "ADDRESS" || "AGE" || "AWS_ACCESS_KEY" || "AWS_SECRET_KEY" || "CA_HEALTH_NUMBER" || "CA_SOCIAL_INSURANCE_NUMBER" || "CREDIT_DEBIT_CARD_CVV" || "CREDIT_DEBIT_CARD_EXPIRY" || "CREDIT_DEBIT_CARD_NUMBER" || "DRIVER_ID" || "EMAIL" || "INTERNATIONAL_BANK_ACCOUNT_NUMBER" || "IP_ADDRESS" || "LICENSE_PLATE" || "MAC_ADDRESS" || "NAME" || "PASSWORD" || "PHONE" || "PIN" || "SWIFT_CODE" || "UK_NATIONAL_HEALTH_SERVICE_NUMBER" || "UK_NATIONAL_INSURANCE_NUMBER" || "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" || "URL" || "USERNAME" || "US_BANK_ACCOUNT_NUMBER" || "US_BANK_ROUTING_NUMBER" || "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" || "US_PASSPORT_NUMBER" || "US_SOCIAL_SECURITY_NUMBER" || "VEHICLE_IDENTIFICATION_NUMBER", // required
|
|
244
|
+
* // action: "ANONYMIZED" || "BLOCKED", // required
|
|
245
|
+
* // },
|
|
246
|
+
* // ],
|
|
247
|
+
* // regexes: [ // GuardrailRegexFilterList // required
|
|
248
|
+
* // { // GuardrailRegexFilter
|
|
249
|
+
* // name: "STRING_VALUE",
|
|
250
|
+
* // match: "STRING_VALUE",
|
|
251
|
+
* // regex: "STRING_VALUE",
|
|
252
|
+
* // action: "ANONYMIZED" || "BLOCKED", // required
|
|
253
|
+
* // },
|
|
254
|
+
* // ],
|
|
255
|
+
* // },
|
|
256
|
+
* // },
|
|
257
|
+
* // },
|
|
258
|
+
* // outputAssessments: { // GuardrailAssessmentListMap
|
|
259
|
+
* // "<keys>": [ // GuardrailAssessmentList
|
|
260
|
+
* // {
|
|
261
|
+
* // topicPolicy: {
|
|
262
|
+
* // topics: [ // required
|
|
263
|
+
* // {
|
|
264
|
+
* // name: "STRING_VALUE", // required
|
|
265
|
+
* // type: "DENY", // required
|
|
266
|
+
* // action: "BLOCKED", // required
|
|
267
|
+
* // },
|
|
268
|
+
* // ],
|
|
269
|
+
* // },
|
|
270
|
+
* // contentPolicy: {
|
|
271
|
+
* // filters: [ // required
|
|
272
|
+
* // {
|
|
273
|
+
* // type: "INSULTS" || "HATE" || "SEXUAL" || "VIOLENCE" || "MISCONDUCT" || "PROMPT_ATTACK", // required
|
|
274
|
+
* // confidence: "NONE" || "LOW" || "MEDIUM" || "HIGH", // required
|
|
275
|
+
* // action: "BLOCKED", // required
|
|
276
|
+
* // },
|
|
277
|
+
* // ],
|
|
278
|
+
* // },
|
|
279
|
+
* // wordPolicy: {
|
|
280
|
+
* // customWords: [ // required
|
|
281
|
+
* // {
|
|
282
|
+
* // match: "STRING_VALUE", // required
|
|
283
|
+
* // action: "BLOCKED", // required
|
|
284
|
+
* // },
|
|
285
|
+
* // ],
|
|
286
|
+
* // managedWordLists: [ // required
|
|
287
|
+
* // {
|
|
288
|
+
* // match: "STRING_VALUE", // required
|
|
289
|
+
* // type: "PROFANITY", // required
|
|
290
|
+
* // action: "BLOCKED", // required
|
|
291
|
+
* // },
|
|
292
|
+
* // ],
|
|
293
|
+
* // },
|
|
294
|
+
* // sensitiveInformationPolicy: {
|
|
295
|
+
* // piiEntities: [ // required
|
|
296
|
+
* // {
|
|
297
|
+
* // match: "STRING_VALUE", // required
|
|
298
|
+
* // type: "ADDRESS" || "AGE" || "AWS_ACCESS_KEY" || "AWS_SECRET_KEY" || "CA_HEALTH_NUMBER" || "CA_SOCIAL_INSURANCE_NUMBER" || "CREDIT_DEBIT_CARD_CVV" || "CREDIT_DEBIT_CARD_EXPIRY" || "CREDIT_DEBIT_CARD_NUMBER" || "DRIVER_ID" || "EMAIL" || "INTERNATIONAL_BANK_ACCOUNT_NUMBER" || "IP_ADDRESS" || "LICENSE_PLATE" || "MAC_ADDRESS" || "NAME" || "PASSWORD" || "PHONE" || "PIN" || "SWIFT_CODE" || "UK_NATIONAL_HEALTH_SERVICE_NUMBER" || "UK_NATIONAL_INSURANCE_NUMBER" || "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" || "URL" || "USERNAME" || "US_BANK_ACCOUNT_NUMBER" || "US_BANK_ROUTING_NUMBER" || "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" || "US_PASSPORT_NUMBER" || "US_SOCIAL_SECURITY_NUMBER" || "VEHICLE_IDENTIFICATION_NUMBER", // required
|
|
299
|
+
* // action: "ANONYMIZED" || "BLOCKED", // required
|
|
300
|
+
* // },
|
|
301
|
+
* // ],
|
|
302
|
+
* // regexes: [ // required
|
|
303
|
+
* // {
|
|
304
|
+
* // name: "STRING_VALUE",
|
|
305
|
+
* // match: "STRING_VALUE",
|
|
306
|
+
* // regex: "STRING_VALUE",
|
|
307
|
+
* // action: "ANONYMIZED" || "BLOCKED", // required
|
|
308
|
+
* // },
|
|
309
|
+
* // ],
|
|
310
|
+
* // },
|
|
311
|
+
* // },
|
|
312
|
+
* // ],
|
|
313
|
+
* // },
|
|
314
|
+
* // },
|
|
315
|
+
* // },
|
|
166
316
|
* // },
|
|
167
317
|
* // internalServerException: { // InternalServerException
|
|
168
318
|
* // message: "STRING_VALUE",
|