@aws-sdk/client-bedrock 3.699.0 → 3.703.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.
@@ -27,7 +27,7 @@ declare const CreateEvaluationJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>API operation for creating and managing Amazon Bedrock automatic model evaluation jobs and model evaluation jobs that use human workers. To learn more about the requirements for creating a model evaluation job see, <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation.html">Model evaluation</a>.</p>
30
+ * <p>Creates an evaluation job.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -46,6 +46,7 @@ declare const CreateEvaluationJobCommand_base: {
46
46
  * value: "STRING_VALUE", // required
47
47
  * },
48
48
  * ],
49
+ * applicationType: "ModelEvaluation" || "RagEvaluation",
49
50
  * evaluationConfig: { // EvaluationConfig Union: only one key present
50
51
  * automated: { // AutomatedEvaluationConfig
51
52
  * datasetMetricConfigs: [ // EvaluationDatasetMetricConfigs // required
@@ -62,6 +63,13 @@ declare const CreateEvaluationJobCommand_base: {
62
63
  * ],
63
64
  * },
64
65
  * ],
66
+ * evaluatorModelConfig: { // EvaluatorModelConfig Union: only one key present
67
+ * bedrockEvaluatorModels: [ // BedrockEvaluatorModels
68
+ * { // BedrockEvaluatorModel
69
+ * modelIdentifier: "STRING_VALUE", // required
70
+ * },
71
+ * ],
72
+ * },
65
73
  * },
66
74
  * human: { // HumanEvaluationConfig
67
75
  * humanWorkflowConfig: { // HumanWorkflowConfig
@@ -96,7 +104,153 @@ declare const CreateEvaluationJobCommand_base: {
96
104
  * { // EvaluationModelConfig Union: only one key present
97
105
  * bedrockModel: { // EvaluationBedrockModel
98
106
  * modelIdentifier: "STRING_VALUE", // required
99
- * inferenceParams: "STRING_VALUE", // required
107
+ * inferenceParams: "STRING_VALUE",
108
+ * },
109
+ * },
110
+ * ],
111
+ * ragConfigs: [ // RagConfigs
112
+ * { // RAGConfig Union: only one key present
113
+ * knowledgeBaseConfig: { // KnowledgeBaseConfig Union: only one key present
114
+ * retrieveConfig: { // RetrieveConfig
115
+ * knowledgeBaseId: "STRING_VALUE", // required
116
+ * knowledgeBaseRetrievalConfiguration: { // KnowledgeBaseRetrievalConfiguration
117
+ * vectorSearchConfiguration: { // KnowledgeBaseVectorSearchConfiguration
118
+ * numberOfResults: Number("int"),
119
+ * overrideSearchType: "HYBRID" || "SEMANTIC",
120
+ * filter: { // RetrievalFilter Union: only one key present
121
+ * equals: { // FilterAttribute
122
+ * key: "STRING_VALUE", // required
123
+ * value: "DOCUMENT_VALUE", // required
124
+ * },
125
+ * notEquals: {
126
+ * key: "STRING_VALUE", // required
127
+ * value: "DOCUMENT_VALUE", // required
128
+ * },
129
+ * greaterThan: {
130
+ * key: "STRING_VALUE", // required
131
+ * value: "DOCUMENT_VALUE", // required
132
+ * },
133
+ * greaterThanOrEquals: {
134
+ * key: "STRING_VALUE", // required
135
+ * value: "DOCUMENT_VALUE", // required
136
+ * },
137
+ * lessThan: {
138
+ * key: "STRING_VALUE", // required
139
+ * value: "DOCUMENT_VALUE", // required
140
+ * },
141
+ * lessThanOrEquals: "<FilterAttribute>",
142
+ * in: "<FilterAttribute>",
143
+ * notIn: "<FilterAttribute>",
144
+ * startsWith: "<FilterAttribute>",
145
+ * listContains: "<FilterAttribute>",
146
+ * stringContains: "<FilterAttribute>",
147
+ * andAll: [ // RetrievalFilterList
148
+ * {// Union: only one key present
149
+ * equals: "<FilterAttribute>",
150
+ * notEquals: "<FilterAttribute>",
151
+ * greaterThan: "<FilterAttribute>",
152
+ * greaterThanOrEquals: "<FilterAttribute>",
153
+ * lessThan: "<FilterAttribute>",
154
+ * lessThanOrEquals: "<FilterAttribute>",
155
+ * in: "<FilterAttribute>",
156
+ * notIn: "<FilterAttribute>",
157
+ * startsWith: "<FilterAttribute>",
158
+ * listContains: "<FilterAttribute>",
159
+ * stringContains: "<FilterAttribute>",
160
+ * andAll: [
161
+ * "<RetrievalFilter>",
162
+ * ],
163
+ * orAll: [
164
+ * "<RetrievalFilter>",
165
+ * ],
166
+ * },
167
+ * ],
168
+ * orAll: [
169
+ * "<RetrievalFilter>",
170
+ * ],
171
+ * },
172
+ * },
173
+ * },
174
+ * },
175
+ * retrieveAndGenerateConfig: { // RetrieveAndGenerateConfiguration
176
+ * type: "KNOWLEDGE_BASE" || "EXTERNAL_SOURCES", // required
177
+ * knowledgeBaseConfiguration: { // KnowledgeBaseRetrieveAndGenerateConfiguration
178
+ * knowledgeBaseId: "STRING_VALUE", // required
179
+ * modelArn: "STRING_VALUE", // required
180
+ * retrievalConfiguration: {
181
+ * vectorSearchConfiguration: {
182
+ * numberOfResults: Number("int"),
183
+ * overrideSearchType: "HYBRID" || "SEMANTIC",
184
+ * filter: "<RetrievalFilter>",
185
+ * },
186
+ * },
187
+ * generationConfiguration: { // GenerationConfiguration
188
+ * promptTemplate: { // PromptTemplate
189
+ * textPromptTemplate: "STRING_VALUE",
190
+ * },
191
+ * guardrailConfiguration: { // GuardrailConfiguration
192
+ * guardrailId: "STRING_VALUE", // required
193
+ * guardrailVersion: "STRING_VALUE", // required
194
+ * },
195
+ * kbInferenceConfig: { // KbInferenceConfig
196
+ * textInferenceConfig: { // TextInferenceConfig
197
+ * temperature: Number("float"),
198
+ * topP: Number("float"),
199
+ * maxTokens: Number("int"),
200
+ * stopSequences: [ // RAGStopSequences
201
+ * "STRING_VALUE",
202
+ * ],
203
+ * },
204
+ * },
205
+ * additionalModelRequestFields: { // AdditionalModelRequestFields
206
+ * "<keys>": "DOCUMENT_VALUE",
207
+ * },
208
+ * },
209
+ * orchestrationConfiguration: { // OrchestrationConfiguration
210
+ * queryTransformationConfiguration: { // QueryTransformationConfiguration
211
+ * type: "QUERY_DECOMPOSITION", // required
212
+ * },
213
+ * },
214
+ * },
215
+ * externalSourcesConfiguration: { // ExternalSourcesRetrieveAndGenerateConfiguration
216
+ * modelArn: "STRING_VALUE", // required
217
+ * sources: [ // ExternalSources // required
218
+ * { // ExternalSource
219
+ * sourceType: "S3" || "BYTE_CONTENT", // required
220
+ * s3Location: { // S3ObjectDoc
221
+ * uri: "STRING_VALUE", // required
222
+ * },
223
+ * byteContent: { // ByteContentDoc
224
+ * identifier: "STRING_VALUE", // required
225
+ * contentType: "STRING_VALUE", // required
226
+ * data: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required
227
+ * },
228
+ * },
229
+ * ],
230
+ * generationConfiguration: { // ExternalSourcesGenerationConfiguration
231
+ * promptTemplate: {
232
+ * textPromptTemplate: "STRING_VALUE",
233
+ * },
234
+ * guardrailConfiguration: {
235
+ * guardrailId: "STRING_VALUE", // required
236
+ * guardrailVersion: "STRING_VALUE", // required
237
+ * },
238
+ * kbInferenceConfig: {
239
+ * textInferenceConfig: {
240
+ * temperature: Number("float"),
241
+ * topP: Number("float"),
242
+ * maxTokens: Number("int"),
243
+ * stopSequences: [
244
+ * "STRING_VALUE",
245
+ * ],
246
+ * },
247
+ * },
248
+ * additionalModelRequestFields: {
249
+ * "<keys>": "DOCUMENT_VALUE",
250
+ * },
251
+ * },
252
+ * },
253
+ * },
100
254
  * },
101
255
  * },
102
256
  * ],
@@ -27,8 +27,7 @@ declare const GetEvaluationJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Retrieves the properties associated with a model evaluation job, including the
31
- * status of the job. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation.html">Model evaluation</a>.</p>
30
+ * <p>Gets information about an evaluation job, such as the status of the job.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -48,6 +47,7 @@ declare const GetEvaluationJobCommand_base: {
48
47
  * // roleArn: "STRING_VALUE", // required
49
48
  * // customerEncryptionKeyId: "STRING_VALUE",
50
49
  * // jobType: "Human" || "Automated", // required
50
+ * // applicationType: "ModelEvaluation" || "RagEvaluation",
51
51
  * // evaluationConfig: { // EvaluationConfig Union: only one key present
52
52
  * // automated: { // AutomatedEvaluationConfig
53
53
  * // datasetMetricConfigs: [ // EvaluationDatasetMetricConfigs // required
@@ -64,6 +64,13 @@ declare const GetEvaluationJobCommand_base: {
64
64
  * // ],
65
65
  * // },
66
66
  * // ],
67
+ * // evaluatorModelConfig: { // EvaluatorModelConfig Union: only one key present
68
+ * // bedrockEvaluatorModels: [ // BedrockEvaluatorModels
69
+ * // { // BedrockEvaluatorModel
70
+ * // modelIdentifier: "STRING_VALUE", // required
71
+ * // },
72
+ * // ],
73
+ * // },
67
74
  * // },
68
75
  * // human: { // HumanEvaluationConfig
69
76
  * // humanWorkflowConfig: { // HumanWorkflowConfig
@@ -98,7 +105,153 @@ declare const GetEvaluationJobCommand_base: {
98
105
  * // { // EvaluationModelConfig Union: only one key present
99
106
  * // bedrockModel: { // EvaluationBedrockModel
100
107
  * // modelIdentifier: "STRING_VALUE", // required
101
- * // inferenceParams: "STRING_VALUE", // required
108
+ * // inferenceParams: "STRING_VALUE",
109
+ * // },
110
+ * // },
111
+ * // ],
112
+ * // ragConfigs: [ // RagConfigs
113
+ * // { // RAGConfig Union: only one key present
114
+ * // knowledgeBaseConfig: { // KnowledgeBaseConfig Union: only one key present
115
+ * // retrieveConfig: { // RetrieveConfig
116
+ * // knowledgeBaseId: "STRING_VALUE", // required
117
+ * // knowledgeBaseRetrievalConfiguration: { // KnowledgeBaseRetrievalConfiguration
118
+ * // vectorSearchConfiguration: { // KnowledgeBaseVectorSearchConfiguration
119
+ * // numberOfResults: Number("int"),
120
+ * // overrideSearchType: "HYBRID" || "SEMANTIC",
121
+ * // filter: { // RetrievalFilter Union: only one key present
122
+ * // equals: { // FilterAttribute
123
+ * // key: "STRING_VALUE", // required
124
+ * // value: "DOCUMENT_VALUE", // required
125
+ * // },
126
+ * // notEquals: {
127
+ * // key: "STRING_VALUE", // required
128
+ * // value: "DOCUMENT_VALUE", // required
129
+ * // },
130
+ * // greaterThan: {
131
+ * // key: "STRING_VALUE", // required
132
+ * // value: "DOCUMENT_VALUE", // required
133
+ * // },
134
+ * // greaterThanOrEquals: {
135
+ * // key: "STRING_VALUE", // required
136
+ * // value: "DOCUMENT_VALUE", // required
137
+ * // },
138
+ * // lessThan: {
139
+ * // key: "STRING_VALUE", // required
140
+ * // value: "DOCUMENT_VALUE", // required
141
+ * // },
142
+ * // lessThanOrEquals: "<FilterAttribute>",
143
+ * // in: "<FilterAttribute>",
144
+ * // notIn: "<FilterAttribute>",
145
+ * // startsWith: "<FilterAttribute>",
146
+ * // listContains: "<FilterAttribute>",
147
+ * // stringContains: "<FilterAttribute>",
148
+ * // andAll: [ // RetrievalFilterList
149
+ * // {// Union: only one key present
150
+ * // equals: "<FilterAttribute>",
151
+ * // notEquals: "<FilterAttribute>",
152
+ * // greaterThan: "<FilterAttribute>",
153
+ * // greaterThanOrEquals: "<FilterAttribute>",
154
+ * // lessThan: "<FilterAttribute>",
155
+ * // lessThanOrEquals: "<FilterAttribute>",
156
+ * // in: "<FilterAttribute>",
157
+ * // notIn: "<FilterAttribute>",
158
+ * // startsWith: "<FilterAttribute>",
159
+ * // listContains: "<FilterAttribute>",
160
+ * // stringContains: "<FilterAttribute>",
161
+ * // andAll: [
162
+ * // "<RetrievalFilter>",
163
+ * // ],
164
+ * // orAll: [
165
+ * // "<RetrievalFilter>",
166
+ * // ],
167
+ * // },
168
+ * // ],
169
+ * // orAll: [
170
+ * // "<RetrievalFilter>",
171
+ * // ],
172
+ * // },
173
+ * // },
174
+ * // },
175
+ * // },
176
+ * // retrieveAndGenerateConfig: { // RetrieveAndGenerateConfiguration
177
+ * // type: "KNOWLEDGE_BASE" || "EXTERNAL_SOURCES", // required
178
+ * // knowledgeBaseConfiguration: { // KnowledgeBaseRetrieveAndGenerateConfiguration
179
+ * // knowledgeBaseId: "STRING_VALUE", // required
180
+ * // modelArn: "STRING_VALUE", // required
181
+ * // retrievalConfiguration: {
182
+ * // vectorSearchConfiguration: {
183
+ * // numberOfResults: Number("int"),
184
+ * // overrideSearchType: "HYBRID" || "SEMANTIC",
185
+ * // filter: "<RetrievalFilter>",
186
+ * // },
187
+ * // },
188
+ * // generationConfiguration: { // GenerationConfiguration
189
+ * // promptTemplate: { // PromptTemplate
190
+ * // textPromptTemplate: "STRING_VALUE",
191
+ * // },
192
+ * // guardrailConfiguration: { // GuardrailConfiguration
193
+ * // guardrailId: "STRING_VALUE", // required
194
+ * // guardrailVersion: "STRING_VALUE", // required
195
+ * // },
196
+ * // kbInferenceConfig: { // KbInferenceConfig
197
+ * // textInferenceConfig: { // TextInferenceConfig
198
+ * // temperature: Number("float"),
199
+ * // topP: Number("float"),
200
+ * // maxTokens: Number("int"),
201
+ * // stopSequences: [ // RAGStopSequences
202
+ * // "STRING_VALUE",
203
+ * // ],
204
+ * // },
205
+ * // },
206
+ * // additionalModelRequestFields: { // AdditionalModelRequestFields
207
+ * // "<keys>": "DOCUMENT_VALUE",
208
+ * // },
209
+ * // },
210
+ * // orchestrationConfiguration: { // OrchestrationConfiguration
211
+ * // queryTransformationConfiguration: { // QueryTransformationConfiguration
212
+ * // type: "QUERY_DECOMPOSITION", // required
213
+ * // },
214
+ * // },
215
+ * // },
216
+ * // externalSourcesConfiguration: { // ExternalSourcesRetrieveAndGenerateConfiguration
217
+ * // modelArn: "STRING_VALUE", // required
218
+ * // sources: [ // ExternalSources // required
219
+ * // { // ExternalSource
220
+ * // sourceType: "S3" || "BYTE_CONTENT", // required
221
+ * // s3Location: { // S3ObjectDoc
222
+ * // uri: "STRING_VALUE", // required
223
+ * // },
224
+ * // byteContent: { // ByteContentDoc
225
+ * // identifier: "STRING_VALUE", // required
226
+ * // contentType: "STRING_VALUE", // required
227
+ * // data: new Uint8Array(), // required
228
+ * // },
229
+ * // },
230
+ * // ],
231
+ * // generationConfiguration: { // ExternalSourcesGenerationConfiguration
232
+ * // promptTemplate: {
233
+ * // textPromptTemplate: "STRING_VALUE",
234
+ * // },
235
+ * // guardrailConfiguration: {
236
+ * // guardrailId: "STRING_VALUE", // required
237
+ * // guardrailVersion: "STRING_VALUE", // required
238
+ * // },
239
+ * // kbInferenceConfig: {
240
+ * // textInferenceConfig: {
241
+ * // temperature: Number("float"),
242
+ * // topP: Number("float"),
243
+ * // maxTokens: Number("int"),
244
+ * // stopSequences: [
245
+ * // "STRING_VALUE",
246
+ * // ],
247
+ * // },
248
+ * // },
249
+ * // additionalModelRequestFields: {
250
+ * // "<keys>": "DOCUMENT_VALUE",
251
+ * // },
252
+ * // },
253
+ * // },
254
+ * // },
102
255
  * // },
103
256
  * // },
104
257
  * // ],
@@ -27,7 +27,7 @@ declare const ListEvaluationJobsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists model evaluation jobs.</p>
30
+ * <p>Lists all existing evaluation jobs.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -38,6 +38,7 @@ declare const ListEvaluationJobsCommand_base: {
38
38
  * creationTimeAfter: new Date("TIMESTAMP"),
39
39
  * creationTimeBefore: new Date("TIMESTAMP"),
40
40
  * statusEquals: "InProgress" || "Completed" || "Failed" || "Stopping" || "Stopped" || "Deleting",
41
+ * applicationTypeEquals: "ModelEvaluation" || "RagEvaluation",
41
42
  * nameContains: "STRING_VALUE",
42
43
  * maxResults: Number("int"),
43
44
  * nextToken: "STRING_VALUE",
@@ -58,9 +59,16 @@ declare const ListEvaluationJobsCommand_base: {
58
59
  * // evaluationTaskTypes: [ // EvaluationTaskTypes // required
59
60
  * // "Summarization" || "Classification" || "QuestionAndAnswer" || "Generation" || "Custom",
60
61
  * // ],
61
- * // modelIdentifiers: [ // EvaluationModelIdentifiers // required
62
+ * // modelIdentifiers: [ // EvaluationModelIdentifiers
62
63
  * // "STRING_VALUE",
63
64
  * // ],
65
+ * // ragIdentifiers: [ // RAGIdentifiers
66
+ * // "STRING_VALUE",
67
+ * // ],
68
+ * // evaluatorModelIdentifiers: [ // EvaluatorModelIdentifiers
69
+ * // "STRING_VALUE",
70
+ * // ],
71
+ * // applicationType: "ModelEvaluation" || "RagEvaluation",
64
72
  * // },
65
73
  * // ],
66
74
  * // };
@@ -27,7 +27,7 @@ declare const StopEvaluationJobCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Stops an in progress model evaluation job.</p>
30
+ * <p>Stops an evaluation job that is current being created or running.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript