@aws-sdk/client-bedrock-agent-runtime 3.703.0 → 3.705.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 +267 -69
- package/dist-es/models/models_0.js +173 -56
- package/dist-es/protocols/Aws_restJson1.js +46 -3
- package/dist-types/commands/InvokeAgentCommand.d.ts +351 -20
- package/dist-types/commands/InvokeInlineAgentCommand.d.ts +331 -19
- package/dist-types/models/models_0.d.ts +903 -466
- package/dist-types/ts3.4/models/models_0.d.ts +321 -122
- package/package.json +1 -1
|
@@ -453,6 +453,562 @@ export interface AgentActionGroup {
|
|
|
453
453
|
*/
|
|
454
454
|
functionSchema?: FunctionSchema | undefined;
|
|
455
455
|
}
|
|
456
|
+
/**
|
|
457
|
+
* @public
|
|
458
|
+
* @enum
|
|
459
|
+
*/
|
|
460
|
+
export declare const ConfirmationState: {
|
|
461
|
+
readonly CONFIRM: "CONFIRM";
|
|
462
|
+
readonly DENY: "DENY";
|
|
463
|
+
};
|
|
464
|
+
/**
|
|
465
|
+
* @public
|
|
466
|
+
*/
|
|
467
|
+
export type ConfirmationState = (typeof ConfirmationState)[keyof typeof ConfirmationState];
|
|
468
|
+
/**
|
|
469
|
+
* <p>Contains the body of the API response.</p>
|
|
470
|
+
* <p>This data type is used in the following API operations:</p>
|
|
471
|
+
* <ul>
|
|
472
|
+
* <li>
|
|
473
|
+
* <p>In the <code>returnControlInvocationResults</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
|
|
474
|
+
* </p>
|
|
475
|
+
* </li>
|
|
476
|
+
* </ul>
|
|
477
|
+
* @public
|
|
478
|
+
*/
|
|
479
|
+
export interface ContentBody {
|
|
480
|
+
/**
|
|
481
|
+
* <p>The body of the API response.</p>
|
|
482
|
+
* @public
|
|
483
|
+
*/
|
|
484
|
+
body?: string | undefined;
|
|
485
|
+
}
|
|
486
|
+
/**
|
|
487
|
+
* @public
|
|
488
|
+
* @enum
|
|
489
|
+
*/
|
|
490
|
+
export declare const ResponseState: {
|
|
491
|
+
readonly FAILURE: "FAILURE";
|
|
492
|
+
readonly REPROMPT: "REPROMPT";
|
|
493
|
+
};
|
|
494
|
+
/**
|
|
495
|
+
* @public
|
|
496
|
+
*/
|
|
497
|
+
export type ResponseState = (typeof ResponseState)[keyof typeof ResponseState];
|
|
498
|
+
/**
|
|
499
|
+
* <p>Contains information about the API operation that was called from the action group and the response body that was returned.</p>
|
|
500
|
+
* <p>This data type is used in the following API operations:</p>
|
|
501
|
+
* <ul>
|
|
502
|
+
* <li>
|
|
503
|
+
* <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
|
|
504
|
+
* </p>
|
|
505
|
+
* </li>
|
|
506
|
+
* </ul>
|
|
507
|
+
* @public
|
|
508
|
+
*/
|
|
509
|
+
export interface ApiResult {
|
|
510
|
+
/**
|
|
511
|
+
* <p>The action group that the API operation belongs to.</p>
|
|
512
|
+
* @public
|
|
513
|
+
*/
|
|
514
|
+
actionGroup: string | undefined;
|
|
515
|
+
/**
|
|
516
|
+
* <p>The HTTP method for the API operation.</p>
|
|
517
|
+
* @public
|
|
518
|
+
*/
|
|
519
|
+
httpMethod?: string | undefined;
|
|
520
|
+
/**
|
|
521
|
+
* <p>The path to the API operation.</p>
|
|
522
|
+
* @public
|
|
523
|
+
*/
|
|
524
|
+
apiPath?: string | undefined;
|
|
525
|
+
/**
|
|
526
|
+
* <p>Controls the API operations or functions to invoke based on the user confirmation.</p>
|
|
527
|
+
* @public
|
|
528
|
+
*/
|
|
529
|
+
confirmationState?: ConfirmationState | undefined;
|
|
530
|
+
/**
|
|
531
|
+
* <p>The response body from the API operation. The key of the object is the content type (currently, only <code>TEXT</code> is supported). The response may be returned directly or from the Lambda function.</p>
|
|
532
|
+
* @public
|
|
533
|
+
*/
|
|
534
|
+
responseBody?: Record<string, ContentBody> | undefined;
|
|
535
|
+
/**
|
|
536
|
+
* <p>http status code from API execution response (for example: 200, 400, 500).</p>
|
|
537
|
+
* @public
|
|
538
|
+
*/
|
|
539
|
+
httpStatusCode?: number | undefined;
|
|
540
|
+
/**
|
|
541
|
+
* <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>
|
|
542
|
+
* @public
|
|
543
|
+
*/
|
|
544
|
+
responseState?: ResponseState | undefined;
|
|
545
|
+
/**
|
|
546
|
+
* <p>The agent's ID.</p>
|
|
547
|
+
* @public
|
|
548
|
+
*/
|
|
549
|
+
agentId?: string | undefined;
|
|
550
|
+
}
|
|
551
|
+
/**
|
|
552
|
+
* <p>Contains information about the function that was called from the action group and the response that was returned.</p>
|
|
553
|
+
* <p>This data type is used in the following API operations:</p>
|
|
554
|
+
* <ul>
|
|
555
|
+
* <li>
|
|
556
|
+
* <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
|
|
557
|
+
* </p>
|
|
558
|
+
* </li>
|
|
559
|
+
* </ul>
|
|
560
|
+
* @public
|
|
561
|
+
*/
|
|
562
|
+
export interface FunctionResult {
|
|
563
|
+
/**
|
|
564
|
+
* <p>The action group that the function belongs to.</p>
|
|
565
|
+
* @public
|
|
566
|
+
*/
|
|
567
|
+
actionGroup: string | undefined;
|
|
568
|
+
/**
|
|
569
|
+
* <p>Contains the user confirmation information about the function that was called.</p>
|
|
570
|
+
* @public
|
|
571
|
+
*/
|
|
572
|
+
confirmationState?: ConfirmationState | undefined;
|
|
573
|
+
/**
|
|
574
|
+
* <p>The name of the function that was called.</p>
|
|
575
|
+
* @public
|
|
576
|
+
*/
|
|
577
|
+
function?: string | undefined;
|
|
578
|
+
/**
|
|
579
|
+
* <p>The response from the function call using the parameters. The key of the object is the content type (currently, only <code>TEXT</code> is supported). The response may be returned directly or from the Lambda function.</p>
|
|
580
|
+
* @public
|
|
581
|
+
*/
|
|
582
|
+
responseBody?: Record<string, ContentBody> | undefined;
|
|
583
|
+
/**
|
|
584
|
+
* <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>
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
responseState?: ResponseState | undefined;
|
|
588
|
+
/**
|
|
589
|
+
* <p>The agent's ID.</p>
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
agentId?: string | undefined;
|
|
593
|
+
}
|
|
594
|
+
/**
|
|
595
|
+
* <p>A result from the invocation of an action. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
596
|
+
* <p>This data type is used in the following API operations:</p>
|
|
597
|
+
* <ul>
|
|
598
|
+
* <li>
|
|
599
|
+
* <p>
|
|
600
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
|
|
601
|
+
* </p>
|
|
602
|
+
* </li>
|
|
603
|
+
* </ul>
|
|
604
|
+
* @public
|
|
605
|
+
*/
|
|
606
|
+
export type InvocationResultMember = InvocationResultMember.ApiResultMember | InvocationResultMember.FunctionResultMember | InvocationResultMember.$UnknownMember;
|
|
607
|
+
/**
|
|
608
|
+
* @public
|
|
609
|
+
*/
|
|
610
|
+
export declare namespace InvocationResultMember {
|
|
611
|
+
/**
|
|
612
|
+
* <p>The result from the API response from the action group invocation.</p>
|
|
613
|
+
* @public
|
|
614
|
+
*/
|
|
615
|
+
interface ApiResultMember {
|
|
616
|
+
apiResult: ApiResult;
|
|
617
|
+
functionResult?: never;
|
|
618
|
+
$unknown?: never;
|
|
619
|
+
}
|
|
620
|
+
/**
|
|
621
|
+
* <p>The result from the function from the action group invocation.</p>
|
|
622
|
+
* @public
|
|
623
|
+
*/
|
|
624
|
+
interface FunctionResultMember {
|
|
625
|
+
apiResult?: never;
|
|
626
|
+
functionResult: FunctionResult;
|
|
627
|
+
$unknown?: never;
|
|
628
|
+
}
|
|
629
|
+
/**
|
|
630
|
+
* @public
|
|
631
|
+
*/
|
|
632
|
+
interface $UnknownMember {
|
|
633
|
+
apiResult?: never;
|
|
634
|
+
functionResult?: never;
|
|
635
|
+
$unknown: [string, any];
|
|
636
|
+
}
|
|
637
|
+
interface Visitor<T> {
|
|
638
|
+
apiResult: (value: ApiResult) => T;
|
|
639
|
+
functionResult: (value: FunctionResult) => T;
|
|
640
|
+
_: (name: string, value: any) => T;
|
|
641
|
+
}
|
|
642
|
+
const visit: <T>(value: InvocationResultMember, visitor: Visitor<T>) => T;
|
|
643
|
+
}
|
|
644
|
+
/**
|
|
645
|
+
* <p>An action invocation result.</p>
|
|
646
|
+
* @public
|
|
647
|
+
*/
|
|
648
|
+
export interface ReturnControlResults {
|
|
649
|
+
/**
|
|
650
|
+
* <p>The action's invocation ID.</p>
|
|
651
|
+
* @public
|
|
652
|
+
*/
|
|
653
|
+
invocationId?: string | undefined;
|
|
654
|
+
/**
|
|
655
|
+
* <p>The action invocation result.</p>
|
|
656
|
+
* @public
|
|
657
|
+
*/
|
|
658
|
+
returnControlInvocationResults?: InvocationResultMember[] | undefined;
|
|
659
|
+
}
|
|
660
|
+
/**
|
|
661
|
+
* @public
|
|
662
|
+
* @enum
|
|
663
|
+
*/
|
|
664
|
+
export declare const PayloadType: {
|
|
665
|
+
readonly RETURN_CONTROL: "RETURN_CONTROL";
|
|
666
|
+
readonly TEXT: "TEXT";
|
|
667
|
+
};
|
|
668
|
+
/**
|
|
669
|
+
* @public
|
|
670
|
+
*/
|
|
671
|
+
export type PayloadType = (typeof PayloadType)[keyof typeof PayloadType];
|
|
672
|
+
/**
|
|
673
|
+
* <p>Input for an agent collaborator. The input can be text or an action invocation result.</p>
|
|
674
|
+
* @public
|
|
675
|
+
*/
|
|
676
|
+
export interface AgentCollaboratorInputPayload {
|
|
677
|
+
/**
|
|
678
|
+
* <p>The input type.</p>
|
|
679
|
+
* @public
|
|
680
|
+
*/
|
|
681
|
+
type?: PayloadType | undefined;
|
|
682
|
+
/**
|
|
683
|
+
* <p>Input text.</p>
|
|
684
|
+
* @public
|
|
685
|
+
*/
|
|
686
|
+
text?: string | undefined;
|
|
687
|
+
/**
|
|
688
|
+
* <p>An action invocation result.</p>
|
|
689
|
+
* @public
|
|
690
|
+
*/
|
|
691
|
+
returnControlResults?: ReturnControlResults | undefined;
|
|
692
|
+
}
|
|
693
|
+
/**
|
|
694
|
+
* <p>An agent collaborator invocation input.</p>
|
|
695
|
+
* @public
|
|
696
|
+
*/
|
|
697
|
+
export interface AgentCollaboratorInvocationInput {
|
|
698
|
+
/**
|
|
699
|
+
* <p>The collaborator's name.</p>
|
|
700
|
+
* @public
|
|
701
|
+
*/
|
|
702
|
+
agentCollaboratorName?: string | undefined;
|
|
703
|
+
/**
|
|
704
|
+
* <p>The collaborator's alias ARN.</p>
|
|
705
|
+
* @public
|
|
706
|
+
*/
|
|
707
|
+
agentCollaboratorAliasArn?: string | undefined;
|
|
708
|
+
/**
|
|
709
|
+
* <p>Text or action invocation result input for the collaborator.</p>
|
|
710
|
+
* @public
|
|
711
|
+
*/
|
|
712
|
+
input?: AgentCollaboratorInputPayload | undefined;
|
|
713
|
+
}
|
|
714
|
+
/**
|
|
715
|
+
* <p>Information about a parameter to provide to the API request.</p>
|
|
716
|
+
* <p>This data type is used in the following API operations:</p>
|
|
717
|
+
* <ul>
|
|
718
|
+
* <li>
|
|
719
|
+
* <p>
|
|
720
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
721
|
+
* </p>
|
|
722
|
+
* </li>
|
|
723
|
+
* </ul>
|
|
724
|
+
* @public
|
|
725
|
+
*/
|
|
726
|
+
export interface ApiParameter {
|
|
727
|
+
/**
|
|
728
|
+
* <p>The name of the parameter.</p>
|
|
729
|
+
* @public
|
|
730
|
+
*/
|
|
731
|
+
name?: string | undefined;
|
|
732
|
+
/**
|
|
733
|
+
* <p>The data type for the parameter.</p>
|
|
734
|
+
* @public
|
|
735
|
+
*/
|
|
736
|
+
type?: string | undefined;
|
|
737
|
+
/**
|
|
738
|
+
* <p>The value of the parameter.</p>
|
|
739
|
+
* @public
|
|
740
|
+
*/
|
|
741
|
+
value?: string | undefined;
|
|
742
|
+
}
|
|
743
|
+
/**
|
|
744
|
+
* <p>Contains the parameters in the request body.</p>
|
|
745
|
+
* @public
|
|
746
|
+
*/
|
|
747
|
+
export interface PropertyParameters {
|
|
748
|
+
/**
|
|
749
|
+
* <p>A list of parameters in the request body.</p>
|
|
750
|
+
* @public
|
|
751
|
+
*/
|
|
752
|
+
properties?: Parameter[] | undefined;
|
|
753
|
+
}
|
|
754
|
+
/**
|
|
755
|
+
* <p>The request body to provide for the API request, as the agent elicited from the user.</p>
|
|
756
|
+
* <p>This data type is used in the following API operations:</p>
|
|
757
|
+
* <ul>
|
|
758
|
+
* <li>
|
|
759
|
+
* <p>
|
|
760
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
761
|
+
* </p>
|
|
762
|
+
* </li>
|
|
763
|
+
* </ul>
|
|
764
|
+
* @public
|
|
765
|
+
*/
|
|
766
|
+
export interface ApiRequestBody {
|
|
767
|
+
/**
|
|
768
|
+
* <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>
|
|
769
|
+
* @public
|
|
770
|
+
*/
|
|
771
|
+
content?: Record<string, PropertyParameters> | undefined;
|
|
772
|
+
}
|
|
773
|
+
/**
|
|
774
|
+
* <p>Contains information about the API operation that the agent predicts should be called.</p>
|
|
775
|
+
* <p>This data type is used in the following API operations:</p>
|
|
776
|
+
* <ul>
|
|
777
|
+
* <li>
|
|
778
|
+
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
779
|
+
* </p>
|
|
780
|
+
* </li>
|
|
781
|
+
* </ul>
|
|
782
|
+
* @public
|
|
783
|
+
*/
|
|
784
|
+
export interface ApiInvocationInput {
|
|
785
|
+
/**
|
|
786
|
+
* <p>The action group that the API operation belongs to.</p>
|
|
787
|
+
* @public
|
|
788
|
+
*/
|
|
789
|
+
actionGroup: string | undefined;
|
|
790
|
+
/**
|
|
791
|
+
* <p>The HTTP method of the API operation.</p>
|
|
792
|
+
* @public
|
|
793
|
+
*/
|
|
794
|
+
httpMethod?: string | undefined;
|
|
795
|
+
/**
|
|
796
|
+
* <p>The path to the API operation.</p>
|
|
797
|
+
* @public
|
|
798
|
+
*/
|
|
799
|
+
apiPath?: string | undefined;
|
|
800
|
+
/**
|
|
801
|
+
* <p>The parameters to provide for the API request, as the agent elicited from the user.</p>
|
|
802
|
+
* @public
|
|
803
|
+
*/
|
|
804
|
+
parameters?: ApiParameter[] | undefined;
|
|
805
|
+
/**
|
|
806
|
+
* <p>The request body to provide for the API request, as the agent elicited from the user.</p>
|
|
807
|
+
* @public
|
|
808
|
+
*/
|
|
809
|
+
requestBody?: ApiRequestBody | undefined;
|
|
810
|
+
/**
|
|
811
|
+
* <p>Contains information about the API operation to invoke.</p>
|
|
812
|
+
* @public
|
|
813
|
+
*/
|
|
814
|
+
actionInvocationType?: ActionInvocationType | undefined;
|
|
815
|
+
/**
|
|
816
|
+
* <p>The agent's ID.</p>
|
|
817
|
+
* @public
|
|
818
|
+
*/
|
|
819
|
+
agentId?: string | undefined;
|
|
820
|
+
/**
|
|
821
|
+
* <p>The agent collaborator's name.</p>
|
|
822
|
+
* @public
|
|
823
|
+
*/
|
|
824
|
+
collaboratorName?: string | undefined;
|
|
825
|
+
}
|
|
826
|
+
/**
|
|
827
|
+
* <p>Contains information about a parameter of the function.</p>
|
|
828
|
+
* <p>This data type is used in the following API operations:</p>
|
|
829
|
+
* <ul>
|
|
830
|
+
* <li>
|
|
831
|
+
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
832
|
+
* </p>
|
|
833
|
+
* </li>
|
|
834
|
+
* </ul>
|
|
835
|
+
* @public
|
|
836
|
+
*/
|
|
837
|
+
export interface FunctionParameter {
|
|
838
|
+
/**
|
|
839
|
+
* <p>The name of the parameter.</p>
|
|
840
|
+
* @public
|
|
841
|
+
*/
|
|
842
|
+
name?: string | undefined;
|
|
843
|
+
/**
|
|
844
|
+
* <p>The data type of the parameter.</p>
|
|
845
|
+
* @public
|
|
846
|
+
*/
|
|
847
|
+
type?: string | undefined;
|
|
848
|
+
/**
|
|
849
|
+
* <p>The value of the parameter.</p>
|
|
850
|
+
* @public
|
|
851
|
+
*/
|
|
852
|
+
value?: string | undefined;
|
|
853
|
+
}
|
|
854
|
+
/**
|
|
855
|
+
* <p>Contains information about the function that the agent predicts should be called.</p>
|
|
856
|
+
* <p>This data type is used in the following API operations:</p>
|
|
857
|
+
* <ul>
|
|
858
|
+
* <li>
|
|
859
|
+
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
860
|
+
* </p>
|
|
861
|
+
* </li>
|
|
862
|
+
* </ul>
|
|
863
|
+
* @public
|
|
864
|
+
*/
|
|
865
|
+
export interface FunctionInvocationInput {
|
|
866
|
+
/**
|
|
867
|
+
* <p>The action group that the function belongs to.</p>
|
|
868
|
+
* @public
|
|
869
|
+
*/
|
|
870
|
+
actionGroup: string | undefined;
|
|
871
|
+
/**
|
|
872
|
+
* <p>A list of parameters of the function.</p>
|
|
873
|
+
* @public
|
|
874
|
+
*/
|
|
875
|
+
parameters?: FunctionParameter[] | undefined;
|
|
876
|
+
/**
|
|
877
|
+
* <p>The name of the function.</p>
|
|
878
|
+
* @public
|
|
879
|
+
*/
|
|
880
|
+
function?: string | undefined;
|
|
881
|
+
/**
|
|
882
|
+
* <p>Contains information about the function to invoke,</p>
|
|
883
|
+
* @public
|
|
884
|
+
*/
|
|
885
|
+
actionInvocationType?: ActionInvocationType | undefined;
|
|
886
|
+
/**
|
|
887
|
+
* <p>The agent's ID.</p>
|
|
888
|
+
* @public
|
|
889
|
+
*/
|
|
890
|
+
agentId?: string | undefined;
|
|
891
|
+
/**
|
|
892
|
+
* <p>The collaborator's name.</p>
|
|
893
|
+
* @public
|
|
894
|
+
*/
|
|
895
|
+
collaboratorName?: string | undefined;
|
|
896
|
+
}
|
|
897
|
+
/**
|
|
898
|
+
* <p>Contains details about the API operation or function that the agent predicts should be called. </p>
|
|
899
|
+
* <p>This data type is used in the following API operations:</p>
|
|
900
|
+
* <ul>
|
|
901
|
+
* <li>
|
|
902
|
+
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
903
|
+
* </p>
|
|
904
|
+
* </li>
|
|
905
|
+
* </ul>
|
|
906
|
+
* @public
|
|
907
|
+
*/
|
|
908
|
+
export type InvocationInputMember = InvocationInputMember.ApiInvocationInputMember | InvocationInputMember.FunctionInvocationInputMember | InvocationInputMember.$UnknownMember;
|
|
909
|
+
/**
|
|
910
|
+
* @public
|
|
911
|
+
*/
|
|
912
|
+
export declare namespace InvocationInputMember {
|
|
913
|
+
/**
|
|
914
|
+
* <p>Contains information about the API operation that the agent predicts should be called.</p>
|
|
915
|
+
* @public
|
|
916
|
+
*/
|
|
917
|
+
interface ApiInvocationInputMember {
|
|
918
|
+
apiInvocationInput: ApiInvocationInput;
|
|
919
|
+
functionInvocationInput?: never;
|
|
920
|
+
$unknown?: never;
|
|
921
|
+
}
|
|
922
|
+
/**
|
|
923
|
+
* <p>Contains information about the function that the agent predicts should be called.</p>
|
|
924
|
+
* @public
|
|
925
|
+
*/
|
|
926
|
+
interface FunctionInvocationInputMember {
|
|
927
|
+
apiInvocationInput?: never;
|
|
928
|
+
functionInvocationInput: FunctionInvocationInput;
|
|
929
|
+
$unknown?: never;
|
|
930
|
+
}
|
|
931
|
+
/**
|
|
932
|
+
* @public
|
|
933
|
+
*/
|
|
934
|
+
interface $UnknownMember {
|
|
935
|
+
apiInvocationInput?: never;
|
|
936
|
+
functionInvocationInput?: never;
|
|
937
|
+
$unknown: [string, any];
|
|
938
|
+
}
|
|
939
|
+
interface Visitor<T> {
|
|
940
|
+
apiInvocationInput: (value: ApiInvocationInput) => T;
|
|
941
|
+
functionInvocationInput: (value: FunctionInvocationInput) => T;
|
|
942
|
+
_: (name: string, value: any) => T;
|
|
943
|
+
}
|
|
944
|
+
const visit: <T>(value: InvocationInputMember, visitor: Visitor<T>) => T;
|
|
945
|
+
}
|
|
946
|
+
/**
|
|
947
|
+
* <p>Contains information to return from the action group that the agent has predicted to invoke.</p>
|
|
948
|
+
* <p>This data type is used in the following API operations:</p>
|
|
949
|
+
* <ul>
|
|
950
|
+
* <li>
|
|
951
|
+
* <p>
|
|
952
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
953
|
+
* </p>
|
|
954
|
+
* </li>
|
|
955
|
+
* </ul>
|
|
956
|
+
* @public
|
|
957
|
+
*/
|
|
958
|
+
export interface ReturnControlPayload {
|
|
959
|
+
/**
|
|
960
|
+
* <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>
|
|
961
|
+
* @public
|
|
962
|
+
*/
|
|
963
|
+
invocationInputs?: InvocationInputMember[] | undefined;
|
|
964
|
+
/**
|
|
965
|
+
* <p>The identifier of the action group invocation.</p>
|
|
966
|
+
* @public
|
|
967
|
+
*/
|
|
968
|
+
invocationId?: string | undefined;
|
|
969
|
+
}
|
|
970
|
+
/**
|
|
971
|
+
* <p>Output from an agent collaborator. The output can be text or an action invocation result.</p>
|
|
972
|
+
* @public
|
|
973
|
+
*/
|
|
974
|
+
export interface AgentCollaboratorOutputPayload {
|
|
975
|
+
/**
|
|
976
|
+
* <p>The type of output.</p>
|
|
977
|
+
* @public
|
|
978
|
+
*/
|
|
979
|
+
type?: PayloadType | undefined;
|
|
980
|
+
/**
|
|
981
|
+
* <p>Text output.</p>
|
|
982
|
+
* @public
|
|
983
|
+
*/
|
|
984
|
+
text?: string | undefined;
|
|
985
|
+
/**
|
|
986
|
+
* <p>An action invocation result.</p>
|
|
987
|
+
* @public
|
|
988
|
+
*/
|
|
989
|
+
returnControlPayload?: ReturnControlPayload | undefined;
|
|
990
|
+
}
|
|
991
|
+
/**
|
|
992
|
+
* <p>Output from an agent collaborator.</p>
|
|
993
|
+
* @public
|
|
994
|
+
*/
|
|
995
|
+
export interface AgentCollaboratorInvocationOutput {
|
|
996
|
+
/**
|
|
997
|
+
* <p>The output's agent collaborator name.</p>
|
|
998
|
+
* @public
|
|
999
|
+
*/
|
|
1000
|
+
agentCollaboratorName?: string | undefined;
|
|
1001
|
+
/**
|
|
1002
|
+
* <p>The output's agent collaborator alias ARN.</p>
|
|
1003
|
+
* @public
|
|
1004
|
+
*/
|
|
1005
|
+
agentCollaboratorAliasArn?: string | undefined;
|
|
1006
|
+
/**
|
|
1007
|
+
* <p>The output's output.</p>
|
|
1008
|
+
* @public
|
|
1009
|
+
*/
|
|
1010
|
+
output?: AgentCollaboratorOutputPayload | undefined;
|
|
1011
|
+
}
|
|
456
1012
|
/**
|
|
457
1013
|
* <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
|
|
458
1014
|
* @public
|
|
@@ -1240,6 +1796,75 @@ export interface InvokeFlowResponse {
|
|
|
1240
1796
|
*/
|
|
1241
1797
|
responseStream: AsyncIterable<FlowResponseStream> | undefined;
|
|
1242
1798
|
}
|
|
1799
|
+
/**
|
|
1800
|
+
* <p>A content block.</p>
|
|
1801
|
+
* @public
|
|
1802
|
+
*/
|
|
1803
|
+
export type ContentBlock = ContentBlock.TextMember | ContentBlock.$UnknownMember;
|
|
1804
|
+
/**
|
|
1805
|
+
* @public
|
|
1806
|
+
*/
|
|
1807
|
+
export declare namespace ContentBlock {
|
|
1808
|
+
/**
|
|
1809
|
+
* <p>The block's text.</p>
|
|
1810
|
+
* @public
|
|
1811
|
+
*/
|
|
1812
|
+
interface TextMember {
|
|
1813
|
+
text: string;
|
|
1814
|
+
$unknown?: never;
|
|
1815
|
+
}
|
|
1816
|
+
/**
|
|
1817
|
+
* @public
|
|
1818
|
+
*/
|
|
1819
|
+
interface $UnknownMember {
|
|
1820
|
+
text?: never;
|
|
1821
|
+
$unknown: [string, any];
|
|
1822
|
+
}
|
|
1823
|
+
interface Visitor<T> {
|
|
1824
|
+
text: (value: string) => T;
|
|
1825
|
+
_: (name: string, value: any) => T;
|
|
1826
|
+
}
|
|
1827
|
+
const visit: <T>(value: ContentBlock, visitor: Visitor<T>) => T;
|
|
1828
|
+
}
|
|
1829
|
+
/**
|
|
1830
|
+
* @public
|
|
1831
|
+
* @enum
|
|
1832
|
+
*/
|
|
1833
|
+
export declare const ConversationRole: {
|
|
1834
|
+
readonly ASSISTANT: "assistant";
|
|
1835
|
+
readonly USER: "user";
|
|
1836
|
+
};
|
|
1837
|
+
/**
|
|
1838
|
+
* @public
|
|
1839
|
+
*/
|
|
1840
|
+
export type ConversationRole = (typeof ConversationRole)[keyof typeof ConversationRole];
|
|
1841
|
+
/**
|
|
1842
|
+
* <p>Details about a message.</p>
|
|
1843
|
+
* @public
|
|
1844
|
+
*/
|
|
1845
|
+
export interface Message {
|
|
1846
|
+
/**
|
|
1847
|
+
* <p>The message's role.</p>
|
|
1848
|
+
* @public
|
|
1849
|
+
*/
|
|
1850
|
+
role: ConversationRole | undefined;
|
|
1851
|
+
/**
|
|
1852
|
+
* <p>The message's content.</p>
|
|
1853
|
+
* @public
|
|
1854
|
+
*/
|
|
1855
|
+
content: ContentBlock[] | undefined;
|
|
1856
|
+
}
|
|
1857
|
+
/**
|
|
1858
|
+
* <p>A conversation history.</p>
|
|
1859
|
+
* @public
|
|
1860
|
+
*/
|
|
1861
|
+
export interface ConversationHistory {
|
|
1862
|
+
/**
|
|
1863
|
+
* <p>The conversation's messages.</p>
|
|
1864
|
+
* @public
|
|
1865
|
+
*/
|
|
1866
|
+
messages?: Message[] | undefined;
|
|
1867
|
+
}
|
|
1243
1868
|
/**
|
|
1244
1869
|
* <p>The property contains the file to chat with, along with its attributes.</p>
|
|
1245
1870
|
* @public
|
|
@@ -1496,252 +2121,74 @@ export interface MetadataConfigurationForReranking {
|
|
|
1496
2121
|
*/
|
|
1497
2122
|
selectionMode: RerankingMetadataSelectionMode | undefined;
|
|
1498
2123
|
/**
|
|
1499
|
-
* <p>Contains configurations for the metadata fields to include or exclude when considering reranking.</p>
|
|
1500
|
-
* @public
|
|
1501
|
-
*/
|
|
1502
|
-
selectiveModeConfiguration?: RerankingMetadataSelectiveModeConfiguration | undefined;
|
|
1503
|
-
}
|
|
1504
|
-
/**
|
|
1505
|
-
* <p>Contains configurations for an Amazon Bedrock reranker model.</p>
|
|
1506
|
-
* @public
|
|
1507
|
-
*/
|
|
1508
|
-
export interface VectorSearchBedrockRerankingModelConfiguration {
|
|
1509
|
-
/**
|
|
1510
|
-
* <p>The ARN of the reranker model to use.</p>
|
|
1511
|
-
* @public
|
|
1512
|
-
*/
|
|
1513
|
-
modelArn: string | undefined;
|
|
1514
|
-
/**
|
|
1515
|
-
* <p>A JSON object whose keys are request fields for the model and whose values are values for those fields.</p>
|
|
1516
|
-
* @public
|
|
1517
|
-
*/
|
|
1518
|
-
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
1519
|
-
}
|
|
1520
|
-
/**
|
|
1521
|
-
* <p>Contains configurations for reranking with an Amazon Bedrock reranker model.</p>
|
|
1522
|
-
* @public
|
|
1523
|
-
*/
|
|
1524
|
-
export interface VectorSearchBedrockRerankingConfiguration {
|
|
1525
|
-
/**
|
|
1526
|
-
* <p>Contains configurations for the reranker model.</p>
|
|
1527
|
-
* @public
|
|
1528
|
-
*/
|
|
1529
|
-
modelConfiguration: VectorSearchBedrockRerankingModelConfiguration | undefined;
|
|
1530
|
-
/**
|
|
1531
|
-
* <p>The number of results to return after reranking.</p>
|
|
1532
|
-
* @public
|
|
1533
|
-
*/
|
|
1534
|
-
numberOfRerankedResults?: number | undefined;
|
|
1535
|
-
/**
|
|
1536
|
-
* <p>Contains configurations for the metadata to use in reranking.</p>
|
|
1537
|
-
* @public
|
|
1538
|
-
*/
|
|
1539
|
-
metadataConfiguration?: MetadataConfigurationForReranking | undefined;
|
|
1540
|
-
}
|
|
1541
|
-
/**
|
|
1542
|
-
* @public
|
|
1543
|
-
* @enum
|
|
1544
|
-
*/
|
|
1545
|
-
export declare const VectorSearchRerankingConfigurationType: {
|
|
1546
|
-
readonly BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL";
|
|
1547
|
-
};
|
|
1548
|
-
/**
|
|
1549
|
-
* @public
|
|
1550
|
-
*/
|
|
1551
|
-
export type VectorSearchRerankingConfigurationType = (typeof VectorSearchRerankingConfigurationType)[keyof typeof VectorSearchRerankingConfigurationType];
|
|
1552
|
-
/**
|
|
1553
|
-
* <p>Contains configurations for reranking the retrieved results.</p>
|
|
1554
|
-
* @public
|
|
1555
|
-
*/
|
|
1556
|
-
export interface VectorSearchRerankingConfiguration {
|
|
1557
|
-
/**
|
|
1558
|
-
* <p>The type of reranker model.</p>
|
|
1559
|
-
* @public
|
|
1560
|
-
*/
|
|
1561
|
-
type: VectorSearchRerankingConfigurationType | undefined;
|
|
1562
|
-
/**
|
|
1563
|
-
* <p>Contains configurations for an Amazon Bedrock reranker model.</p>
|
|
1564
|
-
* @public
|
|
1565
|
-
*/
|
|
1566
|
-
bedrockRerankingConfiguration?: VectorSearchBedrockRerankingConfiguration | undefined;
|
|
1567
|
-
}
|
|
1568
|
-
/**
|
|
1569
|
-
* @public
|
|
1570
|
-
* @enum
|
|
1571
|
-
*/
|
|
1572
|
-
export declare const ConfirmationState: {
|
|
1573
|
-
readonly CONFIRM: "CONFIRM";
|
|
1574
|
-
readonly DENY: "DENY";
|
|
1575
|
-
};
|
|
1576
|
-
/**
|
|
1577
|
-
* @public
|
|
1578
|
-
*/
|
|
1579
|
-
export type ConfirmationState = (typeof ConfirmationState)[keyof typeof ConfirmationState];
|
|
1580
|
-
/**
|
|
1581
|
-
* <p>Contains the body of the API response.</p>
|
|
1582
|
-
* <p>This data type is used in the following API operations:</p>
|
|
1583
|
-
* <ul>
|
|
1584
|
-
* <li>
|
|
1585
|
-
* <p>In the <code>returnControlInvocationResults</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
|
|
1586
|
-
* </p>
|
|
1587
|
-
* </li>
|
|
1588
|
-
* </ul>
|
|
1589
|
-
* @public
|
|
1590
|
-
*/
|
|
1591
|
-
export interface ContentBody {
|
|
1592
|
-
/**
|
|
1593
|
-
* <p>The body of the API response.</p>
|
|
1594
|
-
* @public
|
|
1595
|
-
*/
|
|
1596
|
-
body?: string | undefined;
|
|
1597
|
-
}
|
|
1598
|
-
/**
|
|
1599
|
-
* @public
|
|
1600
|
-
* @enum
|
|
1601
|
-
*/
|
|
1602
|
-
export declare const ResponseState: {
|
|
1603
|
-
readonly FAILURE: "FAILURE";
|
|
1604
|
-
readonly REPROMPT: "REPROMPT";
|
|
1605
|
-
};
|
|
1606
|
-
/**
|
|
1607
|
-
* @public
|
|
1608
|
-
*/
|
|
1609
|
-
export type ResponseState = (typeof ResponseState)[keyof typeof ResponseState];
|
|
1610
|
-
/**
|
|
1611
|
-
* <p>Contains information about the API operation that was called from the action group and the response body that was returned.</p>
|
|
1612
|
-
* <p>This data type is used in the following API operations:</p>
|
|
1613
|
-
* <ul>
|
|
1614
|
-
* <li>
|
|
1615
|
-
* <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
|
|
1616
|
-
* </p>
|
|
1617
|
-
* </li>
|
|
1618
|
-
* </ul>
|
|
1619
|
-
* @public
|
|
1620
|
-
*/
|
|
1621
|
-
export interface ApiResult {
|
|
1622
|
-
/**
|
|
1623
|
-
* <p>The action group that the API operation belongs to.</p>
|
|
1624
|
-
* @public
|
|
1625
|
-
*/
|
|
1626
|
-
actionGroup: string | undefined;
|
|
1627
|
-
/**
|
|
1628
|
-
* <p>The HTTP method for the API operation.</p>
|
|
1629
|
-
* @public
|
|
1630
|
-
*/
|
|
1631
|
-
httpMethod?: string | undefined;
|
|
1632
|
-
/**
|
|
1633
|
-
* <p>The path to the API operation.</p>
|
|
1634
|
-
* @public
|
|
1635
|
-
*/
|
|
1636
|
-
apiPath?: string | undefined;
|
|
1637
|
-
/**
|
|
1638
|
-
* <p>Controls the API operations or functions to invoke based on the user confirmation.</p>
|
|
1639
|
-
* @public
|
|
1640
|
-
*/
|
|
1641
|
-
confirmationState?: ConfirmationState | undefined;
|
|
1642
|
-
/**
|
|
1643
|
-
* <p>The response body from the API operation. The key of the object is the content type (currently, only <code>TEXT</code> is supported). The response may be returned directly or from the Lambda function.</p>
|
|
1644
|
-
* @public
|
|
1645
|
-
*/
|
|
1646
|
-
responseBody?: Record<string, ContentBody> | undefined;
|
|
1647
|
-
/**
|
|
1648
|
-
* <p>http status code from API execution response (for example: 200, 400, 500).</p>
|
|
1649
|
-
* @public
|
|
1650
|
-
*/
|
|
1651
|
-
httpStatusCode?: number | undefined;
|
|
1652
|
-
/**
|
|
1653
|
-
* <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>
|
|
1654
|
-
* @public
|
|
1655
|
-
*/
|
|
1656
|
-
responseState?: ResponseState | undefined;
|
|
1657
|
-
}
|
|
1658
|
-
/**
|
|
1659
|
-
* <p>Contains information about the function that was called from the action group and the response that was returned.</p>
|
|
1660
|
-
* <p>This data type is used in the following API operations:</p>
|
|
1661
|
-
* <ul>
|
|
1662
|
-
* <li>
|
|
1663
|
-
* <p>In the <code>returnControlInvocationResults</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
|
|
1664
|
-
* </p>
|
|
1665
|
-
* </li>
|
|
1666
|
-
* </ul>
|
|
2124
|
+
* <p>Contains configurations for the metadata fields to include or exclude when considering reranking.</p>
|
|
2125
|
+
* @public
|
|
2126
|
+
*/
|
|
2127
|
+
selectiveModeConfiguration?: RerankingMetadataSelectiveModeConfiguration | undefined;
|
|
2128
|
+
}
|
|
2129
|
+
/**
|
|
2130
|
+
* <p>Contains configurations for an Amazon Bedrock reranker model.</p>
|
|
1667
2131
|
* @public
|
|
1668
2132
|
*/
|
|
1669
|
-
export interface
|
|
2133
|
+
export interface VectorSearchBedrockRerankingModelConfiguration {
|
|
1670
2134
|
/**
|
|
1671
|
-
* <p>The
|
|
2135
|
+
* <p>The ARN of the reranker model to use.</p>
|
|
1672
2136
|
* @public
|
|
1673
2137
|
*/
|
|
1674
|
-
|
|
2138
|
+
modelArn: string | undefined;
|
|
1675
2139
|
/**
|
|
1676
|
-
* <p>
|
|
2140
|
+
* <p>A JSON object whose keys are request fields for the model and whose values are values for those fields.</p>
|
|
1677
2141
|
* @public
|
|
1678
2142
|
*/
|
|
1679
|
-
|
|
2143
|
+
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
2144
|
+
}
|
|
2145
|
+
/**
|
|
2146
|
+
* <p>Contains configurations for reranking with an Amazon Bedrock reranker model.</p>
|
|
2147
|
+
* @public
|
|
2148
|
+
*/
|
|
2149
|
+
export interface VectorSearchBedrockRerankingConfiguration {
|
|
1680
2150
|
/**
|
|
1681
|
-
* <p>
|
|
2151
|
+
* <p>Contains configurations for the reranker model.</p>
|
|
1682
2152
|
* @public
|
|
1683
2153
|
*/
|
|
1684
|
-
|
|
2154
|
+
modelConfiguration: VectorSearchBedrockRerankingModelConfiguration | undefined;
|
|
1685
2155
|
/**
|
|
1686
|
-
* <p>The
|
|
2156
|
+
* <p>The number of results to return after reranking.</p>
|
|
1687
2157
|
* @public
|
|
1688
2158
|
*/
|
|
1689
|
-
|
|
2159
|
+
numberOfRerankedResults?: number | undefined;
|
|
1690
2160
|
/**
|
|
1691
|
-
* <p>
|
|
2161
|
+
* <p>Contains configurations for the metadata to use in reranking.</p>
|
|
1692
2162
|
* @public
|
|
1693
2163
|
*/
|
|
1694
|
-
|
|
2164
|
+
metadataConfiguration?: MetadataConfigurationForReranking | undefined;
|
|
1695
2165
|
}
|
|
1696
2166
|
/**
|
|
1697
|
-
* <p>A result from the invocation of an action. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
1698
|
-
* <p>This data type is used in the following API operations:</p>
|
|
1699
|
-
* <ul>
|
|
1700
|
-
* <li>
|
|
1701
|
-
* <p>
|
|
1702
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
|
|
1703
|
-
* </p>
|
|
1704
|
-
* </li>
|
|
1705
|
-
* </ul>
|
|
1706
2167
|
* @public
|
|
2168
|
+
* @enum
|
|
1707
2169
|
*/
|
|
1708
|
-
export
|
|
2170
|
+
export declare const VectorSearchRerankingConfigurationType: {
|
|
2171
|
+
readonly BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL";
|
|
2172
|
+
};
|
|
1709
2173
|
/**
|
|
1710
2174
|
* @public
|
|
1711
2175
|
*/
|
|
1712
|
-
export
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
apiResult: ApiResult;
|
|
1719
|
-
functionResult?: never;
|
|
1720
|
-
$unknown?: never;
|
|
1721
|
-
}
|
|
2176
|
+
export type VectorSearchRerankingConfigurationType = (typeof VectorSearchRerankingConfigurationType)[keyof typeof VectorSearchRerankingConfigurationType];
|
|
2177
|
+
/**
|
|
2178
|
+
* <p>Contains configurations for reranking the retrieved results.</p>
|
|
2179
|
+
* @public
|
|
2180
|
+
*/
|
|
2181
|
+
export interface VectorSearchRerankingConfiguration {
|
|
1722
2182
|
/**
|
|
1723
|
-
* <p>The
|
|
2183
|
+
* <p>The type of reranker model.</p>
|
|
1724
2184
|
* @public
|
|
1725
2185
|
*/
|
|
1726
|
-
|
|
1727
|
-
apiResult?: never;
|
|
1728
|
-
functionResult: FunctionResult;
|
|
1729
|
-
$unknown?: never;
|
|
1730
|
-
}
|
|
2186
|
+
type: VectorSearchRerankingConfigurationType | undefined;
|
|
1731
2187
|
/**
|
|
2188
|
+
* <p>Contains configurations for an Amazon Bedrock reranker model.</p>
|
|
1732
2189
|
* @public
|
|
1733
2190
|
*/
|
|
1734
|
-
|
|
1735
|
-
apiResult?: never;
|
|
1736
|
-
functionResult?: never;
|
|
1737
|
-
$unknown: [string, any];
|
|
1738
|
-
}
|
|
1739
|
-
interface Visitor<T> {
|
|
1740
|
-
apiResult: (value: ApiResult) => T;
|
|
1741
|
-
functionResult: (value: FunctionResult) => T;
|
|
1742
|
-
_: (name: string, value: any) => T;
|
|
1743
|
-
}
|
|
1744
|
-
const visit: <T>(value: InvocationResultMember, visitor: Visitor<T>) => T;
|
|
2191
|
+
bedrockRerankingConfiguration?: VectorSearchBedrockRerankingConfiguration | undefined;
|
|
1745
2192
|
}
|
|
1746
2193
|
/**
|
|
1747
2194
|
* <p>
|
|
@@ -2112,267 +2559,61 @@ export interface PayloadPart {
|
|
|
2112
2559
|
*/
|
|
2113
2560
|
export interface OutputFile {
|
|
2114
2561
|
/**
|
|
2115
|
-
* <p>The name of the file containing response from code interpreter.</p>
|
|
2116
|
-
* @public
|
|
2117
|
-
*/
|
|
2118
|
-
name?: string | undefined;
|
|
2119
|
-
/**
|
|
2120
|
-
* <p>The type of file that contains response from the code interpreter.</p>
|
|
2121
|
-
* @public
|
|
2122
|
-
*/
|
|
2123
|
-
type?: string | undefined;
|
|
2124
|
-
/**
|
|
2125
|
-
* <p>The byte count of files that contains response from code interpreter.</p>
|
|
2126
|
-
* @public
|
|
2127
|
-
*/
|
|
2128
|
-
bytes?: Uint8Array | undefined;
|
|
2129
|
-
}
|
|
2130
|
-
/**
|
|
2131
|
-
* <p>Contains intermediate response for code interpreter if any files have been generated.</p>
|
|
2132
|
-
* @public
|
|
2133
|
-
*/
|
|
2134
|
-
export interface FilePart {
|
|
2135
|
-
/**
|
|
2136
|
-
* <p>Files containing intermediate response for the user.</p>
|
|
2137
|
-
* @public
|
|
2138
|
-
*/
|
|
2139
|
-
files?: OutputFile[] | undefined;
|
|
2140
|
-
}
|
|
2141
|
-
/**
|
|
2142
|
-
* <p>Information about a parameter to provide to the API request.</p>
|
|
2143
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2144
|
-
* <ul>
|
|
2145
|
-
* <li>
|
|
2146
|
-
* <p>
|
|
2147
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
2148
|
-
* </p>
|
|
2149
|
-
* </li>
|
|
2150
|
-
* </ul>
|
|
2151
|
-
* @public
|
|
2152
|
-
*/
|
|
2153
|
-
export interface ApiParameter {
|
|
2154
|
-
/**
|
|
2155
|
-
* <p>The name of the parameter.</p>
|
|
2156
|
-
* @public
|
|
2157
|
-
*/
|
|
2158
|
-
name?: string | undefined;
|
|
2159
|
-
/**
|
|
2160
|
-
* <p>The data type for the parameter.</p>
|
|
2161
|
-
* @public
|
|
2162
|
-
*/
|
|
2163
|
-
type?: string | undefined;
|
|
2164
|
-
/**
|
|
2165
|
-
* <p>The value of the parameter.</p>
|
|
2166
|
-
* @public
|
|
2167
|
-
*/
|
|
2168
|
-
value?: string | undefined;
|
|
2169
|
-
}
|
|
2170
|
-
/**
|
|
2171
|
-
* <p>Contains the parameters in the request body.</p>
|
|
2172
|
-
* @public
|
|
2173
|
-
*/
|
|
2174
|
-
export interface PropertyParameters {
|
|
2175
|
-
/**
|
|
2176
|
-
* <p>A list of parameters in the request body.</p>
|
|
2177
|
-
* @public
|
|
2178
|
-
*/
|
|
2179
|
-
properties?: Parameter[] | undefined;
|
|
2180
|
-
}
|
|
2181
|
-
/**
|
|
2182
|
-
* <p>The request body to provide for the API request, as the agent elicited from the user.</p>
|
|
2183
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2184
|
-
* <ul>
|
|
2185
|
-
* <li>
|
|
2186
|
-
* <p>
|
|
2187
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
2188
|
-
* </p>
|
|
2189
|
-
* </li>
|
|
2190
|
-
* </ul>
|
|
2191
|
-
* @public
|
|
2192
|
-
*/
|
|
2193
|
-
export interface ApiRequestBody {
|
|
2194
|
-
/**
|
|
2195
|
-
* <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>
|
|
2196
|
-
* @public
|
|
2197
|
-
*/
|
|
2198
|
-
content?: Record<string, PropertyParameters> | undefined;
|
|
2199
|
-
}
|
|
2200
|
-
/**
|
|
2201
|
-
* <p>Contains information about the API operation that the agent predicts should be called.</p>
|
|
2202
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2203
|
-
* <ul>
|
|
2204
|
-
* <li>
|
|
2205
|
-
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
2206
|
-
* </p>
|
|
2207
|
-
* </li>
|
|
2208
|
-
* </ul>
|
|
2209
|
-
* @public
|
|
2210
|
-
*/
|
|
2211
|
-
export interface ApiInvocationInput {
|
|
2212
|
-
/**
|
|
2213
|
-
* <p>The action group that the API operation belongs to.</p>
|
|
2214
|
-
* @public
|
|
2215
|
-
*/
|
|
2216
|
-
actionGroup: string | undefined;
|
|
2217
|
-
/**
|
|
2218
|
-
* <p>The HTTP method of the API operation.</p>
|
|
2219
|
-
* @public
|
|
2220
|
-
*/
|
|
2221
|
-
httpMethod?: string | undefined;
|
|
2222
|
-
/**
|
|
2223
|
-
* <p>The path to the API operation.</p>
|
|
2224
|
-
* @public
|
|
2225
|
-
*/
|
|
2226
|
-
apiPath?: string | undefined;
|
|
2227
|
-
/**
|
|
2228
|
-
* <p>The parameters to provide for the API request, as the agent elicited from the user.</p>
|
|
2229
|
-
* @public
|
|
2230
|
-
*/
|
|
2231
|
-
parameters?: ApiParameter[] | undefined;
|
|
2232
|
-
/**
|
|
2233
|
-
* <p>The request body to provide for the API request, as the agent elicited from the user.</p>
|
|
2234
|
-
* @public
|
|
2235
|
-
*/
|
|
2236
|
-
requestBody?: ApiRequestBody | undefined;
|
|
2237
|
-
/**
|
|
2238
|
-
* <p>Contains information about the API operation to invoke.</p>
|
|
2239
|
-
* @public
|
|
2240
|
-
*/
|
|
2241
|
-
actionInvocationType?: ActionInvocationType | undefined;
|
|
2242
|
-
}
|
|
2243
|
-
/**
|
|
2244
|
-
* <p>Contains information about a parameter of the function.</p>
|
|
2245
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2246
|
-
* <ul>
|
|
2247
|
-
* <li>
|
|
2248
|
-
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
2249
|
-
* </p>
|
|
2250
|
-
* </li>
|
|
2251
|
-
* </ul>
|
|
2252
|
-
* @public
|
|
2253
|
-
*/
|
|
2254
|
-
export interface FunctionParameter {
|
|
2255
|
-
/**
|
|
2256
|
-
* <p>The name of the parameter.</p>
|
|
2257
|
-
* @public
|
|
2258
|
-
*/
|
|
2259
|
-
name?: string | undefined;
|
|
2260
|
-
/**
|
|
2261
|
-
* <p>The data type of the parameter.</p>
|
|
2262
|
-
* @public
|
|
2263
|
-
*/
|
|
2264
|
-
type?: string | undefined;
|
|
2265
|
-
/**
|
|
2266
|
-
* <p>The value of the parameter.</p>
|
|
2267
|
-
* @public
|
|
2268
|
-
*/
|
|
2269
|
-
value?: string | undefined;
|
|
2270
|
-
}
|
|
2271
|
-
/**
|
|
2272
|
-
* <p>Contains information about the function that the agent predicts should be called.</p>
|
|
2273
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2274
|
-
* <ul>
|
|
2275
|
-
* <li>
|
|
2276
|
-
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
2277
|
-
* </p>
|
|
2278
|
-
* </li>
|
|
2279
|
-
* </ul>
|
|
2280
|
-
* @public
|
|
2281
|
-
*/
|
|
2282
|
-
export interface FunctionInvocationInput {
|
|
2283
|
-
/**
|
|
2284
|
-
* <p>The action group that the function belongs to.</p>
|
|
2562
|
+
* <p>The name of the file containing response from code interpreter.</p>
|
|
2285
2563
|
* @public
|
|
2286
2564
|
*/
|
|
2287
|
-
|
|
2565
|
+
name?: string | undefined;
|
|
2288
2566
|
/**
|
|
2289
|
-
* <p>
|
|
2567
|
+
* <p>The type of file that contains response from the code interpreter.</p>
|
|
2290
2568
|
* @public
|
|
2291
2569
|
*/
|
|
2292
|
-
|
|
2570
|
+
type?: string | undefined;
|
|
2293
2571
|
/**
|
|
2294
|
-
* <p>The
|
|
2572
|
+
* <p>The byte count of files that contains response from code interpreter.</p>
|
|
2295
2573
|
* @public
|
|
2296
2574
|
*/
|
|
2297
|
-
|
|
2575
|
+
bytes?: Uint8Array | undefined;
|
|
2576
|
+
}
|
|
2577
|
+
/**
|
|
2578
|
+
* <p>Contains intermediate response for code interpreter if any files have been generated.</p>
|
|
2579
|
+
* @public
|
|
2580
|
+
*/
|
|
2581
|
+
export interface FilePart {
|
|
2298
2582
|
/**
|
|
2299
|
-
* <p>
|
|
2583
|
+
* <p>Files containing intermediate response for the user.</p>
|
|
2300
2584
|
* @public
|
|
2301
2585
|
*/
|
|
2302
|
-
|
|
2586
|
+
files?: OutputFile[] | undefined;
|
|
2303
2587
|
}
|
|
2304
2588
|
/**
|
|
2305
|
-
* <p>
|
|
2306
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2307
|
-
* <ul>
|
|
2308
|
-
* <li>
|
|
2309
|
-
* <p>In the <code>returnControl</code> field of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
2310
|
-
* </p>
|
|
2311
|
-
* </li>
|
|
2312
|
-
* </ul>
|
|
2589
|
+
* <p>Details about a caller.</p>
|
|
2313
2590
|
* @public
|
|
2314
2591
|
*/
|
|
2315
|
-
export type
|
|
2592
|
+
export type Caller = Caller.AgentAliasArnMember | Caller.$UnknownMember;
|
|
2316
2593
|
/**
|
|
2317
2594
|
* @public
|
|
2318
2595
|
*/
|
|
2319
|
-
export declare namespace
|
|
2320
|
-
/**
|
|
2321
|
-
* <p>Contains information about the API operation that the agent predicts should be called.</p>
|
|
2322
|
-
* @public
|
|
2323
|
-
*/
|
|
2324
|
-
interface ApiInvocationInputMember {
|
|
2325
|
-
apiInvocationInput: ApiInvocationInput;
|
|
2326
|
-
functionInvocationInput?: never;
|
|
2327
|
-
$unknown?: never;
|
|
2328
|
-
}
|
|
2596
|
+
export declare namespace Caller {
|
|
2329
2597
|
/**
|
|
2330
|
-
* <p>
|
|
2598
|
+
* <p>The caller's agent alias ARN.</p>
|
|
2331
2599
|
* @public
|
|
2332
2600
|
*/
|
|
2333
|
-
interface
|
|
2334
|
-
|
|
2335
|
-
functionInvocationInput: FunctionInvocationInput;
|
|
2601
|
+
interface AgentAliasArnMember {
|
|
2602
|
+
agentAliasArn: string;
|
|
2336
2603
|
$unknown?: never;
|
|
2337
2604
|
}
|
|
2338
2605
|
/**
|
|
2339
2606
|
* @public
|
|
2340
2607
|
*/
|
|
2341
2608
|
interface $UnknownMember {
|
|
2342
|
-
|
|
2343
|
-
functionInvocationInput?: never;
|
|
2609
|
+
agentAliasArn?: never;
|
|
2344
2610
|
$unknown: [string, any];
|
|
2345
2611
|
}
|
|
2346
2612
|
interface Visitor<T> {
|
|
2347
|
-
|
|
2348
|
-
functionInvocationInput: (value: FunctionInvocationInput) => T;
|
|
2613
|
+
agentAliasArn: (value: string) => T;
|
|
2349
2614
|
_: (name: string, value: any) => T;
|
|
2350
2615
|
}
|
|
2351
|
-
const visit: <T>(value:
|
|
2352
|
-
}
|
|
2353
|
-
/**
|
|
2354
|
-
* <p>Contains information to return from the action group that the agent has predicted to invoke.</p>
|
|
2355
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2356
|
-
* <ul>
|
|
2357
|
-
* <li>
|
|
2358
|
-
* <p>
|
|
2359
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
2360
|
-
* </p>
|
|
2361
|
-
* </li>
|
|
2362
|
-
* </ul>
|
|
2363
|
-
* @public
|
|
2364
|
-
*/
|
|
2365
|
-
export interface ReturnControlPayload {
|
|
2366
|
-
/**
|
|
2367
|
-
* <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>
|
|
2368
|
-
* @public
|
|
2369
|
-
*/
|
|
2370
|
-
invocationInputs?: InvocationInputMember[] | undefined;
|
|
2371
|
-
/**
|
|
2372
|
-
* <p>The identifier of the action group invocation.</p>
|
|
2373
|
-
* @public
|
|
2374
|
-
*/
|
|
2375
|
-
invocationId?: string | undefined;
|
|
2616
|
+
const visit: <T>(value: Caller, visitor: Visitor<T>) => T;
|
|
2376
2617
|
}
|
|
2377
2618
|
/**
|
|
2378
2619
|
* <p>
|
|
@@ -2832,6 +3073,7 @@ export interface CodeInterpreterInvocationInput {
|
|
|
2832
3073
|
export declare const InvocationType: {
|
|
2833
3074
|
readonly ACTION_GROUP: "ACTION_GROUP";
|
|
2834
3075
|
readonly ACTION_GROUP_CODE_INTERPRETER: "ACTION_GROUP_CODE_INTERPRETER";
|
|
3076
|
+
readonly AGENT_COLLABORATOR: "AGENT_COLLABORATOR";
|
|
2835
3077
|
readonly FINISH: "FINISH";
|
|
2836
3078
|
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
2837
3079
|
};
|
|
@@ -2885,6 +3127,11 @@ export interface InvocationInput {
|
|
|
2885
3127
|
* @public
|
|
2886
3128
|
*/
|
|
2887
3129
|
codeInterpreterInvocationInput?: CodeInterpreterInvocationInput | undefined;
|
|
3130
|
+
/**
|
|
3131
|
+
* <p>The collaborator's invocation input.</p>
|
|
3132
|
+
* @public
|
|
3133
|
+
*/
|
|
3134
|
+
agentCollaboratorInvocationInput?: AgentCollaboratorInvocationInput | undefined;
|
|
2888
3135
|
}
|
|
2889
3136
|
/**
|
|
2890
3137
|
* <p>Specifications about the inference parameters that were provided alongside the prompt. These are specified in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
|
|
@@ -2995,6 +3242,11 @@ export interface ModelInvocationInput {
|
|
|
2995
3242
|
* @public
|
|
2996
3243
|
*/
|
|
2997
3244
|
parserMode?: CreationMode | undefined;
|
|
3245
|
+
/**
|
|
3246
|
+
* <p>The identifier of a foundation model.</p>
|
|
3247
|
+
* @public
|
|
3248
|
+
*/
|
|
3249
|
+
foundationModel?: string | undefined;
|
|
2998
3250
|
}
|
|
2999
3251
|
/**
|
|
3000
3252
|
* <p>Contains information of the usage of the foundation model.</p>
|
|
@@ -3138,6 +3390,7 @@ export interface RepromptResponse {
|
|
|
3138
3390
|
*/
|
|
3139
3391
|
export declare const Type: {
|
|
3140
3392
|
readonly ACTION_GROUP: "ACTION_GROUP";
|
|
3393
|
+
readonly AGENT_COLLABORATOR: "AGENT_COLLABORATOR";
|
|
3141
3394
|
readonly ASK_USER: "ASK_USER";
|
|
3142
3395
|
readonly FINISH: "FINISH";
|
|
3143
3396
|
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
@@ -3189,6 +3442,11 @@ export interface Observation {
|
|
|
3189
3442
|
* @public
|
|
3190
3443
|
*/
|
|
3191
3444
|
actionGroupInvocationOutput?: ActionGroupInvocationOutput | undefined;
|
|
3445
|
+
/**
|
|
3446
|
+
* <p>A collaborator's invocation output.</p>
|
|
3447
|
+
* @public
|
|
3448
|
+
*/
|
|
3449
|
+
agentCollaboratorInvocationOutput?: AgentCollaboratorInvocationOutput | undefined;
|
|
3192
3450
|
/**
|
|
3193
3451
|
* <p>Contains details about the results from looking up the knowledge base.</p>
|
|
3194
3452
|
* @public
|
|
@@ -3520,11 +3778,104 @@ export declare namespace PreProcessingTrace {
|
|
|
3520
3778
|
}
|
|
3521
3779
|
const visit: <T>(value: PreProcessingTrace, visitor: Visitor<T>) => T;
|
|
3522
3780
|
}
|
|
3781
|
+
/**
|
|
3782
|
+
* <p>Invocation output from a routing classifier model.</p>
|
|
3783
|
+
* @public
|
|
3784
|
+
*/
|
|
3785
|
+
export interface RoutingClassifierModelInvocationOutput {
|
|
3786
|
+
/**
|
|
3787
|
+
* <p>The invocation's trace ID.</p>
|
|
3788
|
+
* @public
|
|
3789
|
+
*/
|
|
3790
|
+
traceId?: string | undefined;
|
|
3791
|
+
/**
|
|
3792
|
+
* <p>The invocation's raw response.</p>
|
|
3793
|
+
* @public
|
|
3794
|
+
*/
|
|
3795
|
+
rawResponse?: RawResponse | undefined;
|
|
3796
|
+
/**
|
|
3797
|
+
* <p>The invocation's metadata.</p>
|
|
3798
|
+
* @public
|
|
3799
|
+
*/
|
|
3800
|
+
metadata?: Metadata | undefined;
|
|
3801
|
+
}
|
|
3802
|
+
/**
|
|
3803
|
+
* <p>A trace for a routing classifier.</p>
|
|
3804
|
+
* @public
|
|
3805
|
+
*/
|
|
3806
|
+
export type RoutingClassifierTrace = RoutingClassifierTrace.InvocationInputMember | RoutingClassifierTrace.ModelInvocationInputMember | RoutingClassifierTrace.ModelInvocationOutputMember | RoutingClassifierTrace.ObservationMember | RoutingClassifierTrace.$UnknownMember;
|
|
3807
|
+
/**
|
|
3808
|
+
* @public
|
|
3809
|
+
*/
|
|
3810
|
+
export declare namespace RoutingClassifierTrace {
|
|
3811
|
+
/**
|
|
3812
|
+
* <p>The classifier's invocation input.</p>
|
|
3813
|
+
* @public
|
|
3814
|
+
*/
|
|
3815
|
+
interface InvocationInputMember {
|
|
3816
|
+
invocationInput: InvocationInput;
|
|
3817
|
+
observation?: never;
|
|
3818
|
+
modelInvocationInput?: never;
|
|
3819
|
+
modelInvocationOutput?: never;
|
|
3820
|
+
$unknown?: never;
|
|
3821
|
+
}
|
|
3822
|
+
/**
|
|
3823
|
+
* <p>The classifier's observation.</p>
|
|
3824
|
+
* @public
|
|
3825
|
+
*/
|
|
3826
|
+
interface ObservationMember {
|
|
3827
|
+
invocationInput?: never;
|
|
3828
|
+
observation: Observation;
|
|
3829
|
+
modelInvocationInput?: never;
|
|
3830
|
+
modelInvocationOutput?: never;
|
|
3831
|
+
$unknown?: never;
|
|
3832
|
+
}
|
|
3833
|
+
/**
|
|
3834
|
+
* <p>The classifier's model invocation input.</p>
|
|
3835
|
+
* @public
|
|
3836
|
+
*/
|
|
3837
|
+
interface ModelInvocationInputMember {
|
|
3838
|
+
invocationInput?: never;
|
|
3839
|
+
observation?: never;
|
|
3840
|
+
modelInvocationInput: ModelInvocationInput;
|
|
3841
|
+
modelInvocationOutput?: never;
|
|
3842
|
+
$unknown?: never;
|
|
3843
|
+
}
|
|
3844
|
+
/**
|
|
3845
|
+
* <p>The classifier's model invocation output.</p>
|
|
3846
|
+
* @public
|
|
3847
|
+
*/
|
|
3848
|
+
interface ModelInvocationOutputMember {
|
|
3849
|
+
invocationInput?: never;
|
|
3850
|
+
observation?: never;
|
|
3851
|
+
modelInvocationInput?: never;
|
|
3852
|
+
modelInvocationOutput: RoutingClassifierModelInvocationOutput;
|
|
3853
|
+
$unknown?: never;
|
|
3854
|
+
}
|
|
3855
|
+
/**
|
|
3856
|
+
* @public
|
|
3857
|
+
*/
|
|
3858
|
+
interface $UnknownMember {
|
|
3859
|
+
invocationInput?: never;
|
|
3860
|
+
observation?: never;
|
|
3861
|
+
modelInvocationInput?: never;
|
|
3862
|
+
modelInvocationOutput?: never;
|
|
3863
|
+
$unknown: [string, any];
|
|
3864
|
+
}
|
|
3865
|
+
interface Visitor<T> {
|
|
3866
|
+
invocationInput: (value: InvocationInput) => T;
|
|
3867
|
+
observation: (value: Observation) => T;
|
|
3868
|
+
modelInvocationInput: (value: ModelInvocationInput) => T;
|
|
3869
|
+
modelInvocationOutput: (value: RoutingClassifierModelInvocationOutput) => T;
|
|
3870
|
+
_: (name: string, value: any) => T;
|
|
3871
|
+
}
|
|
3872
|
+
const visit: <T>(value: RoutingClassifierTrace, visitor: Visitor<T>) => T;
|
|
3873
|
+
}
|
|
3523
3874
|
/**
|
|
3524
3875
|
* <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>
|
|
3525
3876
|
* @public
|
|
3526
3877
|
*/
|
|
3527
|
-
export type Trace = Trace.CustomOrchestrationTraceMember | Trace.FailureTraceMember | Trace.GuardrailTraceMember | Trace.OrchestrationTraceMember | Trace.PostProcessingTraceMember | Trace.PreProcessingTraceMember | Trace.$UnknownMember;
|
|
3878
|
+
export type Trace = Trace.CustomOrchestrationTraceMember | Trace.FailureTraceMember | Trace.GuardrailTraceMember | Trace.OrchestrationTraceMember | Trace.PostProcessingTraceMember | Trace.PreProcessingTraceMember | Trace.RoutingClassifierTraceMember | Trace.$UnknownMember;
|
|
3528
3879
|
/**
|
|
3529
3880
|
* @public
|
|
3530
3881
|
*/
|
|
@@ -3538,6 +3889,7 @@ export declare namespace Trace {
|
|
|
3538
3889
|
preProcessingTrace?: never;
|
|
3539
3890
|
orchestrationTrace?: never;
|
|
3540
3891
|
postProcessingTrace?: never;
|
|
3892
|
+
routingClassifierTrace?: never;
|
|
3541
3893
|
failureTrace?: never;
|
|
3542
3894
|
customOrchestrationTrace?: never;
|
|
3543
3895
|
$unknown?: never;
|
|
@@ -3551,6 +3903,7 @@ export declare namespace Trace {
|
|
|
3551
3903
|
preProcessingTrace: PreProcessingTrace;
|
|
3552
3904
|
orchestrationTrace?: never;
|
|
3553
3905
|
postProcessingTrace?: never;
|
|
3906
|
+
routingClassifierTrace?: never;
|
|
3554
3907
|
failureTrace?: never;
|
|
3555
3908
|
customOrchestrationTrace?: never;
|
|
3556
3909
|
$unknown?: never;
|
|
@@ -3564,6 +3917,7 @@ export declare namespace Trace {
|
|
|
3564
3917
|
preProcessingTrace?: never;
|
|
3565
3918
|
orchestrationTrace: OrchestrationTrace;
|
|
3566
3919
|
postProcessingTrace?: never;
|
|
3920
|
+
routingClassifierTrace?: never;
|
|
3567
3921
|
failureTrace?: never;
|
|
3568
3922
|
customOrchestrationTrace?: never;
|
|
3569
3923
|
$unknown?: never;
|
|
@@ -3577,6 +3931,21 @@ export declare namespace Trace {
|
|
|
3577
3931
|
preProcessingTrace?: never;
|
|
3578
3932
|
orchestrationTrace?: never;
|
|
3579
3933
|
postProcessingTrace: PostProcessingTrace;
|
|
3934
|
+
routingClassifierTrace?: never;
|
|
3935
|
+
failureTrace?: never;
|
|
3936
|
+
customOrchestrationTrace?: never;
|
|
3937
|
+
$unknown?: never;
|
|
3938
|
+
}
|
|
3939
|
+
/**
|
|
3940
|
+
* <p>A routing classifier's trace.</p>
|
|
3941
|
+
* @public
|
|
3942
|
+
*/
|
|
3943
|
+
interface RoutingClassifierTraceMember {
|
|
3944
|
+
guardrailTrace?: never;
|
|
3945
|
+
preProcessingTrace?: never;
|
|
3946
|
+
orchestrationTrace?: never;
|
|
3947
|
+
postProcessingTrace?: never;
|
|
3948
|
+
routingClassifierTrace: RoutingClassifierTrace;
|
|
3580
3949
|
failureTrace?: never;
|
|
3581
3950
|
customOrchestrationTrace?: never;
|
|
3582
3951
|
$unknown?: never;
|
|
@@ -3590,6 +3959,7 @@ export declare namespace Trace {
|
|
|
3590
3959
|
preProcessingTrace?: never;
|
|
3591
3960
|
orchestrationTrace?: never;
|
|
3592
3961
|
postProcessingTrace?: never;
|
|
3962
|
+
routingClassifierTrace?: never;
|
|
3593
3963
|
failureTrace: FailureTrace;
|
|
3594
3964
|
customOrchestrationTrace?: never;
|
|
3595
3965
|
$unknown?: never;
|
|
@@ -3605,6 +3975,7 @@ export declare namespace Trace {
|
|
|
3605
3975
|
preProcessingTrace?: never;
|
|
3606
3976
|
orchestrationTrace?: never;
|
|
3607
3977
|
postProcessingTrace?: never;
|
|
3978
|
+
routingClassifierTrace?: never;
|
|
3608
3979
|
failureTrace?: never;
|
|
3609
3980
|
customOrchestrationTrace: CustomOrchestrationTrace;
|
|
3610
3981
|
$unknown?: never;
|
|
@@ -3617,6 +3988,7 @@ export declare namespace Trace {
|
|
|
3617
3988
|
preProcessingTrace?: never;
|
|
3618
3989
|
orchestrationTrace?: never;
|
|
3619
3990
|
postProcessingTrace?: never;
|
|
3991
|
+
routingClassifierTrace?: never;
|
|
3620
3992
|
failureTrace?: never;
|
|
3621
3993
|
customOrchestrationTrace?: never;
|
|
3622
3994
|
$unknown: [string, any];
|
|
@@ -3626,6 +3998,7 @@ export declare namespace Trace {
|
|
|
3626
3998
|
preProcessingTrace: (value: PreProcessingTrace) => T;
|
|
3627
3999
|
orchestrationTrace: (value: OrchestrationTrace) => T;
|
|
3628
4000
|
postProcessingTrace: (value: PostProcessingTrace) => T;
|
|
4001
|
+
routingClassifierTrace: (value: RoutingClassifierTrace) => T;
|
|
3629
4002
|
failureTrace: (value: FailureTrace) => T;
|
|
3630
4003
|
customOrchestrationTrace: (value: CustomOrchestrationTrace) => T;
|
|
3631
4004
|
_: (name: string, value: any) => T;
|
|
@@ -3662,6 +4035,16 @@ export interface TracePart {
|
|
|
3662
4035
|
* @public
|
|
3663
4036
|
*/
|
|
3664
4037
|
agentVersion?: string | undefined;
|
|
4038
|
+
/**
|
|
4039
|
+
* <p>The part's caller chain.</p>
|
|
4040
|
+
* @public
|
|
4041
|
+
*/
|
|
4042
|
+
callerChain?: Caller[] | undefined;
|
|
4043
|
+
/**
|
|
4044
|
+
* <p>The part's collaborator name.</p>
|
|
4045
|
+
* @public
|
|
4046
|
+
*/
|
|
4047
|
+
collaboratorName?: string | undefined;
|
|
3665
4048
|
}
|
|
3666
4049
|
/**
|
|
3667
4050
|
* <p>The response from invoking the agent and associated citations and trace information.</p>
|
|
@@ -6768,6 +7151,11 @@ export interface SessionState {
|
|
|
6768
7151
|
* @public
|
|
6769
7152
|
*/
|
|
6770
7153
|
knowledgeBaseConfigurations?: KnowledgeBaseConfiguration[] | undefined;
|
|
7154
|
+
/**
|
|
7155
|
+
* <p>The state's conversation history.</p>
|
|
7156
|
+
* @public
|
|
7157
|
+
*/
|
|
7158
|
+
conversationHistory?: ConversationHistory | undefined;
|
|
6771
7159
|
}
|
|
6772
7160
|
/**
|
|
6773
7161
|
* @public
|
|
@@ -6826,6 +7214,11 @@ export interface InvokeAgentRequest {
|
|
|
6826
7214
|
* @public
|
|
6827
7215
|
*/
|
|
6828
7216
|
streamingConfigurations?: StreamingConfigurations | undefined;
|
|
7217
|
+
/**
|
|
7218
|
+
* <p>The ARN of the resource making the request.</p>
|
|
7219
|
+
* @public
|
|
7220
|
+
*/
|
|
7221
|
+
sourceArn?: string | undefined;
|
|
6829
7222
|
}
|
|
6830
7223
|
/**
|
|
6831
7224
|
* @internal
|
|
@@ -6851,6 +7244,50 @@ export declare const FunctionSchemaFilterSensitiveLog: (obj: FunctionSchema) =>
|
|
|
6851
7244
|
* @internal
|
|
6852
7245
|
*/
|
|
6853
7246
|
export declare const AgentActionGroupFilterSensitiveLog: (obj: AgentActionGroup) => any;
|
|
7247
|
+
/**
|
|
7248
|
+
* @internal
|
|
7249
|
+
*/
|
|
7250
|
+
export declare const ApiResultFilterSensitiveLog: (obj: ApiResult) => any;
|
|
7251
|
+
/**
|
|
7252
|
+
* @internal
|
|
7253
|
+
*/
|
|
7254
|
+
export declare const InvocationResultMemberFilterSensitiveLog: (obj: InvocationResultMember) => any;
|
|
7255
|
+
/**
|
|
7256
|
+
* @internal
|
|
7257
|
+
*/
|
|
7258
|
+
export declare const ReturnControlResultsFilterSensitiveLog: (obj: ReturnControlResults) => any;
|
|
7259
|
+
/**
|
|
7260
|
+
* @internal
|
|
7261
|
+
*/
|
|
7262
|
+
export declare const AgentCollaboratorInputPayloadFilterSensitiveLog: (obj: AgentCollaboratorInputPayload) => any;
|
|
7263
|
+
/**
|
|
7264
|
+
* @internal
|
|
7265
|
+
*/
|
|
7266
|
+
export declare const AgentCollaboratorInvocationInputFilterSensitiveLog: (obj: AgentCollaboratorInvocationInput) => any;
|
|
7267
|
+
/**
|
|
7268
|
+
* @internal
|
|
7269
|
+
*/
|
|
7270
|
+
export declare const ApiInvocationInputFilterSensitiveLog: (obj: ApiInvocationInput) => any;
|
|
7271
|
+
/**
|
|
7272
|
+
* @internal
|
|
7273
|
+
*/
|
|
7274
|
+
export declare const FunctionInvocationInputFilterSensitiveLog: (obj: FunctionInvocationInput) => any;
|
|
7275
|
+
/**
|
|
7276
|
+
* @internal
|
|
7277
|
+
*/
|
|
7278
|
+
export declare const InvocationInputMemberFilterSensitiveLog: (obj: InvocationInputMember) => any;
|
|
7279
|
+
/**
|
|
7280
|
+
* @internal
|
|
7281
|
+
*/
|
|
7282
|
+
export declare const ReturnControlPayloadFilterSensitiveLog: (obj: ReturnControlPayload) => any;
|
|
7283
|
+
/**
|
|
7284
|
+
* @internal
|
|
7285
|
+
*/
|
|
7286
|
+
export declare const AgentCollaboratorOutputPayloadFilterSensitiveLog: (obj: AgentCollaboratorOutputPayload) => any;
|
|
7287
|
+
/**
|
|
7288
|
+
* @internal
|
|
7289
|
+
*/
|
|
7290
|
+
export declare const AgentCollaboratorInvocationOutputFilterSensitiveLog: (obj: AgentCollaboratorInvocationOutput) => any;
|
|
6854
7291
|
/**
|
|
6855
7292
|
* @internal
|
|
6856
7293
|
*/
|
|
@@ -6915,6 +7352,18 @@ export declare const FlowResponseStreamFilterSensitiveLog: (obj: FlowResponseStr
|
|
|
6915
7352
|
* @internal
|
|
6916
7353
|
*/
|
|
6917
7354
|
export declare const InvokeFlowResponseFilterSensitiveLog: (obj: InvokeFlowResponse) => any;
|
|
7355
|
+
/**
|
|
7356
|
+
* @internal
|
|
7357
|
+
*/
|
|
7358
|
+
export declare const ContentBlockFilterSensitiveLog: (obj: ContentBlock) => any;
|
|
7359
|
+
/**
|
|
7360
|
+
* @internal
|
|
7361
|
+
*/
|
|
7362
|
+
export declare const MessageFilterSensitiveLog: (obj: Message) => any;
|
|
7363
|
+
/**
|
|
7364
|
+
* @internal
|
|
7365
|
+
*/
|
|
7366
|
+
export declare const ConversationHistoryFilterSensitiveLog: (obj: ConversationHistory) => any;
|
|
6918
7367
|
/**
|
|
6919
7368
|
* @internal
|
|
6920
7369
|
*/
|
|
@@ -6951,14 +7400,6 @@ export declare const VectorSearchBedrockRerankingConfigurationFilterSensitiveLog
|
|
|
6951
7400
|
* @internal
|
|
6952
7401
|
*/
|
|
6953
7402
|
export declare const VectorSearchRerankingConfigurationFilterSensitiveLog: (obj: VectorSearchRerankingConfiguration) => any;
|
|
6954
|
-
/**
|
|
6955
|
-
* @internal
|
|
6956
|
-
*/
|
|
6957
|
-
export declare const ApiResultFilterSensitiveLog: (obj: ApiResult) => any;
|
|
6958
|
-
/**
|
|
6959
|
-
* @internal
|
|
6960
|
-
*/
|
|
6961
|
-
export declare const InvocationResultMemberFilterSensitiveLog: (obj: InvocationResultMember) => any;
|
|
6962
7403
|
/**
|
|
6963
7404
|
* @internal
|
|
6964
7405
|
*/
|
|
@@ -6999,18 +7440,6 @@ export declare const OutputFileFilterSensitiveLog: (obj: OutputFile) => any;
|
|
|
6999
7440
|
* @internal
|
|
7000
7441
|
*/
|
|
7001
7442
|
export declare const FilePartFilterSensitiveLog: (obj: FilePart) => any;
|
|
7002
|
-
/**
|
|
7003
|
-
* @internal
|
|
7004
|
-
*/
|
|
7005
|
-
export declare const ApiInvocationInputFilterSensitiveLog: (obj: ApiInvocationInput) => any;
|
|
7006
|
-
/**
|
|
7007
|
-
* @internal
|
|
7008
|
-
*/
|
|
7009
|
-
export declare const InvocationInputMemberFilterSensitiveLog: (obj: InvocationInputMember) => any;
|
|
7010
|
-
/**
|
|
7011
|
-
* @internal
|
|
7012
|
-
*/
|
|
7013
|
-
export declare const ReturnControlPayloadFilterSensitiveLog: (obj: ReturnControlPayload) => any;
|
|
7014
7443
|
/**
|
|
7015
7444
|
* @internal
|
|
7016
7445
|
*/
|
|
@@ -7147,6 +7576,14 @@ export declare const PreProcessingModelInvocationOutputFilterSensitiveLog: (obj:
|
|
|
7147
7576
|
* @internal
|
|
7148
7577
|
*/
|
|
7149
7578
|
export declare const PreProcessingTraceFilterSensitiveLog: (obj: PreProcessingTrace) => any;
|
|
7579
|
+
/**
|
|
7580
|
+
* @internal
|
|
7581
|
+
*/
|
|
7582
|
+
export declare const RoutingClassifierModelInvocationOutputFilterSensitiveLog: (obj: RoutingClassifierModelInvocationOutput) => any;
|
|
7583
|
+
/**
|
|
7584
|
+
* @internal
|
|
7585
|
+
*/
|
|
7586
|
+
export declare const RoutingClassifierTraceFilterSensitiveLog: (obj: RoutingClassifierTrace) => any;
|
|
7150
7587
|
/**
|
|
7151
7588
|
* @internal
|
|
7152
7589
|
*/
|