@aws-sdk/client-bedrock-agent-runtime 3.556.0 → 3.561.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 +166 -1
- package/dist-es/models/models_0.js +94 -0
- package/dist-es/protocols/Aws_restJson1.js +41 -0
- package/dist-types/commands/InvokeAgentCommand.d.ts +79 -4
- package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +23 -2
- package/dist-types/commands/RetrieveCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +585 -8
- package/dist-types/ts3.4/models/models_0.d.ts +197 -1
- package/package.json +1 -1
|
@@ -14,7 +14,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
14
14
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* <p>A parameter
|
|
17
|
+
* <p>A parameter for the API request or function.</p>
|
|
18
18
|
* @public
|
|
19
19
|
*/
|
|
20
20
|
export interface Parameter {
|
|
@@ -35,7 +35,7 @@ export interface Parameter {
|
|
|
35
35
|
value?: string;
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
|
-
* <p>The parameters in the request body
|
|
38
|
+
* <p>The parameters in the API request body.</p>
|
|
39
39
|
* @public
|
|
40
40
|
*/
|
|
41
41
|
export interface RequestBody {
|
|
@@ -46,7 +46,7 @@ export interface RequestBody {
|
|
|
46
46
|
content?: Record<string, Parameter[]>;
|
|
47
47
|
}
|
|
48
48
|
/**
|
|
49
|
-
* <p>Contains information about the action group being invoked.</p>
|
|
49
|
+
* <p>Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/trace-orchestration.html">OrchestrationTrace</a> in the Amazon Bedrock User Guide.</p>
|
|
50
50
|
* @public
|
|
51
51
|
*/
|
|
52
52
|
export interface ActionGroupInvocationInput {
|
|
@@ -75,6 +75,11 @@ export interface ActionGroupInvocationInput {
|
|
|
75
75
|
* @public
|
|
76
76
|
*/
|
|
77
77
|
requestBody?: RequestBody;
|
|
78
|
+
/**
|
|
79
|
+
* <p>The function in the action group to call.</p>
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
function?: string;
|
|
78
83
|
}
|
|
79
84
|
/**
|
|
80
85
|
* <p>Contains the JSON-formatted string returned by the API invoked by the action group.</p>
|
|
@@ -145,6 +150,162 @@ export declare class InternalServerException extends __BaseException {
|
|
|
145
150
|
*/
|
|
146
151
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
147
152
|
}
|
|
153
|
+
/**
|
|
154
|
+
* <p>Contains the body of the API response.</p>
|
|
155
|
+
* <p>This data type is used in the following API operations:</p>
|
|
156
|
+
* <ul>
|
|
157
|
+
* <li>
|
|
158
|
+
* <p>In the <code>returnControlInvocationResults</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a>
|
|
159
|
+
* </p>
|
|
160
|
+
* </li>
|
|
161
|
+
* </ul>
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
export interface ContentBody {
|
|
165
|
+
/**
|
|
166
|
+
* <p>The body of the API response.</p>
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
body?: string;
|
|
170
|
+
}
|
|
171
|
+
/**
|
|
172
|
+
* @public
|
|
173
|
+
* @enum
|
|
174
|
+
*/
|
|
175
|
+
export declare const ResponseState: {
|
|
176
|
+
readonly FAILURE: "FAILURE";
|
|
177
|
+
readonly REPROMPT: "REPROMPT";
|
|
178
|
+
};
|
|
179
|
+
/**
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
182
|
+
export type ResponseState = (typeof ResponseState)[keyof typeof ResponseState];
|
|
183
|
+
/**
|
|
184
|
+
* <p>Contains information about the API operation that was called from the action group and the response body that was returned.</p>
|
|
185
|
+
* <p>This data type is used in the following API operations:</p>
|
|
186
|
+
* <ul>
|
|
187
|
+
* <li>
|
|
188
|
+
* <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a>
|
|
189
|
+
* </p>
|
|
190
|
+
* </li>
|
|
191
|
+
* </ul>
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
export interface ApiResult {
|
|
195
|
+
/**
|
|
196
|
+
* <p>The action group that the API operation belongs to.</p>
|
|
197
|
+
* @public
|
|
198
|
+
*/
|
|
199
|
+
actionGroup: string | undefined;
|
|
200
|
+
/**
|
|
201
|
+
* <p>The HTTP method for the API operation.</p>
|
|
202
|
+
* @public
|
|
203
|
+
*/
|
|
204
|
+
httpMethod?: string;
|
|
205
|
+
/**
|
|
206
|
+
* <p>The path to the API operation.</p>
|
|
207
|
+
* @public
|
|
208
|
+
*/
|
|
209
|
+
apiPath?: string;
|
|
210
|
+
/**
|
|
211
|
+
* <p>The response body from the API operation. The key of the object is the content type. The response may be returned directly or from the Lambda function.</p>
|
|
212
|
+
* @public
|
|
213
|
+
*/
|
|
214
|
+
responseBody?: Record<string, ContentBody>;
|
|
215
|
+
/**
|
|
216
|
+
* <p>http status code from API execution response (for example: 200, 400, 500).</p>
|
|
217
|
+
* @public
|
|
218
|
+
*/
|
|
219
|
+
httpStatusCode?: number;
|
|
220
|
+
/**
|
|
221
|
+
* <p>Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt</p>
|
|
222
|
+
* @public
|
|
223
|
+
*/
|
|
224
|
+
responseState?: ResponseState;
|
|
225
|
+
}
|
|
226
|
+
/**
|
|
227
|
+
* <p>Contains information about the function that was called from the action group and the response that was returned.</p>
|
|
228
|
+
* <p>This data type is used in the following API operations:</p>
|
|
229
|
+
* <ul>
|
|
230
|
+
* <li>
|
|
231
|
+
* <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a>
|
|
232
|
+
* </p>
|
|
233
|
+
* </li>
|
|
234
|
+
* </ul>
|
|
235
|
+
* @public
|
|
236
|
+
*/
|
|
237
|
+
export interface FunctionResult {
|
|
238
|
+
/**
|
|
239
|
+
* <p>The action group that the function belongs to.</p>
|
|
240
|
+
* @public
|
|
241
|
+
*/
|
|
242
|
+
actionGroup: string | undefined;
|
|
243
|
+
/**
|
|
244
|
+
* <p>The name of the function that was called.</p>
|
|
245
|
+
* @public
|
|
246
|
+
*/
|
|
247
|
+
function?: string;
|
|
248
|
+
/**
|
|
249
|
+
* <p>The response from the function call using the parameters. The response may be returned directly or from the Lambda function.</p>
|
|
250
|
+
* @public
|
|
251
|
+
*/
|
|
252
|
+
responseBody?: Record<string, ContentBody>;
|
|
253
|
+
/**
|
|
254
|
+
* <p>Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt</p>
|
|
255
|
+
* @public
|
|
256
|
+
*/
|
|
257
|
+
responseState?: ResponseState;
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* <p>A result from the action group invocation.</p>
|
|
261
|
+
* <p>This data type is used in the following API operations:</p>
|
|
262
|
+
* <ul>
|
|
263
|
+
* <li>
|
|
264
|
+
* <p>
|
|
265
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a>
|
|
266
|
+
* </p>
|
|
267
|
+
* </li>
|
|
268
|
+
* </ul>
|
|
269
|
+
* @public
|
|
270
|
+
*/
|
|
271
|
+
export type InvocationResultMember = InvocationResultMember.ApiResultMember | InvocationResultMember.FunctionResultMember | InvocationResultMember.$UnknownMember;
|
|
272
|
+
/**
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
export declare namespace InvocationResultMember {
|
|
276
|
+
/**
|
|
277
|
+
* <p>The result from the API response from the action group invocation.</p>
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
interface ApiResultMember {
|
|
281
|
+
apiResult: ApiResult;
|
|
282
|
+
functionResult?: never;
|
|
283
|
+
$unknown?: never;
|
|
284
|
+
}
|
|
285
|
+
/**
|
|
286
|
+
* <p>The result from the function from the action group invocation.</p>
|
|
287
|
+
* @public
|
|
288
|
+
*/
|
|
289
|
+
interface FunctionResultMember {
|
|
290
|
+
apiResult?: never;
|
|
291
|
+
functionResult: FunctionResult;
|
|
292
|
+
$unknown?: never;
|
|
293
|
+
}
|
|
294
|
+
/**
|
|
295
|
+
* @public
|
|
296
|
+
*/
|
|
297
|
+
interface $UnknownMember {
|
|
298
|
+
apiResult?: never;
|
|
299
|
+
functionResult?: never;
|
|
300
|
+
$unknown: [string, any];
|
|
301
|
+
}
|
|
302
|
+
interface Visitor<T> {
|
|
303
|
+
apiResult: (value: ApiResult) => T;
|
|
304
|
+
functionResult: (value: FunctionResult) => T;
|
|
305
|
+
_: (name: string, value: any) => T;
|
|
306
|
+
}
|
|
307
|
+
const visit: <T>(value: InvocationResultMember, visitor: Visitor<T>) => T;
|
|
308
|
+
}
|
|
148
309
|
/**
|
|
149
310
|
* <p>Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html">Lambda function</a> for an action group or pass them when making an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
150
311
|
* @public
|
|
@@ -160,6 +321,16 @@ export interface SessionState {
|
|
|
160
321
|
* @public
|
|
161
322
|
*/
|
|
162
323
|
promptSessionAttributes?: Record<string, string>;
|
|
324
|
+
/**
|
|
325
|
+
* <p>Contains information about the results from the action group invocation.</p>
|
|
326
|
+
* @public
|
|
327
|
+
*/
|
|
328
|
+
returnControlInvocationResults?: InvocationResultMember[];
|
|
329
|
+
/**
|
|
330
|
+
* <p>The identifier of the invocation.</p>
|
|
331
|
+
* @public
|
|
332
|
+
*/
|
|
333
|
+
invocationId?: string;
|
|
163
334
|
}
|
|
164
335
|
/**
|
|
165
336
|
* @public
|
|
@@ -199,7 +370,7 @@ export interface InvokeAgentRequest {
|
|
|
199
370
|
* <p>The prompt text to send the agent.</p>
|
|
200
371
|
* @public
|
|
201
372
|
*/
|
|
202
|
-
inputText
|
|
373
|
+
inputText?: string;
|
|
203
374
|
}
|
|
204
375
|
/**
|
|
205
376
|
* <p>Contains information about where the text with a citation begins and ends in the generated output.</p>
|
|
@@ -458,7 +629,7 @@ export interface PayloadPart {
|
|
|
458
629
|
attribution?: Attribution;
|
|
459
630
|
}
|
|
460
631
|
/**
|
|
461
|
-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
632
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
462
633
|
* @public
|
|
463
634
|
*/
|
|
464
635
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
@@ -469,6 +640,232 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
469
640
|
*/
|
|
470
641
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
471
642
|
}
|
|
643
|
+
/**
|
|
644
|
+
* <p>Information about a parameter to provide to the API request.</p>
|
|
645
|
+
* <p>This data type is used in the following API operations:</p>
|
|
646
|
+
* <ul>
|
|
647
|
+
* <li>
|
|
648
|
+
* <p>
|
|
649
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a>
|
|
650
|
+
* </p>
|
|
651
|
+
* </li>
|
|
652
|
+
* </ul>
|
|
653
|
+
* @public
|
|
654
|
+
*/
|
|
655
|
+
export interface ApiParameter {
|
|
656
|
+
/**
|
|
657
|
+
* <p>The name of the parameter.</p>
|
|
658
|
+
* @public
|
|
659
|
+
*/
|
|
660
|
+
name?: string;
|
|
661
|
+
/**
|
|
662
|
+
* <p>The data type for the parameter.</p>
|
|
663
|
+
* @public
|
|
664
|
+
*/
|
|
665
|
+
type?: string;
|
|
666
|
+
/**
|
|
667
|
+
* <p>The value of the parameter.</p>
|
|
668
|
+
* @public
|
|
669
|
+
*/
|
|
670
|
+
value?: string;
|
|
671
|
+
}
|
|
672
|
+
/**
|
|
673
|
+
* <p>Contains the parameters in the request body.</p>
|
|
674
|
+
* @public
|
|
675
|
+
*/
|
|
676
|
+
export interface PropertyParameters {
|
|
677
|
+
/**
|
|
678
|
+
* <p>A list of parameters in the request body.</p>
|
|
679
|
+
* @public
|
|
680
|
+
*/
|
|
681
|
+
properties?: Parameter[];
|
|
682
|
+
}
|
|
683
|
+
/**
|
|
684
|
+
* <p>The request body to provide for the API request, as the agent elicited from the user.</p>
|
|
685
|
+
* <p>This data type is used in the following API operations:</p>
|
|
686
|
+
* <ul>
|
|
687
|
+
* <li>
|
|
688
|
+
* <p>
|
|
689
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a>
|
|
690
|
+
* </p>
|
|
691
|
+
* </li>
|
|
692
|
+
* </ul>
|
|
693
|
+
* @public
|
|
694
|
+
*/
|
|
695
|
+
export interface ApiRequestBody {
|
|
696
|
+
/**
|
|
697
|
+
* <p>The content of the request body. The key of the object in this field is a media type defining the format of the request body.</p>
|
|
698
|
+
* @public
|
|
699
|
+
*/
|
|
700
|
+
content?: Record<string, PropertyParameters>;
|
|
701
|
+
}
|
|
702
|
+
/**
|
|
703
|
+
* <p>Contains information about the API operation that the agent predicts should be called.</p>
|
|
704
|
+
* <p>This data type is used in the following API operations:</p>
|
|
705
|
+
* <ul>
|
|
706
|
+
* <li>
|
|
707
|
+
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a>
|
|
708
|
+
* </p>
|
|
709
|
+
* </li>
|
|
710
|
+
* </ul>
|
|
711
|
+
* @public
|
|
712
|
+
*/
|
|
713
|
+
export interface ApiInvocationInput {
|
|
714
|
+
/**
|
|
715
|
+
* <p>The action group that the API operation belongs to.</p>
|
|
716
|
+
* @public
|
|
717
|
+
*/
|
|
718
|
+
actionGroup: string | undefined;
|
|
719
|
+
/**
|
|
720
|
+
* <p>The HTTP method of the API operation.</p>
|
|
721
|
+
* @public
|
|
722
|
+
*/
|
|
723
|
+
httpMethod?: string;
|
|
724
|
+
/**
|
|
725
|
+
* <p>The path to the API operation.</p>
|
|
726
|
+
* @public
|
|
727
|
+
*/
|
|
728
|
+
apiPath?: string;
|
|
729
|
+
/**
|
|
730
|
+
* <p>The parameters to provide for the API request, as the agent elicited from the user.</p>
|
|
731
|
+
* @public
|
|
732
|
+
*/
|
|
733
|
+
parameters?: ApiParameter[];
|
|
734
|
+
/**
|
|
735
|
+
* <p>The request body to provide for the API request, as the agent elicited from the user.</p>
|
|
736
|
+
* @public
|
|
737
|
+
*/
|
|
738
|
+
requestBody?: ApiRequestBody;
|
|
739
|
+
}
|
|
740
|
+
/**
|
|
741
|
+
* <p>Contains information about a parameter of the function.</p>
|
|
742
|
+
* <p>This data type is used in the following API operations:</p>
|
|
743
|
+
* <ul>
|
|
744
|
+
* <li>
|
|
745
|
+
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a>
|
|
746
|
+
* </p>
|
|
747
|
+
* </li>
|
|
748
|
+
* </ul>
|
|
749
|
+
* @public
|
|
750
|
+
*/
|
|
751
|
+
export interface FunctionParameter {
|
|
752
|
+
/**
|
|
753
|
+
* <p>The name of the parameter.</p>
|
|
754
|
+
* @public
|
|
755
|
+
*/
|
|
756
|
+
name?: string;
|
|
757
|
+
/**
|
|
758
|
+
* <p>The data type of the parameter.</p>
|
|
759
|
+
* @public
|
|
760
|
+
*/
|
|
761
|
+
type?: string;
|
|
762
|
+
/**
|
|
763
|
+
* <p>The value of the parameter.</p>
|
|
764
|
+
* @public
|
|
765
|
+
*/
|
|
766
|
+
value?: string;
|
|
767
|
+
}
|
|
768
|
+
/**
|
|
769
|
+
* <p>Contains information about the function that the agent predicts should be called.</p>
|
|
770
|
+
* <p>This data type is used in the following API operations:</p>
|
|
771
|
+
* <ul>
|
|
772
|
+
* <li>
|
|
773
|
+
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a>
|
|
774
|
+
* </p>
|
|
775
|
+
* </li>
|
|
776
|
+
* </ul>
|
|
777
|
+
* @public
|
|
778
|
+
*/
|
|
779
|
+
export interface FunctionInvocationInput {
|
|
780
|
+
/**
|
|
781
|
+
* <p>The action group that the function belongs to.</p>
|
|
782
|
+
* @public
|
|
783
|
+
*/
|
|
784
|
+
actionGroup: string | undefined;
|
|
785
|
+
/**
|
|
786
|
+
* <p>A list of parameters of the function.</p>
|
|
787
|
+
* @public
|
|
788
|
+
*/
|
|
789
|
+
parameters?: FunctionParameter[];
|
|
790
|
+
/**
|
|
791
|
+
* <p>The name of the function.</p>
|
|
792
|
+
* @public
|
|
793
|
+
*/
|
|
794
|
+
function?: string;
|
|
795
|
+
}
|
|
796
|
+
/**
|
|
797
|
+
* <p>Contains details about the API operation or function that the agent predicts should be called.</p>
|
|
798
|
+
* <p>This data type is used in the following API operations:</p>
|
|
799
|
+
* <ul>
|
|
800
|
+
* <li>
|
|
801
|
+
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a>
|
|
802
|
+
* </p>
|
|
803
|
+
* </li>
|
|
804
|
+
* </ul>
|
|
805
|
+
* @public
|
|
806
|
+
*/
|
|
807
|
+
export type InvocationInputMember = InvocationInputMember.ApiInvocationInputMember | InvocationInputMember.FunctionInvocationInputMember | InvocationInputMember.$UnknownMember;
|
|
808
|
+
/**
|
|
809
|
+
* @public
|
|
810
|
+
*/
|
|
811
|
+
export declare namespace InvocationInputMember {
|
|
812
|
+
/**
|
|
813
|
+
* <p>Contains information about the API operation that the agent predicts should be called.</p>
|
|
814
|
+
* @public
|
|
815
|
+
*/
|
|
816
|
+
interface ApiInvocationInputMember {
|
|
817
|
+
apiInvocationInput: ApiInvocationInput;
|
|
818
|
+
functionInvocationInput?: never;
|
|
819
|
+
$unknown?: never;
|
|
820
|
+
}
|
|
821
|
+
/**
|
|
822
|
+
* <p>Contains information about the function that the agent predicts should be called.</p>
|
|
823
|
+
* @public
|
|
824
|
+
*/
|
|
825
|
+
interface FunctionInvocationInputMember {
|
|
826
|
+
apiInvocationInput?: never;
|
|
827
|
+
functionInvocationInput: FunctionInvocationInput;
|
|
828
|
+
$unknown?: never;
|
|
829
|
+
}
|
|
830
|
+
/**
|
|
831
|
+
* @public
|
|
832
|
+
*/
|
|
833
|
+
interface $UnknownMember {
|
|
834
|
+
apiInvocationInput?: never;
|
|
835
|
+
functionInvocationInput?: never;
|
|
836
|
+
$unknown: [string, any];
|
|
837
|
+
}
|
|
838
|
+
interface Visitor<T> {
|
|
839
|
+
apiInvocationInput: (value: ApiInvocationInput) => T;
|
|
840
|
+
functionInvocationInput: (value: FunctionInvocationInput) => T;
|
|
841
|
+
_: (name: string, value: any) => T;
|
|
842
|
+
}
|
|
843
|
+
const visit: <T>(value: InvocationInputMember, visitor: Visitor<T>) => T;
|
|
844
|
+
}
|
|
845
|
+
/**
|
|
846
|
+
* <p>Contains information to return from the action group that the agent has predicted to invoke.</p>
|
|
847
|
+
* <p>This data type is used in the following API operations:</p>
|
|
848
|
+
* <ul>
|
|
849
|
+
* <li>
|
|
850
|
+
* <p>
|
|
851
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_ResponseSyntax">Retrieve response</a>
|
|
852
|
+
* </p>
|
|
853
|
+
* </li>
|
|
854
|
+
* </ul>
|
|
855
|
+
* @public
|
|
856
|
+
*/
|
|
857
|
+
export interface ReturnControlPayload {
|
|
858
|
+
/**
|
|
859
|
+
* <p>A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.</p>
|
|
860
|
+
* @public
|
|
861
|
+
*/
|
|
862
|
+
invocationInputs?: InvocationInputMember[];
|
|
863
|
+
/**
|
|
864
|
+
* <p>The identifier of the action group invocation.</p>
|
|
865
|
+
* @public
|
|
866
|
+
*/
|
|
867
|
+
invocationId?: string;
|
|
868
|
+
}
|
|
472
869
|
/**
|
|
473
870
|
* <p>The number of requests exceeds the service quota. Resubmit your request later.</p>
|
|
474
871
|
* @public
|
|
@@ -1153,6 +1550,11 @@ export interface TracePart {
|
|
|
1153
1550
|
* @public
|
|
1154
1551
|
*/
|
|
1155
1552
|
sessionId?: string;
|
|
1553
|
+
/**
|
|
1554
|
+
* <p>The version of the agent.</p>
|
|
1555
|
+
* @public
|
|
1556
|
+
*/
|
|
1557
|
+
agentVersion?: string;
|
|
1156
1558
|
/**
|
|
1157
1559
|
* <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>
|
|
1158
1560
|
* @public
|
|
@@ -1175,7 +1577,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
1175
1577
|
* <p>The response from invoking the agent and associated citations and trace information.</p>
|
|
1176
1578
|
* @public
|
|
1177
1579
|
*/
|
|
1178
|
-
export type ResponseStream = ResponseStream.AccessDeniedExceptionMember | ResponseStream.BadGatewayExceptionMember | ResponseStream.ChunkMember | ResponseStream.ConflictExceptionMember | ResponseStream.DependencyFailedExceptionMember | ResponseStream.InternalServerExceptionMember | ResponseStream.ResourceNotFoundExceptionMember | ResponseStream.ServiceQuotaExceededExceptionMember | ResponseStream.ThrottlingExceptionMember | ResponseStream.TraceMember | ResponseStream.ValidationExceptionMember | ResponseStream.$UnknownMember;
|
|
1580
|
+
export type ResponseStream = ResponseStream.AccessDeniedExceptionMember | ResponseStream.BadGatewayExceptionMember | ResponseStream.ChunkMember | ResponseStream.ConflictExceptionMember | ResponseStream.DependencyFailedExceptionMember | ResponseStream.InternalServerExceptionMember | ResponseStream.ResourceNotFoundExceptionMember | ResponseStream.ReturnControlMember | ResponseStream.ServiceQuotaExceededExceptionMember | ResponseStream.ThrottlingExceptionMember | ResponseStream.TraceMember | ResponseStream.ValidationExceptionMember | ResponseStream.$UnknownMember;
|
|
1179
1581
|
/**
|
|
1180
1582
|
* @public
|
|
1181
1583
|
*/
|
|
@@ -1187,6 +1589,7 @@ export declare namespace ResponseStream {
|
|
|
1187
1589
|
interface ChunkMember {
|
|
1188
1590
|
chunk: PayloadPart;
|
|
1189
1591
|
trace?: never;
|
|
1592
|
+
returnControl?: never;
|
|
1190
1593
|
internalServerException?: never;
|
|
1191
1594
|
validationException?: never;
|
|
1192
1595
|
resourceNotFoundException?: never;
|
|
@@ -1199,12 +1602,32 @@ export declare namespace ResponseStream {
|
|
|
1199
1602
|
$unknown?: never;
|
|
1200
1603
|
}
|
|
1201
1604
|
/**
|
|
1202
|
-
* <p>Contains information about the agent and session, alongside the agent's reasoning process and results from calling
|
|
1605
|
+
* <p>Contains information about the agent and session, alongside the agent's reasoning process and results from calling actions and querying knowledge bases and metadata about the trace. 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/trace-events.html">Trace events</a>.</p>
|
|
1203
1606
|
* @public
|
|
1204
1607
|
*/
|
|
1205
1608
|
interface TraceMember {
|
|
1206
1609
|
chunk?: never;
|
|
1207
1610
|
trace: TracePart;
|
|
1611
|
+
returnControl?: never;
|
|
1612
|
+
internalServerException?: never;
|
|
1613
|
+
validationException?: never;
|
|
1614
|
+
resourceNotFoundException?: never;
|
|
1615
|
+
serviceQuotaExceededException?: never;
|
|
1616
|
+
throttlingException?: never;
|
|
1617
|
+
accessDeniedException?: never;
|
|
1618
|
+
conflictException?: never;
|
|
1619
|
+
dependencyFailedException?: never;
|
|
1620
|
+
badGatewayException?: never;
|
|
1621
|
+
$unknown?: never;
|
|
1622
|
+
}
|
|
1623
|
+
/**
|
|
1624
|
+
* <p>Contains the parameters and information that the agent elicited from the customer to carry out an action. This information is returned to the system and can be used in your own setup for fulfilling the action.</p>
|
|
1625
|
+
* @public
|
|
1626
|
+
*/
|
|
1627
|
+
interface ReturnControlMember {
|
|
1628
|
+
chunk?: never;
|
|
1629
|
+
trace?: never;
|
|
1630
|
+
returnControl: ReturnControlPayload;
|
|
1208
1631
|
internalServerException?: never;
|
|
1209
1632
|
validationException?: never;
|
|
1210
1633
|
resourceNotFoundException?: never;
|
|
@@ -1223,6 +1646,7 @@ export declare namespace ResponseStream {
|
|
|
1223
1646
|
interface InternalServerExceptionMember {
|
|
1224
1647
|
chunk?: never;
|
|
1225
1648
|
trace?: never;
|
|
1649
|
+
returnControl?: never;
|
|
1226
1650
|
internalServerException: InternalServerException;
|
|
1227
1651
|
validationException?: never;
|
|
1228
1652
|
resourceNotFoundException?: never;
|
|
@@ -1241,6 +1665,7 @@ export declare namespace ResponseStream {
|
|
|
1241
1665
|
interface ValidationExceptionMember {
|
|
1242
1666
|
chunk?: never;
|
|
1243
1667
|
trace?: never;
|
|
1668
|
+
returnControl?: never;
|
|
1244
1669
|
internalServerException?: never;
|
|
1245
1670
|
validationException: ValidationException;
|
|
1246
1671
|
resourceNotFoundException?: never;
|
|
@@ -1253,12 +1678,13 @@ export declare namespace ResponseStream {
|
|
|
1253
1678
|
$unknown?: never;
|
|
1254
1679
|
}
|
|
1255
1680
|
/**
|
|
1256
|
-
* <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
|
|
1681
|
+
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
1257
1682
|
* @public
|
|
1258
1683
|
*/
|
|
1259
1684
|
interface ResourceNotFoundExceptionMember {
|
|
1260
1685
|
chunk?: never;
|
|
1261
1686
|
trace?: never;
|
|
1687
|
+
returnControl?: never;
|
|
1262
1688
|
internalServerException?: never;
|
|
1263
1689
|
validationException?: never;
|
|
1264
1690
|
resourceNotFoundException: ResourceNotFoundException;
|
|
@@ -1277,6 +1703,7 @@ export declare namespace ResponseStream {
|
|
|
1277
1703
|
interface ServiceQuotaExceededExceptionMember {
|
|
1278
1704
|
chunk?: never;
|
|
1279
1705
|
trace?: never;
|
|
1706
|
+
returnControl?: never;
|
|
1280
1707
|
internalServerException?: never;
|
|
1281
1708
|
validationException?: never;
|
|
1282
1709
|
resourceNotFoundException?: never;
|
|
@@ -1295,6 +1722,7 @@ export declare namespace ResponseStream {
|
|
|
1295
1722
|
interface ThrottlingExceptionMember {
|
|
1296
1723
|
chunk?: never;
|
|
1297
1724
|
trace?: never;
|
|
1725
|
+
returnControl?: never;
|
|
1298
1726
|
internalServerException?: never;
|
|
1299
1727
|
validationException?: never;
|
|
1300
1728
|
resourceNotFoundException?: never;
|
|
@@ -1313,6 +1741,7 @@ export declare namespace ResponseStream {
|
|
|
1313
1741
|
interface AccessDeniedExceptionMember {
|
|
1314
1742
|
chunk?: never;
|
|
1315
1743
|
trace?: never;
|
|
1744
|
+
returnControl?: never;
|
|
1316
1745
|
internalServerException?: never;
|
|
1317
1746
|
validationException?: never;
|
|
1318
1747
|
resourceNotFoundException?: never;
|
|
@@ -1331,6 +1760,7 @@ export declare namespace ResponseStream {
|
|
|
1331
1760
|
interface ConflictExceptionMember {
|
|
1332
1761
|
chunk?: never;
|
|
1333
1762
|
trace?: never;
|
|
1763
|
+
returnControl?: never;
|
|
1334
1764
|
internalServerException?: never;
|
|
1335
1765
|
validationException?: never;
|
|
1336
1766
|
resourceNotFoundException?: never;
|
|
@@ -1349,6 +1779,7 @@ export declare namespace ResponseStream {
|
|
|
1349
1779
|
interface DependencyFailedExceptionMember {
|
|
1350
1780
|
chunk?: never;
|
|
1351
1781
|
trace?: never;
|
|
1782
|
+
returnControl?: never;
|
|
1352
1783
|
internalServerException?: never;
|
|
1353
1784
|
validationException?: never;
|
|
1354
1785
|
resourceNotFoundException?: never;
|
|
@@ -1367,6 +1798,7 @@ export declare namespace ResponseStream {
|
|
|
1367
1798
|
interface BadGatewayExceptionMember {
|
|
1368
1799
|
chunk?: never;
|
|
1369
1800
|
trace?: never;
|
|
1801
|
+
returnControl?: never;
|
|
1370
1802
|
internalServerException?: never;
|
|
1371
1803
|
validationException?: never;
|
|
1372
1804
|
resourceNotFoundException?: never;
|
|
@@ -1384,6 +1816,7 @@ export declare namespace ResponseStream {
|
|
|
1384
1816
|
interface $UnknownMember {
|
|
1385
1817
|
chunk?: never;
|
|
1386
1818
|
trace?: never;
|
|
1819
|
+
returnControl?: never;
|
|
1387
1820
|
internalServerException?: never;
|
|
1388
1821
|
validationException?: never;
|
|
1389
1822
|
resourceNotFoundException?: never;
|
|
@@ -1398,6 +1831,7 @@ export declare namespace ResponseStream {
|
|
|
1398
1831
|
interface Visitor<T> {
|
|
1399
1832
|
chunk: (value: PayloadPart) => T;
|
|
1400
1833
|
trace: (value: TracePart) => T;
|
|
1834
|
+
returnControl: (value: ReturnControlPayload) => T;
|
|
1401
1835
|
internalServerException: (value: InternalServerException) => T;
|
|
1402
1836
|
validationException: (value: ValidationException) => T;
|
|
1403
1837
|
resourceNotFoundException: (value: ResourceNotFoundException) => T;
|
|
@@ -1480,6 +1914,103 @@ export interface PromptTemplate {
|
|
|
1480
1914
|
*/
|
|
1481
1915
|
textPromptTemplate?: string;
|
|
1482
1916
|
}
|
|
1917
|
+
/**
|
|
1918
|
+
* <p>Contains the generation configuration of the external source wrapper object.</p>
|
|
1919
|
+
* @public
|
|
1920
|
+
*/
|
|
1921
|
+
export interface ExternalSourcesGenerationConfiguration {
|
|
1922
|
+
/**
|
|
1923
|
+
* <p>Contain the textPromptTemplate string for the external source wrapper object.</p>
|
|
1924
|
+
* @public
|
|
1925
|
+
*/
|
|
1926
|
+
promptTemplate?: PromptTemplate;
|
|
1927
|
+
}
|
|
1928
|
+
/**
|
|
1929
|
+
* <p>This property contains the document to chat with, along with its attributes.</p>
|
|
1930
|
+
* @public
|
|
1931
|
+
*/
|
|
1932
|
+
export interface ByteContentDoc {
|
|
1933
|
+
/**
|
|
1934
|
+
* <p>The file name of the document contained in the wrapper object.</p>
|
|
1935
|
+
* @public
|
|
1936
|
+
*/
|
|
1937
|
+
identifier: string | undefined;
|
|
1938
|
+
/**
|
|
1939
|
+
* <p>The MIME type of the document contained in the wrapper object.</p>
|
|
1940
|
+
* @public
|
|
1941
|
+
*/
|
|
1942
|
+
contentType: string | undefined;
|
|
1943
|
+
/**
|
|
1944
|
+
* <p>The byte value of the file to upload, encoded as a Base-64 string.</p>
|
|
1945
|
+
* @public
|
|
1946
|
+
*/
|
|
1947
|
+
data: Uint8Array | undefined;
|
|
1948
|
+
}
|
|
1949
|
+
/**
|
|
1950
|
+
* <p>The unique wrapper object of the document from the S3 location.</p>
|
|
1951
|
+
* @public
|
|
1952
|
+
*/
|
|
1953
|
+
export interface S3ObjectDoc {
|
|
1954
|
+
/**
|
|
1955
|
+
* <p>The file location of the S3 wrapper object.</p>
|
|
1956
|
+
* @public
|
|
1957
|
+
*/
|
|
1958
|
+
uri: string | undefined;
|
|
1959
|
+
}
|
|
1960
|
+
/**
|
|
1961
|
+
* @public
|
|
1962
|
+
* @enum
|
|
1963
|
+
*/
|
|
1964
|
+
export declare const ExternalSourceType: {
|
|
1965
|
+
readonly BYTE_CONTENT: "BYTE_CONTENT";
|
|
1966
|
+
readonly S3: "S3";
|
|
1967
|
+
};
|
|
1968
|
+
/**
|
|
1969
|
+
* @public
|
|
1970
|
+
*/
|
|
1971
|
+
export type ExternalSourceType = (typeof ExternalSourceType)[keyof typeof ExternalSourceType];
|
|
1972
|
+
/**
|
|
1973
|
+
* <p>The unique external source of the content contained in the wrapper object.</p>
|
|
1974
|
+
* @public
|
|
1975
|
+
*/
|
|
1976
|
+
export interface ExternalSource {
|
|
1977
|
+
/**
|
|
1978
|
+
* <p>The source type of the external source wrapper object.</p>
|
|
1979
|
+
* @public
|
|
1980
|
+
*/
|
|
1981
|
+
sourceType: ExternalSourceType | undefined;
|
|
1982
|
+
/**
|
|
1983
|
+
* <p>The S3 location of the external source wrapper object.</p>
|
|
1984
|
+
* @public
|
|
1985
|
+
*/
|
|
1986
|
+
s3Location?: S3ObjectDoc;
|
|
1987
|
+
/**
|
|
1988
|
+
* <p>The identifier, contentType, and data of the external source wrapper object.</p>
|
|
1989
|
+
* @public
|
|
1990
|
+
*/
|
|
1991
|
+
byteContent?: ByteContentDoc;
|
|
1992
|
+
}
|
|
1993
|
+
/**
|
|
1994
|
+
* <p>The configurations of the external source wrapper object in the retrieveAndGenerate function.</p>
|
|
1995
|
+
* @public
|
|
1996
|
+
*/
|
|
1997
|
+
export interface ExternalSourcesRetrieveAndGenerateConfiguration {
|
|
1998
|
+
/**
|
|
1999
|
+
* <p>The modelArn used with the external source wrapper object in the retrieveAndGenerate function.</p>
|
|
2000
|
+
* @public
|
|
2001
|
+
*/
|
|
2002
|
+
modelArn: string | undefined;
|
|
2003
|
+
/**
|
|
2004
|
+
* <p>The document used with the external source wrapper object in the retrieveAndGenerate function.</p>
|
|
2005
|
+
* @public
|
|
2006
|
+
*/
|
|
2007
|
+
sources: ExternalSource[] | undefined;
|
|
2008
|
+
/**
|
|
2009
|
+
* <p>The prompt used with the external source wrapper object with the retrieveAndGenerate function.</p>
|
|
2010
|
+
* @public
|
|
2011
|
+
*/
|
|
2012
|
+
generationConfiguration?: ExternalSourcesGenerationConfiguration;
|
|
2013
|
+
}
|
|
1483
2014
|
/**
|
|
1484
2015
|
* <p>Contains configurations for response generation based on the knowledge base query results.</p>
|
|
1485
2016
|
* <p>This data type is used in the following API operations:</p>
|
|
@@ -1540,6 +2071,7 @@ export type SearchType = (typeof SearchType)[keyof typeof SearchType];
|
|
|
1540
2071
|
* @enum
|
|
1541
2072
|
*/
|
|
1542
2073
|
export declare const RetrieveAndGenerateType: {
|
|
2074
|
+
readonly EXTERNAL_SOURCES: "EXTERNAL_SOURCES";
|
|
1543
2075
|
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
1544
2076
|
};
|
|
1545
2077
|
/**
|
|
@@ -2057,6 +2589,11 @@ export interface RetrieveAndGenerateConfiguration {
|
|
|
2057
2589
|
* @public
|
|
2058
2590
|
*/
|
|
2059
2591
|
knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration;
|
|
2592
|
+
/**
|
|
2593
|
+
* <p>The configuration used with the external source wrapper object in the retrieveAndGenerate function.</p>
|
|
2594
|
+
* @public
|
|
2595
|
+
*/
|
|
2596
|
+
externalSourcesConfiguration?: ExternalSourcesRetrieveAndGenerateConfiguration;
|
|
2060
2597
|
}
|
|
2061
2598
|
/**
|
|
2062
2599
|
* @public
|
|
@@ -2091,6 +2628,18 @@ export declare const ActionGroupInvocationInputFilterSensitiveLog: (obj: ActionG
|
|
|
2091
2628
|
* @internal
|
|
2092
2629
|
*/
|
|
2093
2630
|
export declare const ActionGroupInvocationOutputFilterSensitiveLog: (obj: ActionGroupInvocationOutput) => any;
|
|
2631
|
+
/**
|
|
2632
|
+
* @internal
|
|
2633
|
+
*/
|
|
2634
|
+
export declare const ApiResultFilterSensitiveLog: (obj: ApiResult) => any;
|
|
2635
|
+
/**
|
|
2636
|
+
* @internal
|
|
2637
|
+
*/
|
|
2638
|
+
export declare const InvocationResultMemberFilterSensitiveLog: (obj: InvocationResultMember) => any;
|
|
2639
|
+
/**
|
|
2640
|
+
* @internal
|
|
2641
|
+
*/
|
|
2642
|
+
export declare const SessionStateFilterSensitiveLog: (obj: SessionState) => any;
|
|
2094
2643
|
/**
|
|
2095
2644
|
* @internal
|
|
2096
2645
|
*/
|
|
@@ -2127,6 +2676,18 @@ export declare const AttributionFilterSensitiveLog: (obj: Attribution) => any;
|
|
|
2127
2676
|
* @internal
|
|
2128
2677
|
*/
|
|
2129
2678
|
export declare const PayloadPartFilterSensitiveLog: (obj: PayloadPart) => any;
|
|
2679
|
+
/**
|
|
2680
|
+
* @internal
|
|
2681
|
+
*/
|
|
2682
|
+
export declare const ApiInvocationInputFilterSensitiveLog: (obj: ApiInvocationInput) => any;
|
|
2683
|
+
/**
|
|
2684
|
+
* @internal
|
|
2685
|
+
*/
|
|
2686
|
+
export declare const InvocationInputMemberFilterSensitiveLog: (obj: InvocationInputMember) => any;
|
|
2687
|
+
/**
|
|
2688
|
+
* @internal
|
|
2689
|
+
*/
|
|
2690
|
+
export declare const ReturnControlPayloadFilterSensitiveLog: (obj: ReturnControlPayload) => any;
|
|
2130
2691
|
/**
|
|
2131
2692
|
* @internal
|
|
2132
2693
|
*/
|
|
@@ -2215,6 +2776,22 @@ export declare const RetrieveAndGenerateInputFilterSensitiveLog: (obj: RetrieveA
|
|
|
2215
2776
|
* @internal
|
|
2216
2777
|
*/
|
|
2217
2778
|
export declare const PromptTemplateFilterSensitiveLog: (obj: PromptTemplate) => any;
|
|
2779
|
+
/**
|
|
2780
|
+
* @internal
|
|
2781
|
+
*/
|
|
2782
|
+
export declare const ExternalSourcesGenerationConfigurationFilterSensitiveLog: (obj: ExternalSourcesGenerationConfiguration) => any;
|
|
2783
|
+
/**
|
|
2784
|
+
* @internal
|
|
2785
|
+
*/
|
|
2786
|
+
export declare const ByteContentDocFilterSensitiveLog: (obj: ByteContentDoc) => any;
|
|
2787
|
+
/**
|
|
2788
|
+
* @internal
|
|
2789
|
+
*/
|
|
2790
|
+
export declare const ExternalSourceFilterSensitiveLog: (obj: ExternalSource) => any;
|
|
2791
|
+
/**
|
|
2792
|
+
* @internal
|
|
2793
|
+
*/
|
|
2794
|
+
export declare const ExternalSourcesRetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: ExternalSourcesRetrieveAndGenerateConfiguration) => any;
|
|
2218
2795
|
/**
|
|
2219
2796
|
* @internal
|
|
2220
2797
|
*/
|