@aws-sdk/client-bedrock-agent-runtime 3.703.0 → 3.706.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/README.md +8 -0
- package/dist-cjs/index.js +380 -68
- package/dist-es/BedrockAgentRuntime.js +2 -0
- package/dist-es/commands/GenerateQueryCommand.js +23 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +216 -54
- package/dist-es/protocols/Aws_restJson1.js +74 -3
- package/dist-types/BedrockAgentRuntime.d.ts +7 -0
- package/dist-types/BedrockAgentRuntimeClient.d.ts +3 -2
- package/dist-types/commands/GenerateQueryCommand.d.ts +115 -0
- package/dist-types/commands/InvokeAgentCommand.d.ts +400 -24
- package/dist-types/commands/InvokeInlineAgentCommand.d.ts +380 -23
- package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +17 -2
- package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +17 -2
- package/dist-types/commands/RetrieveCommand.d.ts +17 -2
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1189 -489
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +17 -0
- package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/GenerateQueryCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +418 -123
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- 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
|
|
@@ -1158,87 +1714,300 @@ export declare namespace FlowResponseStream {
|
|
|
1158
1714
|
$unknown?: never;
|
|
1159
1715
|
}
|
|
1160
1716
|
/**
|
|
1161
|
-
* <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
|
|
1717
|
+
* <p>There was an issue with a dependency. Check the resource configurations and retry the request.</p>
|
|
1718
|
+
* @public
|
|
1719
|
+
*/
|
|
1720
|
+
interface DependencyFailedExceptionMember {
|
|
1721
|
+
flowOutputEvent?: never;
|
|
1722
|
+
flowCompletionEvent?: never;
|
|
1723
|
+
flowTraceEvent?: never;
|
|
1724
|
+
internalServerException?: never;
|
|
1725
|
+
validationException?: never;
|
|
1726
|
+
resourceNotFoundException?: never;
|
|
1727
|
+
serviceQuotaExceededException?: never;
|
|
1728
|
+
throttlingException?: never;
|
|
1729
|
+
accessDeniedException?: never;
|
|
1730
|
+
conflictException?: never;
|
|
1731
|
+
dependencyFailedException: DependencyFailedException;
|
|
1732
|
+
badGatewayException?: never;
|
|
1733
|
+
$unknown?: never;
|
|
1734
|
+
}
|
|
1735
|
+
/**
|
|
1736
|
+
* <p>There was an issue with a dependency due to a server issue. Retry your request.</p>
|
|
1737
|
+
* @public
|
|
1738
|
+
*/
|
|
1739
|
+
interface BadGatewayExceptionMember {
|
|
1740
|
+
flowOutputEvent?: never;
|
|
1741
|
+
flowCompletionEvent?: never;
|
|
1742
|
+
flowTraceEvent?: never;
|
|
1743
|
+
internalServerException?: never;
|
|
1744
|
+
validationException?: never;
|
|
1745
|
+
resourceNotFoundException?: never;
|
|
1746
|
+
serviceQuotaExceededException?: never;
|
|
1747
|
+
throttlingException?: never;
|
|
1748
|
+
accessDeniedException?: never;
|
|
1749
|
+
conflictException?: never;
|
|
1750
|
+
dependencyFailedException?: never;
|
|
1751
|
+
badGatewayException: BadGatewayException;
|
|
1752
|
+
$unknown?: never;
|
|
1753
|
+
}
|
|
1754
|
+
/**
|
|
1755
|
+
* @public
|
|
1756
|
+
*/
|
|
1757
|
+
interface $UnknownMember {
|
|
1758
|
+
flowOutputEvent?: never;
|
|
1759
|
+
flowCompletionEvent?: never;
|
|
1760
|
+
flowTraceEvent?: never;
|
|
1761
|
+
internalServerException?: never;
|
|
1762
|
+
validationException?: never;
|
|
1763
|
+
resourceNotFoundException?: never;
|
|
1764
|
+
serviceQuotaExceededException?: never;
|
|
1765
|
+
throttlingException?: never;
|
|
1766
|
+
accessDeniedException?: never;
|
|
1767
|
+
conflictException?: never;
|
|
1768
|
+
dependencyFailedException?: never;
|
|
1769
|
+
badGatewayException?: never;
|
|
1770
|
+
$unknown: [string, any];
|
|
1771
|
+
}
|
|
1772
|
+
interface Visitor<T> {
|
|
1773
|
+
flowOutputEvent: (value: FlowOutputEvent) => T;
|
|
1774
|
+
flowCompletionEvent: (value: FlowCompletionEvent) => T;
|
|
1775
|
+
flowTraceEvent: (value: FlowTraceEvent) => T;
|
|
1776
|
+
internalServerException: (value: InternalServerException) => T;
|
|
1777
|
+
validationException: (value: ValidationException) => T;
|
|
1778
|
+
resourceNotFoundException: (value: ResourceNotFoundException) => T;
|
|
1779
|
+
serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T;
|
|
1780
|
+
throttlingException: (value: ThrottlingException) => T;
|
|
1781
|
+
accessDeniedException: (value: AccessDeniedException) => T;
|
|
1782
|
+
conflictException: (value: ConflictException) => T;
|
|
1783
|
+
dependencyFailedException: (value: DependencyFailedException) => T;
|
|
1784
|
+
badGatewayException: (value: BadGatewayException) => T;
|
|
1785
|
+
_: (name: string, value: any) => T;
|
|
1786
|
+
}
|
|
1787
|
+
const visit: <T>(value: FlowResponseStream, visitor: Visitor<T>) => T;
|
|
1788
|
+
}
|
|
1789
|
+
/**
|
|
1790
|
+
* @public
|
|
1791
|
+
*/
|
|
1792
|
+
export interface InvokeFlowResponse {
|
|
1793
|
+
/**
|
|
1794
|
+
* <p>The output of the flow, returned as a stream. If there's an error, the error is returned.</p>
|
|
1795
|
+
* @public
|
|
1796
|
+
*/
|
|
1797
|
+
responseStream: AsyncIterable<FlowResponseStream> | undefined;
|
|
1798
|
+
}
|
|
1799
|
+
/**
|
|
1800
|
+
* @public
|
|
1801
|
+
* @enum
|
|
1802
|
+
*/
|
|
1803
|
+
export declare const InputQueryType: {
|
|
1804
|
+
readonly TEXT: "TEXT";
|
|
1805
|
+
};
|
|
1806
|
+
/**
|
|
1807
|
+
* @public
|
|
1808
|
+
*/
|
|
1809
|
+
export type InputQueryType = (typeof InputQueryType)[keyof typeof InputQueryType];
|
|
1810
|
+
/**
|
|
1811
|
+
* <p>Contains information about a natural language query to transform into SQL.</p>
|
|
1812
|
+
* @public
|
|
1813
|
+
*/
|
|
1814
|
+
export interface QueryGenerationInput {
|
|
1815
|
+
/**
|
|
1816
|
+
* <p>The type of the query.</p>
|
|
1817
|
+
* @public
|
|
1818
|
+
*/
|
|
1819
|
+
type: InputQueryType | undefined;
|
|
1820
|
+
/**
|
|
1821
|
+
* <p>The text of the query.</p>
|
|
1822
|
+
* @public
|
|
1823
|
+
*/
|
|
1824
|
+
text: string | undefined;
|
|
1825
|
+
}
|
|
1826
|
+
/**
|
|
1827
|
+
* @public
|
|
1828
|
+
* @enum
|
|
1829
|
+
*/
|
|
1830
|
+
export declare const QueryTransformationMode: {
|
|
1831
|
+
readonly TEXT_TO_SQL: "TEXT_TO_SQL";
|
|
1832
|
+
};
|
|
1833
|
+
/**
|
|
1834
|
+
* @public
|
|
1835
|
+
*/
|
|
1836
|
+
export type QueryTransformationMode = (typeof QueryTransformationMode)[keyof typeof QueryTransformationMode];
|
|
1837
|
+
/**
|
|
1838
|
+
* <p>Contains configurations for a knowledge base to use in transformation.</p>
|
|
1839
|
+
* @public
|
|
1840
|
+
*/
|
|
1841
|
+
export interface TextToSqlKnowledgeBaseConfiguration {
|
|
1842
|
+
/**
|
|
1843
|
+
* <p>The ARN of the knowledge base</p>
|
|
1844
|
+
* @public
|
|
1845
|
+
*/
|
|
1846
|
+
knowledgeBaseArn: string | undefined;
|
|
1847
|
+
}
|
|
1848
|
+
/**
|
|
1849
|
+
* @public
|
|
1850
|
+
* @enum
|
|
1851
|
+
*/
|
|
1852
|
+
export declare const TextToSqlConfigurationType: {
|
|
1853
|
+
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
1854
|
+
};
|
|
1855
|
+
/**
|
|
1856
|
+
* @public
|
|
1857
|
+
*/
|
|
1858
|
+
export type TextToSqlConfigurationType = (typeof TextToSqlConfigurationType)[keyof typeof TextToSqlConfigurationType];
|
|
1859
|
+
/**
|
|
1860
|
+
* <p>Contains configurations for transforming text to SQL.</p>
|
|
1861
|
+
* @public
|
|
1862
|
+
*/
|
|
1863
|
+
export interface TextToSqlConfiguration {
|
|
1864
|
+
/**
|
|
1865
|
+
* <p>The type of resource to use in transformation.</p>
|
|
1866
|
+
* @public
|
|
1867
|
+
*/
|
|
1868
|
+
type: TextToSqlConfigurationType | undefined;
|
|
1869
|
+
/**
|
|
1870
|
+
* <p>Specifies configurations for a knowledge base to use in transformation.</p>
|
|
1871
|
+
* @public
|
|
1872
|
+
*/
|
|
1873
|
+
knowledgeBaseConfiguration?: TextToSqlKnowledgeBaseConfiguration | undefined;
|
|
1874
|
+
}
|
|
1875
|
+
/**
|
|
1876
|
+
* <p>Contains configurations for transforming the natural language query into SQL.</p>
|
|
1877
|
+
* @public
|
|
1878
|
+
*/
|
|
1879
|
+
export interface TransformationConfiguration {
|
|
1880
|
+
/**
|
|
1881
|
+
* <p>The mode of the transformation.</p>
|
|
1882
|
+
* @public
|
|
1883
|
+
*/
|
|
1884
|
+
mode: QueryTransformationMode | undefined;
|
|
1885
|
+
/**
|
|
1886
|
+
* <p>Specifies configurations for transforming text to SQL.</p>
|
|
1887
|
+
* @public
|
|
1888
|
+
*/
|
|
1889
|
+
textToSqlConfiguration?: TextToSqlConfiguration | undefined;
|
|
1890
|
+
}
|
|
1891
|
+
/**
|
|
1892
|
+
* @public
|
|
1893
|
+
*/
|
|
1894
|
+
export interface GenerateQueryRequest {
|
|
1895
|
+
/**
|
|
1896
|
+
* <p>Specifies information about a natural language query to transform into SQL.</p>
|
|
1897
|
+
* @public
|
|
1898
|
+
*/
|
|
1899
|
+
queryGenerationInput: QueryGenerationInput | undefined;
|
|
1900
|
+
/**
|
|
1901
|
+
* <p>Specifies configurations for transforming the natural language query into SQL.</p>
|
|
1902
|
+
* @public
|
|
1903
|
+
*/
|
|
1904
|
+
transformationConfiguration: TransformationConfiguration | undefined;
|
|
1905
|
+
}
|
|
1906
|
+
/**
|
|
1907
|
+
* @public
|
|
1908
|
+
* @enum
|
|
1909
|
+
*/
|
|
1910
|
+
export declare const GeneratedQueryType: {
|
|
1911
|
+
readonly REDSHIFT_SQL: "REDSHIFT_SQL";
|
|
1912
|
+
};
|
|
1913
|
+
/**
|
|
1914
|
+
* @public
|
|
1915
|
+
*/
|
|
1916
|
+
export type GeneratedQueryType = (typeof GeneratedQueryType)[keyof typeof GeneratedQueryType];
|
|
1917
|
+
/**
|
|
1918
|
+
* <p>Contains information about a query generated for a natural language query.</p>
|
|
1919
|
+
* @public
|
|
1920
|
+
*/
|
|
1921
|
+
export interface GeneratedQuery {
|
|
1922
|
+
/**
|
|
1923
|
+
* <p>The type of transformed query.</p>
|
|
1924
|
+
* @public
|
|
1925
|
+
*/
|
|
1926
|
+
type?: GeneratedQueryType | undefined;
|
|
1927
|
+
/**
|
|
1928
|
+
* <p>An SQL query that corresponds to the natural language query.</p>
|
|
1929
|
+
* @public
|
|
1930
|
+
*/
|
|
1931
|
+
sql?: string | undefined;
|
|
1932
|
+
}
|
|
1933
|
+
/**
|
|
1934
|
+
* @public
|
|
1935
|
+
*/
|
|
1936
|
+
export interface GenerateQueryResponse {
|
|
1937
|
+
/**
|
|
1938
|
+
* <p>A list of objects, each of which defines a generated query that can correspond to the natural language queries.</p>
|
|
1162
1939
|
* @public
|
|
1163
1940
|
*/
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
dependencyFailedException: DependencyFailedException;
|
|
1176
|
-
badGatewayException?: never;
|
|
1177
|
-
$unknown?: never;
|
|
1178
|
-
}
|
|
1941
|
+
queries?: GeneratedQuery[] | undefined;
|
|
1942
|
+
}
|
|
1943
|
+
/**
|
|
1944
|
+
* <p>A content block.</p>
|
|
1945
|
+
* @public
|
|
1946
|
+
*/
|
|
1947
|
+
export type ContentBlock = ContentBlock.TextMember | ContentBlock.$UnknownMember;
|
|
1948
|
+
/**
|
|
1949
|
+
* @public
|
|
1950
|
+
*/
|
|
1951
|
+
export declare namespace ContentBlock {
|
|
1179
1952
|
/**
|
|
1180
|
-
* <p>
|
|
1953
|
+
* <p>The block's text.</p>
|
|
1181
1954
|
* @public
|
|
1182
1955
|
*/
|
|
1183
|
-
interface
|
|
1184
|
-
|
|
1185
|
-
flowCompletionEvent?: never;
|
|
1186
|
-
flowTraceEvent?: never;
|
|
1187
|
-
internalServerException?: never;
|
|
1188
|
-
validationException?: never;
|
|
1189
|
-
resourceNotFoundException?: never;
|
|
1190
|
-
serviceQuotaExceededException?: never;
|
|
1191
|
-
throttlingException?: never;
|
|
1192
|
-
accessDeniedException?: never;
|
|
1193
|
-
conflictException?: never;
|
|
1194
|
-
dependencyFailedException?: never;
|
|
1195
|
-
badGatewayException: BadGatewayException;
|
|
1956
|
+
interface TextMember {
|
|
1957
|
+
text: string;
|
|
1196
1958
|
$unknown?: never;
|
|
1197
1959
|
}
|
|
1198
1960
|
/**
|
|
1199
1961
|
* @public
|
|
1200
1962
|
*/
|
|
1201
1963
|
interface $UnknownMember {
|
|
1202
|
-
|
|
1203
|
-
flowCompletionEvent?: never;
|
|
1204
|
-
flowTraceEvent?: never;
|
|
1205
|
-
internalServerException?: never;
|
|
1206
|
-
validationException?: never;
|
|
1207
|
-
resourceNotFoundException?: never;
|
|
1208
|
-
serviceQuotaExceededException?: never;
|
|
1209
|
-
throttlingException?: never;
|
|
1210
|
-
accessDeniedException?: never;
|
|
1211
|
-
conflictException?: never;
|
|
1212
|
-
dependencyFailedException?: never;
|
|
1213
|
-
badGatewayException?: never;
|
|
1964
|
+
text?: never;
|
|
1214
1965
|
$unknown: [string, any];
|
|
1215
1966
|
}
|
|
1216
1967
|
interface Visitor<T> {
|
|
1217
|
-
|
|
1218
|
-
flowCompletionEvent: (value: FlowCompletionEvent) => T;
|
|
1219
|
-
flowTraceEvent: (value: FlowTraceEvent) => T;
|
|
1220
|
-
internalServerException: (value: InternalServerException) => T;
|
|
1221
|
-
validationException: (value: ValidationException) => T;
|
|
1222
|
-
resourceNotFoundException: (value: ResourceNotFoundException) => T;
|
|
1223
|
-
serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T;
|
|
1224
|
-
throttlingException: (value: ThrottlingException) => T;
|
|
1225
|
-
accessDeniedException: (value: AccessDeniedException) => T;
|
|
1226
|
-
conflictException: (value: ConflictException) => T;
|
|
1227
|
-
dependencyFailedException: (value: DependencyFailedException) => T;
|
|
1228
|
-
badGatewayException: (value: BadGatewayException) => T;
|
|
1968
|
+
text: (value: string) => T;
|
|
1229
1969
|
_: (name: string, value: any) => T;
|
|
1230
1970
|
}
|
|
1231
|
-
const visit: <T>(value:
|
|
1971
|
+
const visit: <T>(value: ContentBlock, visitor: Visitor<T>) => T;
|
|
1232
1972
|
}
|
|
1233
1973
|
/**
|
|
1234
1974
|
* @public
|
|
1975
|
+
* @enum
|
|
1235
1976
|
*/
|
|
1236
|
-
export
|
|
1977
|
+
export declare const ConversationRole: {
|
|
1978
|
+
readonly ASSISTANT: "assistant";
|
|
1979
|
+
readonly USER: "user";
|
|
1980
|
+
};
|
|
1981
|
+
/**
|
|
1982
|
+
* @public
|
|
1983
|
+
*/
|
|
1984
|
+
export type ConversationRole = (typeof ConversationRole)[keyof typeof ConversationRole];
|
|
1985
|
+
/**
|
|
1986
|
+
* <p>Details about a message.</p>
|
|
1987
|
+
* @public
|
|
1988
|
+
*/
|
|
1989
|
+
export interface Message {
|
|
1237
1990
|
/**
|
|
1238
|
-
* <p>The
|
|
1991
|
+
* <p>The message's role.</p>
|
|
1239
1992
|
* @public
|
|
1240
1993
|
*/
|
|
1241
|
-
|
|
1994
|
+
role: ConversationRole | undefined;
|
|
1995
|
+
/**
|
|
1996
|
+
* <p>The message's content.</p>
|
|
1997
|
+
* @public
|
|
1998
|
+
*/
|
|
1999
|
+
content: ContentBlock[] | undefined;
|
|
2000
|
+
}
|
|
2001
|
+
/**
|
|
2002
|
+
* <p>A conversation history.</p>
|
|
2003
|
+
* @public
|
|
2004
|
+
*/
|
|
2005
|
+
export interface ConversationHistory {
|
|
2006
|
+
/**
|
|
2007
|
+
* <p>The conversation's messages.</p>
|
|
2008
|
+
* @public
|
|
2009
|
+
*/
|
|
2010
|
+
messages?: Message[] | undefined;
|
|
1242
2011
|
}
|
|
1243
2012
|
/**
|
|
1244
2013
|
* <p>The property contains the file to chat with, along with its attributes.</p>
|
|
@@ -1550,198 +2319,20 @@ export declare const VectorSearchRerankingConfigurationType: {
|
|
|
1550
2319
|
*/
|
|
1551
2320
|
export type VectorSearchRerankingConfigurationType = (typeof VectorSearchRerankingConfigurationType)[keyof typeof VectorSearchRerankingConfigurationType];
|
|
1552
2321
|
/**
|
|
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>
|
|
1667
|
-
* @public
|
|
1668
|
-
*/
|
|
1669
|
-
export interface FunctionResult {
|
|
1670
|
-
/**
|
|
1671
|
-
* <p>The action group that the function belongs to.</p>
|
|
1672
|
-
* @public
|
|
1673
|
-
*/
|
|
1674
|
-
actionGroup: string | undefined;
|
|
1675
|
-
/**
|
|
1676
|
-
* <p>Contains the user confirmation information about the function that was called.</p>
|
|
1677
|
-
* @public
|
|
1678
|
-
*/
|
|
1679
|
-
confirmationState?: ConfirmationState | undefined;
|
|
1680
|
-
/**
|
|
1681
|
-
* <p>The name of the function that was called.</p>
|
|
1682
|
-
* @public
|
|
1683
|
-
*/
|
|
1684
|
-
function?: string | undefined;
|
|
1685
|
-
/**
|
|
1686
|
-
* <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>
|
|
1687
|
-
* @public
|
|
1688
|
-
*/
|
|
1689
|
-
responseBody?: Record<string, ContentBody> | undefined;
|
|
1690
|
-
/**
|
|
1691
|
-
* <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>
|
|
1692
|
-
* @public
|
|
1693
|
-
*/
|
|
1694
|
-
responseState?: ResponseState | undefined;
|
|
1695
|
-
}
|
|
1696
|
-
/**
|
|
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
|
-
* @public
|
|
1707
|
-
*/
|
|
1708
|
-
export type InvocationResultMember = InvocationResultMember.ApiResultMember | InvocationResultMember.FunctionResultMember | InvocationResultMember.$UnknownMember;
|
|
1709
|
-
/**
|
|
1710
|
-
* @public
|
|
1711
|
-
*/
|
|
1712
|
-
export declare namespace InvocationResultMember {
|
|
1713
|
-
/**
|
|
1714
|
-
* <p>The result from the API response from the action group invocation.</p>
|
|
1715
|
-
* @public
|
|
1716
|
-
*/
|
|
1717
|
-
interface ApiResultMember {
|
|
1718
|
-
apiResult: ApiResult;
|
|
1719
|
-
functionResult?: never;
|
|
1720
|
-
$unknown?: never;
|
|
1721
|
-
}
|
|
2322
|
+
* <p>Contains configurations for reranking the retrieved results.</p>
|
|
2323
|
+
* @public
|
|
2324
|
+
*/
|
|
2325
|
+
export interface VectorSearchRerankingConfiguration {
|
|
1722
2326
|
/**
|
|
1723
|
-
* <p>The
|
|
2327
|
+
* <p>The type of reranker model.</p>
|
|
1724
2328
|
* @public
|
|
1725
2329
|
*/
|
|
1726
|
-
|
|
1727
|
-
apiResult?: never;
|
|
1728
|
-
functionResult: FunctionResult;
|
|
1729
|
-
$unknown?: never;
|
|
1730
|
-
}
|
|
2330
|
+
type: VectorSearchRerankingConfigurationType | undefined;
|
|
1731
2331
|
/**
|
|
2332
|
+
* <p>Contains configurations for an Amazon Bedrock reranker model.</p>
|
|
1732
2333
|
* @public
|
|
1733
2334
|
*/
|
|
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;
|
|
2335
|
+
bedrockRerankingConfiguration?: VectorSearchBedrockRerankingConfiguration | undefined;
|
|
1745
2336
|
}
|
|
1746
2337
|
/**
|
|
1747
2338
|
* <p>
|
|
@@ -1842,7 +2433,57 @@ export interface GeneratedResponsePart {
|
|
|
1842
2433
|
textResponsePart?: TextResponsePart | undefined;
|
|
1843
2434
|
}
|
|
1844
2435
|
/**
|
|
1845
|
-
*
|
|
2436
|
+
* @public
|
|
2437
|
+
* @enum
|
|
2438
|
+
*/
|
|
2439
|
+
export declare const RetrievalResultContentColumnType: {
|
|
2440
|
+
readonly BLOB: "BLOB";
|
|
2441
|
+
readonly BOOLEAN: "BOOLEAN";
|
|
2442
|
+
readonly DOUBLE: "DOUBLE";
|
|
2443
|
+
readonly LONG: "LONG";
|
|
2444
|
+
readonly NULL: "NULL";
|
|
2445
|
+
readonly STRING: "STRING";
|
|
2446
|
+
};
|
|
2447
|
+
/**
|
|
2448
|
+
* @public
|
|
2449
|
+
*/
|
|
2450
|
+
export type RetrievalResultContentColumnType = (typeof RetrievalResultContentColumnType)[keyof typeof RetrievalResultContentColumnType];
|
|
2451
|
+
/**
|
|
2452
|
+
* <p>Contains information about a column with a cell to return in retrieval.</p>
|
|
2453
|
+
* @public
|
|
2454
|
+
*/
|
|
2455
|
+
export interface RetrievalResultContentColumn {
|
|
2456
|
+
/**
|
|
2457
|
+
* <p>The name of the column.</p>
|
|
2458
|
+
* @public
|
|
2459
|
+
*/
|
|
2460
|
+
columnName?: string | undefined;
|
|
2461
|
+
/**
|
|
2462
|
+
* <p>The value in the column.</p>
|
|
2463
|
+
* @public
|
|
2464
|
+
*/
|
|
2465
|
+
columnValue?: string | undefined;
|
|
2466
|
+
/**
|
|
2467
|
+
* <p>The data type of the value.</p>
|
|
2468
|
+
* @public
|
|
2469
|
+
*/
|
|
2470
|
+
type?: RetrievalResultContentColumnType | undefined;
|
|
2471
|
+
}
|
|
2472
|
+
/**
|
|
2473
|
+
* @public
|
|
2474
|
+
* @enum
|
|
2475
|
+
*/
|
|
2476
|
+
export declare const RetrievalResultContentType: {
|
|
2477
|
+
readonly IMAGE: "IMAGE";
|
|
2478
|
+
readonly ROW: "ROW";
|
|
2479
|
+
readonly TEXT: "TEXT";
|
|
2480
|
+
};
|
|
2481
|
+
/**
|
|
2482
|
+
* @public
|
|
2483
|
+
*/
|
|
2484
|
+
export type RetrievalResultContentType = (typeof RetrievalResultContentType)[keyof typeof RetrievalResultContentType];
|
|
2485
|
+
/**
|
|
2486
|
+
* <p>Contains information about a chunk of text from a data source in the knowledge base. If the result is from a structured data source, the cell in the database and the type of the value is also identified.</p>
|
|
1846
2487
|
* <p>This data type is used in the following API operations:</p>
|
|
1847
2488
|
* <ul>
|
|
1848
2489
|
* <li>
|
|
@@ -1861,11 +2502,26 @@ export interface GeneratedResponsePart {
|
|
|
1861
2502
|
* @public
|
|
1862
2503
|
*/
|
|
1863
2504
|
export interface RetrievalResultContent {
|
|
2505
|
+
/**
|
|
2506
|
+
* <p>The type of content in the retrieval result.</p>
|
|
2507
|
+
* @public
|
|
2508
|
+
*/
|
|
2509
|
+
type?: RetrievalResultContentType | undefined;
|
|
1864
2510
|
/**
|
|
1865
2511
|
* <p>The cited text from the data source.</p>
|
|
1866
2512
|
* @public
|
|
1867
2513
|
*/
|
|
1868
|
-
text
|
|
2514
|
+
text?: string | undefined;
|
|
2515
|
+
/**
|
|
2516
|
+
* <p>A data URI with base64-encoded content from the data source. The URI is in the following format: returned in the following format: <code>data:image/jpeg;base64,$\{base64-encoded string\}</code>.</p>
|
|
2517
|
+
* @public
|
|
2518
|
+
*/
|
|
2519
|
+
byteContent?: string | undefined;
|
|
2520
|
+
/**
|
|
2521
|
+
* <p>Specifies information about the rows with the cells to return in retrieval.</p>
|
|
2522
|
+
* @public
|
|
2523
|
+
*/
|
|
2524
|
+
row?: RetrievalResultContentColumn[] | undefined;
|
|
1869
2525
|
}
|
|
1870
2526
|
/**
|
|
1871
2527
|
* <p>The Confluence data source location.</p>
|
|
@@ -1889,6 +2545,17 @@ export interface RetrievalResultCustomDocumentLocation {
|
|
|
1889
2545
|
*/
|
|
1890
2546
|
id?: string | undefined;
|
|
1891
2547
|
}
|
|
2548
|
+
/**
|
|
2549
|
+
* <p>The location of a result in Amazon Kendra.</p>
|
|
2550
|
+
* @public
|
|
2551
|
+
*/
|
|
2552
|
+
export interface RetrievalResultKendraDocumentLocation {
|
|
2553
|
+
/**
|
|
2554
|
+
* <p>The document's uri.</p>
|
|
2555
|
+
* @public
|
|
2556
|
+
*/
|
|
2557
|
+
uri?: string | undefined;
|
|
2558
|
+
}
|
|
1892
2559
|
/**
|
|
1893
2560
|
* <p>The S3 data source location.</p>
|
|
1894
2561
|
* <p>This data type is used in the following API operations:</p>
|
|
@@ -1937,6 +2604,17 @@ export interface RetrievalResultSharePointLocation {
|
|
|
1937
2604
|
*/
|
|
1938
2605
|
url?: string | undefined;
|
|
1939
2606
|
}
|
|
2607
|
+
/**
|
|
2608
|
+
* <p>Contains information about the SQL query used to retrieve the result.</p>
|
|
2609
|
+
* @public
|
|
2610
|
+
*/
|
|
2611
|
+
export interface RetrievalResultSqlLocation {
|
|
2612
|
+
/**
|
|
2613
|
+
* <p>The SQL query used to retrieve the result.</p>
|
|
2614
|
+
* @public
|
|
2615
|
+
*/
|
|
2616
|
+
query?: string | undefined;
|
|
2617
|
+
}
|
|
1940
2618
|
/**
|
|
1941
2619
|
* @public
|
|
1942
2620
|
* @enum
|
|
@@ -1944,9 +2622,11 @@ export interface RetrievalResultSharePointLocation {
|
|
|
1944
2622
|
export declare const RetrievalResultLocationType: {
|
|
1945
2623
|
readonly CONFLUENCE: "CONFLUENCE";
|
|
1946
2624
|
readonly CUSTOM: "CUSTOM";
|
|
2625
|
+
readonly KENDRA: "KENDRA";
|
|
1947
2626
|
readonly S3: "S3";
|
|
1948
2627
|
readonly SALESFORCE: "SALESFORCE";
|
|
1949
2628
|
readonly SHAREPOINT: "SHAREPOINT";
|
|
2629
|
+
readonly SQL: "SQL";
|
|
1950
2630
|
readonly WEB: "WEB";
|
|
1951
2631
|
};
|
|
1952
2632
|
/**
|
|
@@ -1978,7 +2658,7 @@ export interface RetrievalResultWebLocation {
|
|
|
1978
2658
|
* </li>
|
|
1979
2659
|
* <li>
|
|
1980
2660
|
* <p>
|
|
1981
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>
|
|
2661
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a> – in the <code>location</code> field</p>
|
|
1982
2662
|
* </li>
|
|
1983
2663
|
* </ul>
|
|
1984
2664
|
* @public
|
|
@@ -2019,6 +2699,16 @@ export interface RetrievalResultLocation {
|
|
|
2019
2699
|
* @public
|
|
2020
2700
|
*/
|
|
2021
2701
|
customDocumentLocation?: RetrievalResultCustomDocumentLocation | undefined;
|
|
2702
|
+
/**
|
|
2703
|
+
* <p>The location of a document in Amazon Kendra.</p>
|
|
2704
|
+
* @public
|
|
2705
|
+
*/
|
|
2706
|
+
kendraDocumentLocation?: RetrievalResultKendraDocumentLocation | undefined;
|
|
2707
|
+
/**
|
|
2708
|
+
* <p>Specifies information about the SQL query used to retrieve the result.</p>
|
|
2709
|
+
* @public
|
|
2710
|
+
*/
|
|
2711
|
+
sqlLocation?: RetrievalResultSqlLocation | undefined;
|
|
2022
2712
|
}
|
|
2023
2713
|
/**
|
|
2024
2714
|
* <p>Contains metadata about a source cited for the generated response.</p>
|
|
@@ -2128,251 +2818,45 @@ export interface OutputFile {
|
|
|
2128
2818
|
bytes?: Uint8Array | undefined;
|
|
2129
2819
|
}
|
|
2130
2820
|
/**
|
|
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>
|
|
2285
|
-
* @public
|
|
2286
|
-
*/
|
|
2287
|
-
actionGroup: string | undefined;
|
|
2288
|
-
/**
|
|
2289
|
-
* <p>A list of parameters of the function.</p>
|
|
2290
|
-
* @public
|
|
2291
|
-
*/
|
|
2292
|
-
parameters?: FunctionParameter[] | undefined;
|
|
2293
|
-
/**
|
|
2294
|
-
* <p>The name of the function.</p>
|
|
2295
|
-
* @public
|
|
2296
|
-
*/
|
|
2297
|
-
function?: string | undefined;
|
|
2821
|
+
* <p>Contains intermediate response for code interpreter if any files have been generated.</p>
|
|
2822
|
+
* @public
|
|
2823
|
+
*/
|
|
2824
|
+
export interface FilePart {
|
|
2298
2825
|
/**
|
|
2299
|
-
* <p>
|
|
2826
|
+
* <p>Files containing intermediate response for the user.</p>
|
|
2300
2827
|
* @public
|
|
2301
2828
|
*/
|
|
2302
|
-
|
|
2829
|
+
files?: OutputFile[] | undefined;
|
|
2303
2830
|
}
|
|
2304
2831
|
/**
|
|
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>
|
|
2832
|
+
* <p>Details about a caller.</p>
|
|
2313
2833
|
* @public
|
|
2314
2834
|
*/
|
|
2315
|
-
export type
|
|
2835
|
+
export type Caller = Caller.AgentAliasArnMember | Caller.$UnknownMember;
|
|
2316
2836
|
/**
|
|
2317
2837
|
* @public
|
|
2318
2838
|
*/
|
|
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
|
-
}
|
|
2839
|
+
export declare namespace Caller {
|
|
2329
2840
|
/**
|
|
2330
|
-
* <p>
|
|
2841
|
+
* <p>The caller's agent alias ARN.</p>
|
|
2331
2842
|
* @public
|
|
2332
2843
|
*/
|
|
2333
|
-
interface
|
|
2334
|
-
|
|
2335
|
-
functionInvocationInput: FunctionInvocationInput;
|
|
2844
|
+
interface AgentAliasArnMember {
|
|
2845
|
+
agentAliasArn: string;
|
|
2336
2846
|
$unknown?: never;
|
|
2337
2847
|
}
|
|
2338
2848
|
/**
|
|
2339
2849
|
* @public
|
|
2340
2850
|
*/
|
|
2341
2851
|
interface $UnknownMember {
|
|
2342
|
-
|
|
2343
|
-
functionInvocationInput?: never;
|
|
2852
|
+
agentAliasArn?: never;
|
|
2344
2853
|
$unknown: [string, any];
|
|
2345
2854
|
}
|
|
2346
2855
|
interface Visitor<T> {
|
|
2347
|
-
|
|
2348
|
-
functionInvocationInput: (value: FunctionInvocationInput) => T;
|
|
2856
|
+
agentAliasArn: (value: string) => T;
|
|
2349
2857
|
_: (name: string, value: any) => T;
|
|
2350
2858
|
}
|
|
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;
|
|
2859
|
+
const visit: <T>(value: Caller, visitor: Visitor<T>) => T;
|
|
2376
2860
|
}
|
|
2377
2861
|
/**
|
|
2378
2862
|
* <p>
|
|
@@ -2832,6 +3316,7 @@ export interface CodeInterpreterInvocationInput {
|
|
|
2832
3316
|
export declare const InvocationType: {
|
|
2833
3317
|
readonly ACTION_GROUP: "ACTION_GROUP";
|
|
2834
3318
|
readonly ACTION_GROUP_CODE_INTERPRETER: "ACTION_GROUP_CODE_INTERPRETER";
|
|
3319
|
+
readonly AGENT_COLLABORATOR: "AGENT_COLLABORATOR";
|
|
2835
3320
|
readonly FINISH: "FINISH";
|
|
2836
3321
|
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
2837
3322
|
};
|
|
@@ -2885,6 +3370,11 @@ export interface InvocationInput {
|
|
|
2885
3370
|
* @public
|
|
2886
3371
|
*/
|
|
2887
3372
|
codeInterpreterInvocationInput?: CodeInterpreterInvocationInput | undefined;
|
|
3373
|
+
/**
|
|
3374
|
+
* <p>The collaborator's invocation input.</p>
|
|
3375
|
+
* @public
|
|
3376
|
+
*/
|
|
3377
|
+
agentCollaboratorInvocationInput?: AgentCollaboratorInvocationInput | undefined;
|
|
2888
3378
|
}
|
|
2889
3379
|
/**
|
|
2890
3380
|
* <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 +3485,11 @@ export interface ModelInvocationInput {
|
|
|
2995
3485
|
* @public
|
|
2996
3486
|
*/
|
|
2997
3487
|
parserMode?: CreationMode | undefined;
|
|
3488
|
+
/**
|
|
3489
|
+
* <p>The identifier of a foundation model.</p>
|
|
3490
|
+
* @public
|
|
3491
|
+
*/
|
|
3492
|
+
foundationModel?: string | undefined;
|
|
2998
3493
|
}
|
|
2999
3494
|
/**
|
|
3000
3495
|
* <p>Contains information of the usage of the foundation model.</p>
|
|
@@ -3138,6 +3633,7 @@ export interface RepromptResponse {
|
|
|
3138
3633
|
*/
|
|
3139
3634
|
export declare const Type: {
|
|
3140
3635
|
readonly ACTION_GROUP: "ACTION_GROUP";
|
|
3636
|
+
readonly AGENT_COLLABORATOR: "AGENT_COLLABORATOR";
|
|
3141
3637
|
readonly ASK_USER: "ASK_USER";
|
|
3142
3638
|
readonly FINISH: "FINISH";
|
|
3143
3639
|
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
@@ -3189,6 +3685,11 @@ export interface Observation {
|
|
|
3189
3685
|
* @public
|
|
3190
3686
|
*/
|
|
3191
3687
|
actionGroupInvocationOutput?: ActionGroupInvocationOutput | undefined;
|
|
3688
|
+
/**
|
|
3689
|
+
* <p>A collaborator's invocation output.</p>
|
|
3690
|
+
* @public
|
|
3691
|
+
*/
|
|
3692
|
+
agentCollaboratorInvocationOutput?: AgentCollaboratorInvocationOutput | undefined;
|
|
3192
3693
|
/**
|
|
3193
3694
|
* <p>Contains details about the results from looking up the knowledge base.</p>
|
|
3194
3695
|
* @public
|
|
@@ -3520,11 +4021,104 @@ export declare namespace PreProcessingTrace {
|
|
|
3520
4021
|
}
|
|
3521
4022
|
const visit: <T>(value: PreProcessingTrace, visitor: Visitor<T>) => T;
|
|
3522
4023
|
}
|
|
4024
|
+
/**
|
|
4025
|
+
* <p>Invocation output from a routing classifier model.</p>
|
|
4026
|
+
* @public
|
|
4027
|
+
*/
|
|
4028
|
+
export interface RoutingClassifierModelInvocationOutput {
|
|
4029
|
+
/**
|
|
4030
|
+
* <p>The invocation's trace ID.</p>
|
|
4031
|
+
* @public
|
|
4032
|
+
*/
|
|
4033
|
+
traceId?: string | undefined;
|
|
4034
|
+
/**
|
|
4035
|
+
* <p>The invocation's raw response.</p>
|
|
4036
|
+
* @public
|
|
4037
|
+
*/
|
|
4038
|
+
rawResponse?: RawResponse | undefined;
|
|
4039
|
+
/**
|
|
4040
|
+
* <p>The invocation's metadata.</p>
|
|
4041
|
+
* @public
|
|
4042
|
+
*/
|
|
4043
|
+
metadata?: Metadata | undefined;
|
|
4044
|
+
}
|
|
4045
|
+
/**
|
|
4046
|
+
* <p>A trace for a routing classifier.</p>
|
|
4047
|
+
* @public
|
|
4048
|
+
*/
|
|
4049
|
+
export type RoutingClassifierTrace = RoutingClassifierTrace.InvocationInputMember | RoutingClassifierTrace.ModelInvocationInputMember | RoutingClassifierTrace.ModelInvocationOutputMember | RoutingClassifierTrace.ObservationMember | RoutingClassifierTrace.$UnknownMember;
|
|
4050
|
+
/**
|
|
4051
|
+
* @public
|
|
4052
|
+
*/
|
|
4053
|
+
export declare namespace RoutingClassifierTrace {
|
|
4054
|
+
/**
|
|
4055
|
+
* <p>The classifier's invocation input.</p>
|
|
4056
|
+
* @public
|
|
4057
|
+
*/
|
|
4058
|
+
interface InvocationInputMember {
|
|
4059
|
+
invocationInput: InvocationInput;
|
|
4060
|
+
observation?: never;
|
|
4061
|
+
modelInvocationInput?: never;
|
|
4062
|
+
modelInvocationOutput?: never;
|
|
4063
|
+
$unknown?: never;
|
|
4064
|
+
}
|
|
4065
|
+
/**
|
|
4066
|
+
* <p>The classifier's observation.</p>
|
|
4067
|
+
* @public
|
|
4068
|
+
*/
|
|
4069
|
+
interface ObservationMember {
|
|
4070
|
+
invocationInput?: never;
|
|
4071
|
+
observation: Observation;
|
|
4072
|
+
modelInvocationInput?: never;
|
|
4073
|
+
modelInvocationOutput?: never;
|
|
4074
|
+
$unknown?: never;
|
|
4075
|
+
}
|
|
4076
|
+
/**
|
|
4077
|
+
* <p>The classifier's model invocation input.</p>
|
|
4078
|
+
* @public
|
|
4079
|
+
*/
|
|
4080
|
+
interface ModelInvocationInputMember {
|
|
4081
|
+
invocationInput?: never;
|
|
4082
|
+
observation?: never;
|
|
4083
|
+
modelInvocationInput: ModelInvocationInput;
|
|
4084
|
+
modelInvocationOutput?: never;
|
|
4085
|
+
$unknown?: never;
|
|
4086
|
+
}
|
|
4087
|
+
/**
|
|
4088
|
+
* <p>The classifier's model invocation output.</p>
|
|
4089
|
+
* @public
|
|
4090
|
+
*/
|
|
4091
|
+
interface ModelInvocationOutputMember {
|
|
4092
|
+
invocationInput?: never;
|
|
4093
|
+
observation?: never;
|
|
4094
|
+
modelInvocationInput?: never;
|
|
4095
|
+
modelInvocationOutput: RoutingClassifierModelInvocationOutput;
|
|
4096
|
+
$unknown?: never;
|
|
4097
|
+
}
|
|
4098
|
+
/**
|
|
4099
|
+
* @public
|
|
4100
|
+
*/
|
|
4101
|
+
interface $UnknownMember {
|
|
4102
|
+
invocationInput?: never;
|
|
4103
|
+
observation?: never;
|
|
4104
|
+
modelInvocationInput?: never;
|
|
4105
|
+
modelInvocationOutput?: never;
|
|
4106
|
+
$unknown: [string, any];
|
|
4107
|
+
}
|
|
4108
|
+
interface Visitor<T> {
|
|
4109
|
+
invocationInput: (value: InvocationInput) => T;
|
|
4110
|
+
observation: (value: Observation) => T;
|
|
4111
|
+
modelInvocationInput: (value: ModelInvocationInput) => T;
|
|
4112
|
+
modelInvocationOutput: (value: RoutingClassifierModelInvocationOutput) => T;
|
|
4113
|
+
_: (name: string, value: any) => T;
|
|
4114
|
+
}
|
|
4115
|
+
const visit: <T>(value: RoutingClassifierTrace, visitor: Visitor<T>) => T;
|
|
4116
|
+
}
|
|
3523
4117
|
/**
|
|
3524
4118
|
* <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
4119
|
* @public
|
|
3526
4120
|
*/
|
|
3527
|
-
export type Trace = Trace.CustomOrchestrationTraceMember | Trace.FailureTraceMember | Trace.GuardrailTraceMember | Trace.OrchestrationTraceMember | Trace.PostProcessingTraceMember | Trace.PreProcessingTraceMember | Trace.$UnknownMember;
|
|
4121
|
+
export type Trace = Trace.CustomOrchestrationTraceMember | Trace.FailureTraceMember | Trace.GuardrailTraceMember | Trace.OrchestrationTraceMember | Trace.PostProcessingTraceMember | Trace.PreProcessingTraceMember | Trace.RoutingClassifierTraceMember | Trace.$UnknownMember;
|
|
3528
4122
|
/**
|
|
3529
4123
|
* @public
|
|
3530
4124
|
*/
|
|
@@ -3538,6 +4132,7 @@ export declare namespace Trace {
|
|
|
3538
4132
|
preProcessingTrace?: never;
|
|
3539
4133
|
orchestrationTrace?: never;
|
|
3540
4134
|
postProcessingTrace?: never;
|
|
4135
|
+
routingClassifierTrace?: never;
|
|
3541
4136
|
failureTrace?: never;
|
|
3542
4137
|
customOrchestrationTrace?: never;
|
|
3543
4138
|
$unknown?: never;
|
|
@@ -3551,6 +4146,7 @@ export declare namespace Trace {
|
|
|
3551
4146
|
preProcessingTrace: PreProcessingTrace;
|
|
3552
4147
|
orchestrationTrace?: never;
|
|
3553
4148
|
postProcessingTrace?: never;
|
|
4149
|
+
routingClassifierTrace?: never;
|
|
3554
4150
|
failureTrace?: never;
|
|
3555
4151
|
customOrchestrationTrace?: never;
|
|
3556
4152
|
$unknown?: never;
|
|
@@ -3564,6 +4160,7 @@ export declare namespace Trace {
|
|
|
3564
4160
|
preProcessingTrace?: never;
|
|
3565
4161
|
orchestrationTrace: OrchestrationTrace;
|
|
3566
4162
|
postProcessingTrace?: never;
|
|
4163
|
+
routingClassifierTrace?: never;
|
|
3567
4164
|
failureTrace?: never;
|
|
3568
4165
|
customOrchestrationTrace?: never;
|
|
3569
4166
|
$unknown?: never;
|
|
@@ -3577,6 +4174,21 @@ export declare namespace Trace {
|
|
|
3577
4174
|
preProcessingTrace?: never;
|
|
3578
4175
|
orchestrationTrace?: never;
|
|
3579
4176
|
postProcessingTrace: PostProcessingTrace;
|
|
4177
|
+
routingClassifierTrace?: never;
|
|
4178
|
+
failureTrace?: never;
|
|
4179
|
+
customOrchestrationTrace?: never;
|
|
4180
|
+
$unknown?: never;
|
|
4181
|
+
}
|
|
4182
|
+
/**
|
|
4183
|
+
* <p>A routing classifier's trace.</p>
|
|
4184
|
+
* @public
|
|
4185
|
+
*/
|
|
4186
|
+
interface RoutingClassifierTraceMember {
|
|
4187
|
+
guardrailTrace?: never;
|
|
4188
|
+
preProcessingTrace?: never;
|
|
4189
|
+
orchestrationTrace?: never;
|
|
4190
|
+
postProcessingTrace?: never;
|
|
4191
|
+
routingClassifierTrace: RoutingClassifierTrace;
|
|
3580
4192
|
failureTrace?: never;
|
|
3581
4193
|
customOrchestrationTrace?: never;
|
|
3582
4194
|
$unknown?: never;
|
|
@@ -3590,6 +4202,7 @@ export declare namespace Trace {
|
|
|
3590
4202
|
preProcessingTrace?: never;
|
|
3591
4203
|
orchestrationTrace?: never;
|
|
3592
4204
|
postProcessingTrace?: never;
|
|
4205
|
+
routingClassifierTrace?: never;
|
|
3593
4206
|
failureTrace: FailureTrace;
|
|
3594
4207
|
customOrchestrationTrace?: never;
|
|
3595
4208
|
$unknown?: never;
|
|
@@ -3605,6 +4218,7 @@ export declare namespace Trace {
|
|
|
3605
4218
|
preProcessingTrace?: never;
|
|
3606
4219
|
orchestrationTrace?: never;
|
|
3607
4220
|
postProcessingTrace?: never;
|
|
4221
|
+
routingClassifierTrace?: never;
|
|
3608
4222
|
failureTrace?: never;
|
|
3609
4223
|
customOrchestrationTrace: CustomOrchestrationTrace;
|
|
3610
4224
|
$unknown?: never;
|
|
@@ -3617,6 +4231,7 @@ export declare namespace Trace {
|
|
|
3617
4231
|
preProcessingTrace?: never;
|
|
3618
4232
|
orchestrationTrace?: never;
|
|
3619
4233
|
postProcessingTrace?: never;
|
|
4234
|
+
routingClassifierTrace?: never;
|
|
3620
4235
|
failureTrace?: never;
|
|
3621
4236
|
customOrchestrationTrace?: never;
|
|
3622
4237
|
$unknown: [string, any];
|
|
@@ -3626,6 +4241,7 @@ export declare namespace Trace {
|
|
|
3626
4241
|
preProcessingTrace: (value: PreProcessingTrace) => T;
|
|
3627
4242
|
orchestrationTrace: (value: OrchestrationTrace) => T;
|
|
3628
4243
|
postProcessingTrace: (value: PostProcessingTrace) => T;
|
|
4244
|
+
routingClassifierTrace: (value: RoutingClassifierTrace) => T;
|
|
3629
4245
|
failureTrace: (value: FailureTrace) => T;
|
|
3630
4246
|
customOrchestrationTrace: (value: CustomOrchestrationTrace) => T;
|
|
3631
4247
|
_: (name: string, value: any) => T;
|
|
@@ -3662,6 +4278,16 @@ export interface TracePart {
|
|
|
3662
4278
|
* @public
|
|
3663
4279
|
*/
|
|
3664
4280
|
agentVersion?: string | undefined;
|
|
4281
|
+
/**
|
|
4282
|
+
* <p>The part's caller chain.</p>
|
|
4283
|
+
* @public
|
|
4284
|
+
*/
|
|
4285
|
+
callerChain?: Caller[] | undefined;
|
|
4286
|
+
/**
|
|
4287
|
+
* <p>The part's collaborator name.</p>
|
|
4288
|
+
* @public
|
|
4289
|
+
*/
|
|
4290
|
+
collaboratorName?: string | undefined;
|
|
3665
4291
|
}
|
|
3666
4292
|
/**
|
|
3667
4293
|
* <p>The response from invoking the agent and associated citations and trace information.</p>
|
|
@@ -5954,7 +6580,7 @@ export interface KnowledgeBaseQuery {
|
|
|
5954
6580
|
*/
|
|
5955
6581
|
export interface KnowledgeBaseRetrievalResult {
|
|
5956
6582
|
/**
|
|
5957
|
-
* <p>Contains
|
|
6583
|
+
* <p>Contains information about the content of the chunk.</p>
|
|
5958
6584
|
* @public
|
|
5959
6585
|
*/
|
|
5960
6586
|
content: RetrievalResultContent | undefined;
|
|
@@ -6768,6 +7394,11 @@ export interface SessionState {
|
|
|
6768
7394
|
* @public
|
|
6769
7395
|
*/
|
|
6770
7396
|
knowledgeBaseConfigurations?: KnowledgeBaseConfiguration[] | undefined;
|
|
7397
|
+
/**
|
|
7398
|
+
* <p>The state's conversation history.</p>
|
|
7399
|
+
* @public
|
|
7400
|
+
*/
|
|
7401
|
+
conversationHistory?: ConversationHistory | undefined;
|
|
6771
7402
|
}
|
|
6772
7403
|
/**
|
|
6773
7404
|
* @public
|
|
@@ -6826,6 +7457,11 @@ export interface InvokeAgentRequest {
|
|
|
6826
7457
|
* @public
|
|
6827
7458
|
*/
|
|
6828
7459
|
streamingConfigurations?: StreamingConfigurations | undefined;
|
|
7460
|
+
/**
|
|
7461
|
+
* <p>The ARN of the resource making the request.</p>
|
|
7462
|
+
* @public
|
|
7463
|
+
*/
|
|
7464
|
+
sourceArn?: string | undefined;
|
|
6829
7465
|
}
|
|
6830
7466
|
/**
|
|
6831
7467
|
* @internal
|
|
@@ -6851,6 +7487,50 @@ export declare const FunctionSchemaFilterSensitiveLog: (obj: FunctionSchema) =>
|
|
|
6851
7487
|
* @internal
|
|
6852
7488
|
*/
|
|
6853
7489
|
export declare const AgentActionGroupFilterSensitiveLog: (obj: AgentActionGroup) => any;
|
|
7490
|
+
/**
|
|
7491
|
+
* @internal
|
|
7492
|
+
*/
|
|
7493
|
+
export declare const ApiResultFilterSensitiveLog: (obj: ApiResult) => any;
|
|
7494
|
+
/**
|
|
7495
|
+
* @internal
|
|
7496
|
+
*/
|
|
7497
|
+
export declare const InvocationResultMemberFilterSensitiveLog: (obj: InvocationResultMember) => any;
|
|
7498
|
+
/**
|
|
7499
|
+
* @internal
|
|
7500
|
+
*/
|
|
7501
|
+
export declare const ReturnControlResultsFilterSensitiveLog: (obj: ReturnControlResults) => any;
|
|
7502
|
+
/**
|
|
7503
|
+
* @internal
|
|
7504
|
+
*/
|
|
7505
|
+
export declare const AgentCollaboratorInputPayloadFilterSensitiveLog: (obj: AgentCollaboratorInputPayload) => any;
|
|
7506
|
+
/**
|
|
7507
|
+
* @internal
|
|
7508
|
+
*/
|
|
7509
|
+
export declare const AgentCollaboratorInvocationInputFilterSensitiveLog: (obj: AgentCollaboratorInvocationInput) => any;
|
|
7510
|
+
/**
|
|
7511
|
+
* @internal
|
|
7512
|
+
*/
|
|
7513
|
+
export declare const ApiInvocationInputFilterSensitiveLog: (obj: ApiInvocationInput) => any;
|
|
7514
|
+
/**
|
|
7515
|
+
* @internal
|
|
7516
|
+
*/
|
|
7517
|
+
export declare const FunctionInvocationInputFilterSensitiveLog: (obj: FunctionInvocationInput) => any;
|
|
7518
|
+
/**
|
|
7519
|
+
* @internal
|
|
7520
|
+
*/
|
|
7521
|
+
export declare const InvocationInputMemberFilterSensitiveLog: (obj: InvocationInputMember) => any;
|
|
7522
|
+
/**
|
|
7523
|
+
* @internal
|
|
7524
|
+
*/
|
|
7525
|
+
export declare const ReturnControlPayloadFilterSensitiveLog: (obj: ReturnControlPayload) => any;
|
|
7526
|
+
/**
|
|
7527
|
+
* @internal
|
|
7528
|
+
*/
|
|
7529
|
+
export declare const AgentCollaboratorOutputPayloadFilterSensitiveLog: (obj: AgentCollaboratorOutputPayload) => any;
|
|
7530
|
+
/**
|
|
7531
|
+
* @internal
|
|
7532
|
+
*/
|
|
7533
|
+
export declare const AgentCollaboratorInvocationOutputFilterSensitiveLog: (obj: AgentCollaboratorInvocationOutput) => any;
|
|
6854
7534
|
/**
|
|
6855
7535
|
* @internal
|
|
6856
7536
|
*/
|
|
@@ -6915,6 +7595,34 @@ export declare const FlowResponseStreamFilterSensitiveLog: (obj: FlowResponseStr
|
|
|
6915
7595
|
* @internal
|
|
6916
7596
|
*/
|
|
6917
7597
|
export declare const InvokeFlowResponseFilterSensitiveLog: (obj: InvokeFlowResponse) => any;
|
|
7598
|
+
/**
|
|
7599
|
+
* @internal
|
|
7600
|
+
*/
|
|
7601
|
+
export declare const QueryGenerationInputFilterSensitiveLog: (obj: QueryGenerationInput) => any;
|
|
7602
|
+
/**
|
|
7603
|
+
* @internal
|
|
7604
|
+
*/
|
|
7605
|
+
export declare const GenerateQueryRequestFilterSensitiveLog: (obj: GenerateQueryRequest) => any;
|
|
7606
|
+
/**
|
|
7607
|
+
* @internal
|
|
7608
|
+
*/
|
|
7609
|
+
export declare const GeneratedQueryFilterSensitiveLog: (obj: GeneratedQuery) => any;
|
|
7610
|
+
/**
|
|
7611
|
+
* @internal
|
|
7612
|
+
*/
|
|
7613
|
+
export declare const GenerateQueryResponseFilterSensitiveLog: (obj: GenerateQueryResponse) => any;
|
|
7614
|
+
/**
|
|
7615
|
+
* @internal
|
|
7616
|
+
*/
|
|
7617
|
+
export declare const ContentBlockFilterSensitiveLog: (obj: ContentBlock) => any;
|
|
7618
|
+
/**
|
|
7619
|
+
* @internal
|
|
7620
|
+
*/
|
|
7621
|
+
export declare const MessageFilterSensitiveLog: (obj: Message) => any;
|
|
7622
|
+
/**
|
|
7623
|
+
* @internal
|
|
7624
|
+
*/
|
|
7625
|
+
export declare const ConversationHistoryFilterSensitiveLog: (obj: ConversationHistory) => any;
|
|
6918
7626
|
/**
|
|
6919
7627
|
* @internal
|
|
6920
7628
|
*/
|
|
@@ -6954,19 +7662,15 @@ export declare const VectorSearchRerankingConfigurationFilterSensitiveLog: (obj:
|
|
|
6954
7662
|
/**
|
|
6955
7663
|
* @internal
|
|
6956
7664
|
*/
|
|
6957
|
-
export declare const
|
|
6958
|
-
/**
|
|
6959
|
-
* @internal
|
|
6960
|
-
*/
|
|
6961
|
-
export declare const InvocationResultMemberFilterSensitiveLog: (obj: InvocationResultMember) => any;
|
|
7665
|
+
export declare const TextResponsePartFilterSensitiveLog: (obj: TextResponsePart) => any;
|
|
6962
7666
|
/**
|
|
6963
7667
|
* @internal
|
|
6964
7668
|
*/
|
|
6965
|
-
export declare const
|
|
7669
|
+
export declare const GeneratedResponsePartFilterSensitiveLog: (obj: GeneratedResponsePart) => any;
|
|
6966
7670
|
/**
|
|
6967
7671
|
* @internal
|
|
6968
7672
|
*/
|
|
6969
|
-
export declare const
|
|
7673
|
+
export declare const RetrievalResultContentColumnFilterSensitiveLog: (obj: RetrievalResultContentColumn) => any;
|
|
6970
7674
|
/**
|
|
6971
7675
|
* @internal
|
|
6972
7676
|
*/
|
|
@@ -6999,18 +7703,6 @@ export declare const OutputFileFilterSensitiveLog: (obj: OutputFile) => any;
|
|
|
6999
7703
|
* @internal
|
|
7000
7704
|
*/
|
|
7001
7705
|
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
7706
|
/**
|
|
7015
7707
|
* @internal
|
|
7016
7708
|
*/
|
|
@@ -7147,6 +7839,14 @@ export declare const PreProcessingModelInvocationOutputFilterSensitiveLog: (obj:
|
|
|
7147
7839
|
* @internal
|
|
7148
7840
|
*/
|
|
7149
7841
|
export declare const PreProcessingTraceFilterSensitiveLog: (obj: PreProcessingTrace) => any;
|
|
7842
|
+
/**
|
|
7843
|
+
* @internal
|
|
7844
|
+
*/
|
|
7845
|
+
export declare const RoutingClassifierModelInvocationOutputFilterSensitiveLog: (obj: RoutingClassifierModelInvocationOutput) => any;
|
|
7846
|
+
/**
|
|
7847
|
+
* @internal
|
|
7848
|
+
*/
|
|
7849
|
+
export declare const RoutingClassifierTraceFilterSensitiveLog: (obj: RoutingClassifierTrace) => any;
|
|
7150
7850
|
/**
|
|
7151
7851
|
* @internal
|
|
7152
7852
|
*/
|