@aws-sdk/client-bedrock-agent-runtime 3.701.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/README.md +16 -0
- package/dist-cjs/index.js +791 -66
- package/dist-es/BedrockAgentRuntime.js +4 -0
- package/dist-es/commands/RerankCommand.js +23 -0
- package/dist-es/commands/RetrieveAndGenerateStreamCommand.js +27 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +345 -48
- package/dist-es/pagination/RerankPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +277 -3
- package/dist-types/BedrockAgentRuntime.d.ts +14 -0
- package/dist-types/BedrockAgentRuntimeClient.d.ts +4 -2
- package/dist-types/commands/InvokeAgentCommand.d.ts +396 -22
- package/dist-types/commands/InvokeInlineAgentCommand.d.ts +376 -21
- package/dist-types/commands/RerankCommand.d.ts +143 -0
- package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +42 -2
- package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +371 -0
- package/dist-types/commands/RetrieveCommand.d.ts +46 -1
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +1713 -404
- package/dist-types/pagination/RerankPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +34 -0
- package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/RerankCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/RetrieveAndGenerateStreamCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +764 -110
- package/dist-types/ts3.4/pagination/RerankPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -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
|
|
@@ -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
|
|
@@ -1357,6 +1982,57 @@ export interface FilterAttribute {
|
|
|
1357
1982
|
*/
|
|
1358
1983
|
value: __DocumentType | undefined;
|
|
1359
1984
|
}
|
|
1985
|
+
/**
|
|
1986
|
+
* @public
|
|
1987
|
+
* @enum
|
|
1988
|
+
*/
|
|
1989
|
+
export declare const AttributeType: {
|
|
1990
|
+
readonly BOOLEAN: "BOOLEAN";
|
|
1991
|
+
readonly NUMBER: "NUMBER";
|
|
1992
|
+
readonly STRING: "STRING";
|
|
1993
|
+
readonly STRING_LIST: "STRING_LIST";
|
|
1994
|
+
};
|
|
1995
|
+
/**
|
|
1996
|
+
* @public
|
|
1997
|
+
*/
|
|
1998
|
+
export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType];
|
|
1999
|
+
/**
|
|
2000
|
+
* <p>Details about a metadata attribute.</p>
|
|
2001
|
+
* @public
|
|
2002
|
+
*/
|
|
2003
|
+
export interface MetadataAttributeSchema {
|
|
2004
|
+
/**
|
|
2005
|
+
* <p>The attribute's key.</p>
|
|
2006
|
+
* @public
|
|
2007
|
+
*/
|
|
2008
|
+
key: string | undefined;
|
|
2009
|
+
/**
|
|
2010
|
+
* <p>The attribute's type.</p>
|
|
2011
|
+
* @public
|
|
2012
|
+
*/
|
|
2013
|
+
type: AttributeType | undefined;
|
|
2014
|
+
/**
|
|
2015
|
+
* <p>The attribute's description.</p>
|
|
2016
|
+
* @public
|
|
2017
|
+
*/
|
|
2018
|
+
description: string | undefined;
|
|
2019
|
+
}
|
|
2020
|
+
/**
|
|
2021
|
+
* <p>Settings for implicit filtering, where a model generates a metadata filter based on the prompt.</p>
|
|
2022
|
+
* @public
|
|
2023
|
+
*/
|
|
2024
|
+
export interface ImplicitFilterConfiguration {
|
|
2025
|
+
/**
|
|
2026
|
+
* <p>Metadata that can be used in a filter.</p>
|
|
2027
|
+
* @public
|
|
2028
|
+
*/
|
|
2029
|
+
metadataAttributes: MetadataAttributeSchema[] | undefined;
|
|
2030
|
+
/**
|
|
2031
|
+
* <p>The model that generates the filter.</p>
|
|
2032
|
+
* @public
|
|
2033
|
+
*/
|
|
2034
|
+
modelArn: string | undefined;
|
|
2035
|
+
}
|
|
1360
2036
|
/**
|
|
1361
2037
|
* @public
|
|
1362
2038
|
* @enum
|
|
@@ -1373,179 +2049,146 @@ export type SearchType = (typeof SearchType)[keyof typeof SearchType];
|
|
|
1373
2049
|
* @public
|
|
1374
2050
|
* @enum
|
|
1375
2051
|
*/
|
|
1376
|
-
export declare const
|
|
1377
|
-
readonly
|
|
1378
|
-
readonly
|
|
2052
|
+
export declare const RerankingMetadataSelectionMode: {
|
|
2053
|
+
readonly ALL: "ALL";
|
|
2054
|
+
readonly SELECTIVE: "SELECTIVE";
|
|
1379
2055
|
};
|
|
1380
2056
|
/**
|
|
1381
2057
|
* @public
|
|
1382
2058
|
*/
|
|
1383
|
-
export type
|
|
2059
|
+
export type RerankingMetadataSelectionMode = (typeof RerankingMetadataSelectionMode)[keyof typeof RerankingMetadataSelectionMode];
|
|
1384
2060
|
/**
|
|
1385
|
-
* <p>Contains
|
|
1386
|
-
* <p>This data type is used in the following API operations:</p>
|
|
1387
|
-
* <ul>
|
|
1388
|
-
* <li>
|
|
1389
|
-
* <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>
|
|
1390
|
-
* </p>
|
|
1391
|
-
* </li>
|
|
1392
|
-
* </ul>
|
|
2061
|
+
* <p>Contains information for a metadata field to include in or exclude from consideration when reranking.</p>
|
|
1393
2062
|
* @public
|
|
1394
2063
|
*/
|
|
1395
|
-
export interface
|
|
2064
|
+
export interface FieldForReranking {
|
|
1396
2065
|
/**
|
|
1397
|
-
* <p>The
|
|
2066
|
+
* <p>The name of a metadata field to include in or exclude from consideration when reranking.</p>
|
|
1398
2067
|
* @public
|
|
1399
2068
|
*/
|
|
1400
|
-
|
|
2069
|
+
fieldName: string | undefined;
|
|
1401
2070
|
}
|
|
1402
2071
|
/**
|
|
1403
|
-
*
|
|
1404
|
-
* @enum
|
|
1405
|
-
*/
|
|
1406
|
-
export declare const ResponseState: {
|
|
1407
|
-
readonly FAILURE: "FAILURE";
|
|
1408
|
-
readonly REPROMPT: "REPROMPT";
|
|
1409
|
-
};
|
|
1410
|
-
/**
|
|
2072
|
+
* <p>Contains configurations for the metadata fields to include or exclude when considering reranking. If you include the <code>fieldsToExclude</code> field, the reranker ignores all the metadata fields that you specify. If you include the <code>fieldsToInclude</code> field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.</p>
|
|
1411
2073
|
* @public
|
|
1412
2074
|
*/
|
|
1413
|
-
export type
|
|
2075
|
+
export type RerankingMetadataSelectiveModeConfiguration = RerankingMetadataSelectiveModeConfiguration.FieldsToExcludeMember | RerankingMetadataSelectiveModeConfiguration.FieldsToIncludeMember | RerankingMetadataSelectiveModeConfiguration.$UnknownMember;
|
|
1414
2076
|
/**
|
|
1415
|
-
* <p>Contains information about the API operation that was called from the action group and the response body that was returned.</p>
|
|
1416
|
-
* <p>This data type is used in the following API operations:</p>
|
|
1417
|
-
* <ul>
|
|
1418
|
-
* <li>
|
|
1419
|
-
* <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>
|
|
1420
|
-
* </p>
|
|
1421
|
-
* </li>
|
|
1422
|
-
* </ul>
|
|
1423
2077
|
* @public
|
|
1424
2078
|
*/
|
|
1425
|
-
export
|
|
1426
|
-
/**
|
|
1427
|
-
* <p>The action group that the API operation belongs to.</p>
|
|
1428
|
-
* @public
|
|
1429
|
-
*/
|
|
1430
|
-
actionGroup: string | undefined;
|
|
1431
|
-
/**
|
|
1432
|
-
* <p>The HTTP method for the API operation.</p>
|
|
1433
|
-
* @public
|
|
1434
|
-
*/
|
|
1435
|
-
httpMethod?: string | undefined;
|
|
2079
|
+
export declare namespace RerankingMetadataSelectiveModeConfiguration {
|
|
1436
2080
|
/**
|
|
1437
|
-
* <p>
|
|
2081
|
+
* <p>An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.</p>
|
|
1438
2082
|
* @public
|
|
1439
2083
|
*/
|
|
1440
|
-
|
|
2084
|
+
interface FieldsToIncludeMember {
|
|
2085
|
+
fieldsToInclude: FieldForReranking[];
|
|
2086
|
+
fieldsToExclude?: never;
|
|
2087
|
+
$unknown?: never;
|
|
2088
|
+
}
|
|
1441
2089
|
/**
|
|
1442
|
-
* <p>
|
|
2090
|
+
* <p>An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.</p>
|
|
1443
2091
|
* @public
|
|
1444
2092
|
*/
|
|
1445
|
-
|
|
2093
|
+
interface FieldsToExcludeMember {
|
|
2094
|
+
fieldsToInclude?: never;
|
|
2095
|
+
fieldsToExclude: FieldForReranking[];
|
|
2096
|
+
$unknown?: never;
|
|
2097
|
+
}
|
|
1446
2098
|
/**
|
|
1447
|
-
* <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>
|
|
1448
2099
|
* @public
|
|
1449
2100
|
*/
|
|
1450
|
-
|
|
2101
|
+
interface $UnknownMember {
|
|
2102
|
+
fieldsToInclude?: never;
|
|
2103
|
+
fieldsToExclude?: never;
|
|
2104
|
+
$unknown: [string, any];
|
|
2105
|
+
}
|
|
2106
|
+
interface Visitor<T> {
|
|
2107
|
+
fieldsToInclude: (value: FieldForReranking[]) => T;
|
|
2108
|
+
fieldsToExclude: (value: FieldForReranking[]) => T;
|
|
2109
|
+
_: (name: string, value: any) => T;
|
|
2110
|
+
}
|
|
2111
|
+
const visit: <T>(value: RerankingMetadataSelectiveModeConfiguration, visitor: Visitor<T>) => T;
|
|
2112
|
+
}
|
|
2113
|
+
/**
|
|
2114
|
+
* <p>Contains configurations for the metadata to use in reranking.</p>
|
|
2115
|
+
* @public
|
|
2116
|
+
*/
|
|
2117
|
+
export interface MetadataConfigurationForReranking {
|
|
1451
2118
|
/**
|
|
1452
|
-
* <p>
|
|
2119
|
+
* <p>Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify <code>SELECTIVE</code>, include the <code>selectiveModeConfiguration</code> field.</p>
|
|
1453
2120
|
* @public
|
|
1454
2121
|
*/
|
|
1455
|
-
|
|
2122
|
+
selectionMode: RerankingMetadataSelectionMode | undefined;
|
|
1456
2123
|
/**
|
|
1457
|
-
* <p>
|
|
2124
|
+
* <p>Contains configurations for the metadata fields to include or exclude when considering reranking.</p>
|
|
1458
2125
|
* @public
|
|
1459
2126
|
*/
|
|
1460
|
-
|
|
2127
|
+
selectiveModeConfiguration?: RerankingMetadataSelectiveModeConfiguration | undefined;
|
|
1461
2128
|
}
|
|
1462
2129
|
/**
|
|
1463
|
-
* <p>Contains
|
|
1464
|
-
* <p>This data type is used in the following API operations:</p>
|
|
1465
|
-
* <ul>
|
|
1466
|
-
* <li>
|
|
1467
|
-
* <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>
|
|
1468
|
-
* </p>
|
|
1469
|
-
* </li>
|
|
1470
|
-
* </ul>
|
|
2130
|
+
* <p>Contains configurations for an Amazon Bedrock reranker model.</p>
|
|
1471
2131
|
* @public
|
|
1472
2132
|
*/
|
|
1473
|
-
export interface
|
|
2133
|
+
export interface VectorSearchBedrockRerankingModelConfiguration {
|
|
1474
2134
|
/**
|
|
1475
|
-
* <p>The
|
|
2135
|
+
* <p>The ARN of the reranker model to use.</p>
|
|
1476
2136
|
* @public
|
|
1477
2137
|
*/
|
|
1478
|
-
|
|
2138
|
+
modelArn: string | undefined;
|
|
1479
2139
|
/**
|
|
1480
|
-
* <p>
|
|
2140
|
+
* <p>A JSON object whose keys are request fields for the model and whose values are values for those fields.</p>
|
|
1481
2141
|
* @public
|
|
1482
2142
|
*/
|
|
1483
|
-
|
|
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 {
|
|
1484
2150
|
/**
|
|
1485
|
-
* <p>
|
|
2151
|
+
* <p>Contains configurations for the reranker model.</p>
|
|
1486
2152
|
* @public
|
|
1487
2153
|
*/
|
|
1488
|
-
|
|
2154
|
+
modelConfiguration: VectorSearchBedrockRerankingModelConfiguration | undefined;
|
|
1489
2155
|
/**
|
|
1490
|
-
* <p>The
|
|
2156
|
+
* <p>The number of results to return after reranking.</p>
|
|
1491
2157
|
* @public
|
|
1492
2158
|
*/
|
|
1493
|
-
|
|
2159
|
+
numberOfRerankedResults?: number | undefined;
|
|
1494
2160
|
/**
|
|
1495
|
-
* <p>
|
|
2161
|
+
* <p>Contains configurations for the metadata to use in reranking.</p>
|
|
1496
2162
|
* @public
|
|
1497
2163
|
*/
|
|
1498
|
-
|
|
2164
|
+
metadataConfiguration?: MetadataConfigurationForReranking | undefined;
|
|
1499
2165
|
}
|
|
1500
|
-
/**
|
|
1501
|
-
* <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>
|
|
1502
|
-
* <p>This data type is used in the following API operations:</p>
|
|
1503
|
-
* <ul>
|
|
1504
|
-
* <li>
|
|
1505
|
-
* <p>
|
|
1506
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_RequestSyntax">InvokeAgent request</a>
|
|
1507
|
-
* </p>
|
|
1508
|
-
* </li>
|
|
1509
|
-
* </ul>
|
|
1510
|
-
* @public
|
|
1511
|
-
*/
|
|
1512
|
-
export type InvocationResultMember = InvocationResultMember.ApiResultMember | InvocationResultMember.FunctionResultMember | InvocationResultMember.$UnknownMember;
|
|
1513
2166
|
/**
|
|
1514
2167
|
* @public
|
|
2168
|
+
* @enum
|
|
1515
2169
|
*/
|
|
1516
|
-
export declare
|
|
1517
|
-
|
|
1518
|
-
|
|
1519
|
-
|
|
1520
|
-
|
|
1521
|
-
|
|
1522
|
-
|
|
1523
|
-
|
|
1524
|
-
|
|
1525
|
-
|
|
2170
|
+
export declare const VectorSearchRerankingConfigurationType: {
|
|
2171
|
+
readonly BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL";
|
|
2172
|
+
};
|
|
2173
|
+
/**
|
|
2174
|
+
* @public
|
|
2175
|
+
*/
|
|
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 {
|
|
1526
2182
|
/**
|
|
1527
|
-
* <p>The
|
|
2183
|
+
* <p>The type of reranker model.</p>
|
|
1528
2184
|
* @public
|
|
1529
2185
|
*/
|
|
1530
|
-
|
|
1531
|
-
apiResult?: never;
|
|
1532
|
-
functionResult: FunctionResult;
|
|
1533
|
-
$unknown?: never;
|
|
1534
|
-
}
|
|
2186
|
+
type: VectorSearchRerankingConfigurationType | undefined;
|
|
1535
2187
|
/**
|
|
2188
|
+
* <p>Contains configurations for an Amazon Bedrock reranker model.</p>
|
|
1536
2189
|
* @public
|
|
1537
2190
|
*/
|
|
1538
|
-
|
|
1539
|
-
apiResult?: never;
|
|
1540
|
-
functionResult?: never;
|
|
1541
|
-
$unknown: [string, any];
|
|
1542
|
-
}
|
|
1543
|
-
interface Visitor<T> {
|
|
1544
|
-
apiResult: (value: ApiResult) => T;
|
|
1545
|
-
functionResult: (value: FunctionResult) => T;
|
|
1546
|
-
_: (name: string, value: any) => T;
|
|
1547
|
-
}
|
|
1548
|
-
const visit: <T>(value: InvocationResultMember, visitor: Visitor<T>) => T;
|
|
2191
|
+
bedrockRerankingConfiguration?: VectorSearchBedrockRerankingConfiguration | undefined;
|
|
1549
2192
|
}
|
|
1550
2193
|
/**
|
|
1551
2194
|
* <p>
|
|
@@ -1682,6 +2325,17 @@ export interface RetrievalResultConfluenceLocation {
|
|
|
1682
2325
|
*/
|
|
1683
2326
|
url?: string | undefined;
|
|
1684
2327
|
}
|
|
2328
|
+
/**
|
|
2329
|
+
* <p>Contains information about the location of a document in a custom data source.</p>
|
|
2330
|
+
* @public
|
|
2331
|
+
*/
|
|
2332
|
+
export interface RetrievalResultCustomDocumentLocation {
|
|
2333
|
+
/**
|
|
2334
|
+
* <p>The ID of the document.</p>
|
|
2335
|
+
* @public
|
|
2336
|
+
*/
|
|
2337
|
+
id?: string | undefined;
|
|
2338
|
+
}
|
|
1685
2339
|
/**
|
|
1686
2340
|
* <p>The S3 data source location.</p>
|
|
1687
2341
|
* <p>This data type is used in the following API operations:</p>
|
|
@@ -1736,6 +2390,7 @@ export interface RetrievalResultSharePointLocation {
|
|
|
1736
2390
|
*/
|
|
1737
2391
|
export declare const RetrievalResultLocationType: {
|
|
1738
2392
|
readonly CONFLUENCE: "CONFLUENCE";
|
|
2393
|
+
readonly CUSTOM: "CUSTOM";
|
|
1739
2394
|
readonly S3: "S3";
|
|
1740
2395
|
readonly SALESFORCE: "SALESFORCE";
|
|
1741
2396
|
readonly SHAREPOINT: "SHAREPOINT";
|
|
@@ -1806,6 +2461,11 @@ export interface RetrievalResultLocation {
|
|
|
1806
2461
|
* @public
|
|
1807
2462
|
*/
|
|
1808
2463
|
sharePointLocation?: RetrievalResultSharePointLocation | undefined;
|
|
2464
|
+
/**
|
|
2465
|
+
* <p>Specifies the location of a document in a custom data source.</p>
|
|
2466
|
+
* @public
|
|
2467
|
+
*/
|
|
2468
|
+
customDocumentLocation?: RetrievalResultCustomDocumentLocation | undefined;
|
|
1809
2469
|
}
|
|
1810
2470
|
/**
|
|
1811
2471
|
* <p>Contains metadata about a source cited for the generated response.</p>
|
|
@@ -1924,246 +2584,40 @@ export interface FilePart {
|
|
|
1924
2584
|
* @public
|
|
1925
2585
|
*/
|
|
1926
2586
|
files?: OutputFile[] | undefined;
|
|
1927
|
-
}
|
|
1928
|
-
/**
|
|
1929
|
-
* <p>
|
|
1930
|
-
* <p>This data type is used in the following API operations:</p>
|
|
1931
|
-
* <ul>
|
|
1932
|
-
* <li>
|
|
1933
|
-
* <p>
|
|
1934
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
1935
|
-
* </p>
|
|
1936
|
-
* </li>
|
|
1937
|
-
* </ul>
|
|
1938
|
-
* @public
|
|
1939
|
-
*/
|
|
1940
|
-
export interface ApiParameter {
|
|
1941
|
-
/**
|
|
1942
|
-
* <p>The name of the parameter.</p>
|
|
1943
|
-
* @public
|
|
1944
|
-
*/
|
|
1945
|
-
name?: string | undefined;
|
|
1946
|
-
/**
|
|
1947
|
-
* <p>The data type for the parameter.</p>
|
|
1948
|
-
* @public
|
|
1949
|
-
*/
|
|
1950
|
-
type?: string | undefined;
|
|
1951
|
-
/**
|
|
1952
|
-
* <p>The value of the parameter.</p>
|
|
1953
|
-
* @public
|
|
1954
|
-
*/
|
|
1955
|
-
value?: string | undefined;
|
|
1956
|
-
}
|
|
1957
|
-
/**
|
|
1958
|
-
* <p>Contains the parameters in the request body.</p>
|
|
1959
|
-
* @public
|
|
1960
|
-
*/
|
|
1961
|
-
export interface PropertyParameters {
|
|
1962
|
-
/**
|
|
1963
|
-
* <p>A list of parameters in the request body.</p>
|
|
1964
|
-
* @public
|
|
1965
|
-
*/
|
|
1966
|
-
properties?: Parameter[] | undefined;
|
|
1967
|
-
}
|
|
1968
|
-
/**
|
|
1969
|
-
* <p>The request body to provide for the API request, as the agent elicited from the user.</p>
|
|
1970
|
-
* <p>This data type is used in the following API operations:</p>
|
|
1971
|
-
* <ul>
|
|
1972
|
-
* <li>
|
|
1973
|
-
* <p>
|
|
1974
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
1975
|
-
* </p>
|
|
1976
|
-
* </li>
|
|
1977
|
-
* </ul>
|
|
1978
|
-
* @public
|
|
1979
|
-
*/
|
|
1980
|
-
export interface ApiRequestBody {
|
|
1981
|
-
/**
|
|
1982
|
-
* <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>
|
|
1983
|
-
* @public
|
|
1984
|
-
*/
|
|
1985
|
-
content?: Record<string, PropertyParameters> | undefined;
|
|
1986
|
-
}
|
|
1987
|
-
/**
|
|
1988
|
-
* <p>Contains information about the API operation that the agent predicts should be called.</p>
|
|
1989
|
-
* <p>This data type is used in the following API operations:</p>
|
|
1990
|
-
* <ul>
|
|
1991
|
-
* <li>
|
|
1992
|
-
* <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>
|
|
1993
|
-
* </p>
|
|
1994
|
-
* </li>
|
|
1995
|
-
* </ul>
|
|
1996
|
-
* @public
|
|
1997
|
-
*/
|
|
1998
|
-
export interface ApiInvocationInput {
|
|
1999
|
-
/**
|
|
2000
|
-
* <p>The action group that the API operation belongs to.</p>
|
|
2001
|
-
* @public
|
|
2002
|
-
*/
|
|
2003
|
-
actionGroup: string | undefined;
|
|
2004
|
-
/**
|
|
2005
|
-
* <p>The HTTP method of the API operation.</p>
|
|
2006
|
-
* @public
|
|
2007
|
-
*/
|
|
2008
|
-
httpMethod?: string | undefined;
|
|
2009
|
-
/**
|
|
2010
|
-
* <p>The path to the API operation.</p>
|
|
2011
|
-
* @public
|
|
2012
|
-
*/
|
|
2013
|
-
apiPath?: string | undefined;
|
|
2014
|
-
/**
|
|
2015
|
-
* <p>The parameters to provide for the API request, as the agent elicited from the user.</p>
|
|
2016
|
-
* @public
|
|
2017
|
-
*/
|
|
2018
|
-
parameters?: ApiParameter[] | undefined;
|
|
2019
|
-
/**
|
|
2020
|
-
* <p>The request body to provide for the API request, as the agent elicited from the user.</p>
|
|
2021
|
-
* @public
|
|
2022
|
-
*/
|
|
2023
|
-
requestBody?: ApiRequestBody | undefined;
|
|
2024
|
-
/**
|
|
2025
|
-
* <p>Contains information about the API operation to invoke.</p>
|
|
2026
|
-
* @public
|
|
2027
|
-
*/
|
|
2028
|
-
actionInvocationType?: ActionInvocationType | undefined;
|
|
2029
|
-
}
|
|
2030
|
-
/**
|
|
2031
|
-
* <p>Contains information about a parameter of the function.</p>
|
|
2032
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2033
|
-
* <ul>
|
|
2034
|
-
* <li>
|
|
2035
|
-
* <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>
|
|
2036
|
-
* </p>
|
|
2037
|
-
* </li>
|
|
2038
|
-
* </ul>
|
|
2039
|
-
* @public
|
|
2040
|
-
*/
|
|
2041
|
-
export interface FunctionParameter {
|
|
2042
|
-
/**
|
|
2043
|
-
* <p>The name of the parameter.</p>
|
|
2044
|
-
* @public
|
|
2045
|
-
*/
|
|
2046
|
-
name?: string | undefined;
|
|
2047
|
-
/**
|
|
2048
|
-
* <p>The data type of the parameter.</p>
|
|
2049
|
-
* @public
|
|
2050
|
-
*/
|
|
2051
|
-
type?: string | undefined;
|
|
2052
|
-
/**
|
|
2053
|
-
* <p>The value of the parameter.</p>
|
|
2054
|
-
* @public
|
|
2055
|
-
*/
|
|
2056
|
-
value?: string | undefined;
|
|
2057
|
-
}
|
|
2058
|
-
/**
|
|
2059
|
-
* <p>Contains information about the function that the agent predicts should be called.</p>
|
|
2060
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2061
|
-
* <ul>
|
|
2062
|
-
* <li>
|
|
2063
|
-
* <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>
|
|
2064
|
-
* </p>
|
|
2065
|
-
* </li>
|
|
2066
|
-
* </ul>
|
|
2067
|
-
* @public
|
|
2068
|
-
*/
|
|
2069
|
-
export interface FunctionInvocationInput {
|
|
2070
|
-
/**
|
|
2071
|
-
* <p>The action group that the function belongs to.</p>
|
|
2072
|
-
* @public
|
|
2073
|
-
*/
|
|
2074
|
-
actionGroup: string | undefined;
|
|
2075
|
-
/**
|
|
2076
|
-
* <p>A list of parameters of the function.</p>
|
|
2077
|
-
* @public
|
|
2078
|
-
*/
|
|
2079
|
-
parameters?: FunctionParameter[] | undefined;
|
|
2080
|
-
/**
|
|
2081
|
-
* <p>The name of the function.</p>
|
|
2082
|
-
* @public
|
|
2083
|
-
*/
|
|
2084
|
-
function?: string | undefined;
|
|
2085
|
-
/**
|
|
2086
|
-
* <p>Contains information about the function to invoke,</p>
|
|
2087
|
-
* @public
|
|
2088
|
-
*/
|
|
2089
|
-
actionInvocationType?: ActionInvocationType | undefined;
|
|
2090
|
-
}
|
|
2091
|
-
/**
|
|
2092
|
-
* <p>Contains details about the API operation or function that the agent predicts should be called. </p>
|
|
2093
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2094
|
-
* <ul>
|
|
2095
|
-
* <li>
|
|
2096
|
-
* <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>
|
|
2097
|
-
* </p>
|
|
2098
|
-
* </li>
|
|
2099
|
-
* </ul>
|
|
2100
|
-
* @public
|
|
2101
|
-
*/
|
|
2102
|
-
export type InvocationInputMember = InvocationInputMember.ApiInvocationInputMember | InvocationInputMember.FunctionInvocationInputMember | InvocationInputMember.$UnknownMember;
|
|
2103
|
-
/**
|
|
2104
|
-
* @public
|
|
2105
|
-
*/
|
|
2106
|
-
export declare namespace InvocationInputMember {
|
|
2107
|
-
/**
|
|
2108
|
-
* <p>Contains information about the API operation that the agent predicts should be called.</p>
|
|
2109
|
-
* @public
|
|
2110
|
-
*/
|
|
2111
|
-
interface ApiInvocationInputMember {
|
|
2112
|
-
apiInvocationInput: ApiInvocationInput;
|
|
2113
|
-
functionInvocationInput?: never;
|
|
2114
|
-
$unknown?: never;
|
|
2115
|
-
}
|
|
2116
|
-
/**
|
|
2117
|
-
* <p>Contains information about the function that the agent predicts should be called.</p>
|
|
2118
|
-
* @public
|
|
2119
|
-
*/
|
|
2120
|
-
interface FunctionInvocationInputMember {
|
|
2121
|
-
apiInvocationInput?: never;
|
|
2122
|
-
functionInvocationInput: FunctionInvocationInput;
|
|
2123
|
-
$unknown?: never;
|
|
2124
|
-
}
|
|
2125
|
-
/**
|
|
2126
|
-
* @public
|
|
2127
|
-
*/
|
|
2128
|
-
interface $UnknownMember {
|
|
2129
|
-
apiInvocationInput?: never;
|
|
2130
|
-
functionInvocationInput?: never;
|
|
2131
|
-
$unknown: [string, any];
|
|
2132
|
-
}
|
|
2133
|
-
interface Visitor<T> {
|
|
2134
|
-
apiInvocationInput: (value: ApiInvocationInput) => T;
|
|
2135
|
-
functionInvocationInput: (value: FunctionInvocationInput) => T;
|
|
2136
|
-
_: (name: string, value: any) => T;
|
|
2137
|
-
}
|
|
2138
|
-
const visit: <T>(value: InvocationInputMember, visitor: Visitor<T>) => T;
|
|
2139
|
-
}
|
|
2140
|
-
/**
|
|
2141
|
-
* <p>Contains information to return from the action group that the agent has predicted to invoke.</p>
|
|
2142
|
-
* <p>This data type is used in the following API operations:</p>
|
|
2143
|
-
* <ul>
|
|
2144
|
-
* <li>
|
|
2145
|
-
* <p>
|
|
2146
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax">InvokeAgent response</a>
|
|
2147
|
-
* </p>
|
|
2148
|
-
* </li>
|
|
2149
|
-
* </ul>
|
|
2587
|
+
}
|
|
2588
|
+
/**
|
|
2589
|
+
* <p>Details about a caller.</p>
|
|
2150
2590
|
* @public
|
|
2151
2591
|
*/
|
|
2152
|
-
export
|
|
2592
|
+
export type Caller = Caller.AgentAliasArnMember | Caller.$UnknownMember;
|
|
2593
|
+
/**
|
|
2594
|
+
* @public
|
|
2595
|
+
*/
|
|
2596
|
+
export declare namespace Caller {
|
|
2153
2597
|
/**
|
|
2154
|
-
* <p>
|
|
2598
|
+
* <p>The caller's agent alias ARN.</p>
|
|
2155
2599
|
* @public
|
|
2156
2600
|
*/
|
|
2157
|
-
|
|
2601
|
+
interface AgentAliasArnMember {
|
|
2602
|
+
agentAliasArn: string;
|
|
2603
|
+
$unknown?: never;
|
|
2604
|
+
}
|
|
2158
2605
|
/**
|
|
2159
|
-
* <p>The identifier of the action group invocation.</p>
|
|
2160
2606
|
* @public
|
|
2161
2607
|
*/
|
|
2162
|
-
|
|
2608
|
+
interface $UnknownMember {
|
|
2609
|
+
agentAliasArn?: never;
|
|
2610
|
+
$unknown: [string, any];
|
|
2611
|
+
}
|
|
2612
|
+
interface Visitor<T> {
|
|
2613
|
+
agentAliasArn: (value: string) => T;
|
|
2614
|
+
_: (name: string, value: any) => T;
|
|
2615
|
+
}
|
|
2616
|
+
const visit: <T>(value: Caller, visitor: Visitor<T>) => T;
|
|
2163
2617
|
}
|
|
2164
2618
|
/**
|
|
2165
2619
|
* <p>
|
|
2166
|
-
* The event in the custom orchestration sequence.
|
|
2620
|
+
* The event in the custom orchestration sequence. Events are the responses which the custom orchestration Lambda function sends as response to the agent.
|
|
2167
2621
|
* </p>
|
|
2168
2622
|
* @public
|
|
2169
2623
|
*/
|
|
@@ -2192,7 +2646,7 @@ export interface CustomOrchestrationTrace {
|
|
|
2192
2646
|
traceId?: string | undefined;
|
|
2193
2647
|
/**
|
|
2194
2648
|
* <p>
|
|
2195
|
-
* The
|
|
2649
|
+
* The event details used with the custom orchestration.
|
|
2196
2650
|
* </p>
|
|
2197
2651
|
* @public
|
|
2198
2652
|
*/
|
|
@@ -2619,6 +3073,7 @@ export interface CodeInterpreterInvocationInput {
|
|
|
2619
3073
|
export declare const InvocationType: {
|
|
2620
3074
|
readonly ACTION_GROUP: "ACTION_GROUP";
|
|
2621
3075
|
readonly ACTION_GROUP_CODE_INTERPRETER: "ACTION_GROUP_CODE_INTERPRETER";
|
|
3076
|
+
readonly AGENT_COLLABORATOR: "AGENT_COLLABORATOR";
|
|
2622
3077
|
readonly FINISH: "FINISH";
|
|
2623
3078
|
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
2624
3079
|
};
|
|
@@ -2672,6 +3127,11 @@ export interface InvocationInput {
|
|
|
2672
3127
|
* @public
|
|
2673
3128
|
*/
|
|
2674
3129
|
codeInterpreterInvocationInput?: CodeInterpreterInvocationInput | undefined;
|
|
3130
|
+
/**
|
|
3131
|
+
* <p>The collaborator's invocation input.</p>
|
|
3132
|
+
* @public
|
|
3133
|
+
*/
|
|
3134
|
+
agentCollaboratorInvocationInput?: AgentCollaboratorInvocationInput | undefined;
|
|
2675
3135
|
}
|
|
2676
3136
|
/**
|
|
2677
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>
|
|
@@ -2782,6 +3242,11 @@ export interface ModelInvocationInput {
|
|
|
2782
3242
|
* @public
|
|
2783
3243
|
*/
|
|
2784
3244
|
parserMode?: CreationMode | undefined;
|
|
3245
|
+
/**
|
|
3246
|
+
* <p>The identifier of a foundation model.</p>
|
|
3247
|
+
* @public
|
|
3248
|
+
*/
|
|
3249
|
+
foundationModel?: string | undefined;
|
|
2785
3250
|
}
|
|
2786
3251
|
/**
|
|
2787
3252
|
* <p>Contains information of the usage of the foundation model.</p>
|
|
@@ -2925,6 +3390,7 @@ export interface RepromptResponse {
|
|
|
2925
3390
|
*/
|
|
2926
3391
|
export declare const Type: {
|
|
2927
3392
|
readonly ACTION_GROUP: "ACTION_GROUP";
|
|
3393
|
+
readonly AGENT_COLLABORATOR: "AGENT_COLLABORATOR";
|
|
2928
3394
|
readonly ASK_USER: "ASK_USER";
|
|
2929
3395
|
readonly FINISH: "FINISH";
|
|
2930
3396
|
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
@@ -2976,6 +3442,11 @@ export interface Observation {
|
|
|
2976
3442
|
* @public
|
|
2977
3443
|
*/
|
|
2978
3444
|
actionGroupInvocationOutput?: ActionGroupInvocationOutput | undefined;
|
|
3445
|
+
/**
|
|
3446
|
+
* <p>A collaborator's invocation output.</p>
|
|
3447
|
+
* @public
|
|
3448
|
+
*/
|
|
3449
|
+
agentCollaboratorInvocationOutput?: AgentCollaboratorInvocationOutput | undefined;
|
|
2979
3450
|
/**
|
|
2980
3451
|
* <p>Contains details about the results from looking up the knowledge base.</p>
|
|
2981
3452
|
* @public
|
|
@@ -3307,11 +3778,104 @@ export declare namespace PreProcessingTrace {
|
|
|
3307
3778
|
}
|
|
3308
3779
|
const visit: <T>(value: PreProcessingTrace, visitor: Visitor<T>) => T;
|
|
3309
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
|
+
}
|
|
3310
3874
|
/**
|
|
3311
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>
|
|
3312
3876
|
* @public
|
|
3313
3877
|
*/
|
|
3314
|
-
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;
|
|
3315
3879
|
/**
|
|
3316
3880
|
* @public
|
|
3317
3881
|
*/
|
|
@@ -3325,6 +3889,7 @@ export declare namespace Trace {
|
|
|
3325
3889
|
preProcessingTrace?: never;
|
|
3326
3890
|
orchestrationTrace?: never;
|
|
3327
3891
|
postProcessingTrace?: never;
|
|
3892
|
+
routingClassifierTrace?: never;
|
|
3328
3893
|
failureTrace?: never;
|
|
3329
3894
|
customOrchestrationTrace?: never;
|
|
3330
3895
|
$unknown?: never;
|
|
@@ -3338,6 +3903,7 @@ export declare namespace Trace {
|
|
|
3338
3903
|
preProcessingTrace: PreProcessingTrace;
|
|
3339
3904
|
orchestrationTrace?: never;
|
|
3340
3905
|
postProcessingTrace?: never;
|
|
3906
|
+
routingClassifierTrace?: never;
|
|
3341
3907
|
failureTrace?: never;
|
|
3342
3908
|
customOrchestrationTrace?: never;
|
|
3343
3909
|
$unknown?: never;
|
|
@@ -3351,6 +3917,7 @@ export declare namespace Trace {
|
|
|
3351
3917
|
preProcessingTrace?: never;
|
|
3352
3918
|
orchestrationTrace: OrchestrationTrace;
|
|
3353
3919
|
postProcessingTrace?: never;
|
|
3920
|
+
routingClassifierTrace?: never;
|
|
3354
3921
|
failureTrace?: never;
|
|
3355
3922
|
customOrchestrationTrace?: never;
|
|
3356
3923
|
$unknown?: never;
|
|
@@ -3364,6 +3931,21 @@ export declare namespace Trace {
|
|
|
3364
3931
|
preProcessingTrace?: never;
|
|
3365
3932
|
orchestrationTrace?: never;
|
|
3366
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;
|
|
3367
3949
|
failureTrace?: never;
|
|
3368
3950
|
customOrchestrationTrace?: never;
|
|
3369
3951
|
$unknown?: never;
|
|
@@ -3377,6 +3959,7 @@ export declare namespace Trace {
|
|
|
3377
3959
|
preProcessingTrace?: never;
|
|
3378
3960
|
orchestrationTrace?: never;
|
|
3379
3961
|
postProcessingTrace?: never;
|
|
3962
|
+
routingClassifierTrace?: never;
|
|
3380
3963
|
failureTrace: FailureTrace;
|
|
3381
3964
|
customOrchestrationTrace?: never;
|
|
3382
3965
|
$unknown?: never;
|
|
@@ -3392,6 +3975,7 @@ export declare namespace Trace {
|
|
|
3392
3975
|
preProcessingTrace?: never;
|
|
3393
3976
|
orchestrationTrace?: never;
|
|
3394
3977
|
postProcessingTrace?: never;
|
|
3978
|
+
routingClassifierTrace?: never;
|
|
3395
3979
|
failureTrace?: never;
|
|
3396
3980
|
customOrchestrationTrace: CustomOrchestrationTrace;
|
|
3397
3981
|
$unknown?: never;
|
|
@@ -3404,6 +3988,7 @@ export declare namespace Trace {
|
|
|
3404
3988
|
preProcessingTrace?: never;
|
|
3405
3989
|
orchestrationTrace?: never;
|
|
3406
3990
|
postProcessingTrace?: never;
|
|
3991
|
+
routingClassifierTrace?: never;
|
|
3407
3992
|
failureTrace?: never;
|
|
3408
3993
|
customOrchestrationTrace?: never;
|
|
3409
3994
|
$unknown: [string, any];
|
|
@@ -3413,6 +3998,7 @@ export declare namespace Trace {
|
|
|
3413
3998
|
preProcessingTrace: (value: PreProcessingTrace) => T;
|
|
3414
3999
|
orchestrationTrace: (value: OrchestrationTrace) => T;
|
|
3415
4000
|
postProcessingTrace: (value: PostProcessingTrace) => T;
|
|
4001
|
+
routingClassifierTrace: (value: RoutingClassifierTrace) => T;
|
|
3416
4002
|
failureTrace: (value: FailureTrace) => T;
|
|
3417
4003
|
customOrchestrationTrace: (value: CustomOrchestrationTrace) => T;
|
|
3418
4004
|
_: (name: string, value: any) => T;
|
|
@@ -3449,6 +4035,16 @@ export interface TracePart {
|
|
|
3449
4035
|
* @public
|
|
3450
4036
|
*/
|
|
3451
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;
|
|
3452
4048
|
}
|
|
3453
4049
|
/**
|
|
3454
4050
|
* <p>The response from invoking the agent and associated citations and trace information.</p>
|
|
@@ -4765,12 +5361,230 @@ export declare namespace OptimizedPromptStream {
|
|
|
4765
5361
|
/**
|
|
4766
5362
|
* @public
|
|
4767
5363
|
*/
|
|
4768
|
-
export interface OptimizePromptResponse {
|
|
5364
|
+
export interface OptimizePromptResponse {
|
|
5365
|
+
/**
|
|
5366
|
+
* <p>The prompt after being optimized for the task.</p>
|
|
5367
|
+
* @public
|
|
5368
|
+
*/
|
|
5369
|
+
optimizedPrompt: AsyncIterable<OptimizedPromptStream> | undefined;
|
|
5370
|
+
}
|
|
5371
|
+
/**
|
|
5372
|
+
* <p>Contains information about a text document to rerank.</p>
|
|
5373
|
+
* @public
|
|
5374
|
+
*/
|
|
5375
|
+
export interface RerankTextDocument {
|
|
5376
|
+
/**
|
|
5377
|
+
* <p>The text of the document.</p>
|
|
5378
|
+
* @public
|
|
5379
|
+
*/
|
|
5380
|
+
text?: string | undefined;
|
|
5381
|
+
}
|
|
5382
|
+
/**
|
|
5383
|
+
* @public
|
|
5384
|
+
* @enum
|
|
5385
|
+
*/
|
|
5386
|
+
export declare const RerankQueryContentType: {
|
|
5387
|
+
readonly TEXT: "TEXT";
|
|
5388
|
+
};
|
|
5389
|
+
/**
|
|
5390
|
+
* @public
|
|
5391
|
+
*/
|
|
5392
|
+
export type RerankQueryContentType = (typeof RerankQueryContentType)[keyof typeof RerankQueryContentType];
|
|
5393
|
+
/**
|
|
5394
|
+
* <p>Contains information about a query to submit to the reranker model.</p>
|
|
5395
|
+
* @public
|
|
5396
|
+
*/
|
|
5397
|
+
export interface RerankQuery {
|
|
5398
|
+
/**
|
|
5399
|
+
* <p>The type of the query.</p>
|
|
5400
|
+
* @public
|
|
5401
|
+
*/
|
|
5402
|
+
type: RerankQueryContentType | undefined;
|
|
5403
|
+
/**
|
|
5404
|
+
* <p>Contains information about a text query.</p>
|
|
5405
|
+
* @public
|
|
5406
|
+
*/
|
|
5407
|
+
textQuery: RerankTextDocument | undefined;
|
|
5408
|
+
}
|
|
5409
|
+
/**
|
|
5410
|
+
* <p>Contains configurations for a reranker model.</p>
|
|
5411
|
+
* @public
|
|
5412
|
+
*/
|
|
5413
|
+
export interface BedrockRerankingModelConfiguration {
|
|
5414
|
+
/**
|
|
5415
|
+
* <p>The ARN of the reranker model.</p>
|
|
5416
|
+
* @public
|
|
5417
|
+
*/
|
|
5418
|
+
modelArn: string | undefined;
|
|
5419
|
+
/**
|
|
5420
|
+
* <p>A JSON object whose keys are request fields for the model and whose values are values for those fields.</p>
|
|
5421
|
+
* @public
|
|
5422
|
+
*/
|
|
5423
|
+
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
5424
|
+
}
|
|
5425
|
+
/**
|
|
5426
|
+
* <p>Contains configurations for an Amazon Bedrock reranker model.</p>
|
|
5427
|
+
* @public
|
|
5428
|
+
*/
|
|
5429
|
+
export interface BedrockRerankingConfiguration {
|
|
5430
|
+
/**
|
|
5431
|
+
* <p>The number of results to return after reranking.</p>
|
|
5432
|
+
* @public
|
|
5433
|
+
*/
|
|
5434
|
+
numberOfResults?: number | undefined;
|
|
5435
|
+
/**
|
|
5436
|
+
* <p>Contains configurations for a reranker model.</p>
|
|
5437
|
+
* @public
|
|
5438
|
+
*/
|
|
5439
|
+
modelConfiguration: BedrockRerankingModelConfiguration | undefined;
|
|
5440
|
+
}
|
|
5441
|
+
/**
|
|
5442
|
+
* @public
|
|
5443
|
+
* @enum
|
|
5444
|
+
*/
|
|
5445
|
+
export declare const RerankingConfigurationType: {
|
|
5446
|
+
readonly BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL";
|
|
5447
|
+
};
|
|
5448
|
+
/**
|
|
5449
|
+
* @public
|
|
5450
|
+
*/
|
|
5451
|
+
export type RerankingConfigurationType = (typeof RerankingConfigurationType)[keyof typeof RerankingConfigurationType];
|
|
5452
|
+
/**
|
|
5453
|
+
* <p>Contains configurations for reranking.</p>
|
|
5454
|
+
* @public
|
|
5455
|
+
*/
|
|
5456
|
+
export interface RerankingConfiguration {
|
|
5457
|
+
/**
|
|
5458
|
+
* <p>The type of reranker that the configurations apply to.</p>
|
|
5459
|
+
* @public
|
|
5460
|
+
*/
|
|
5461
|
+
type: RerankingConfigurationType | undefined;
|
|
5462
|
+
/**
|
|
5463
|
+
* <p>Contains configurations for an Amazon Bedrock reranker.</p>
|
|
5464
|
+
* @public
|
|
5465
|
+
*/
|
|
5466
|
+
bedrockRerankingConfiguration: BedrockRerankingConfiguration | undefined;
|
|
5467
|
+
}
|
|
5468
|
+
/**
|
|
5469
|
+
* @public
|
|
5470
|
+
* @enum
|
|
5471
|
+
*/
|
|
5472
|
+
export declare const RerankDocumentType: {
|
|
5473
|
+
readonly JSON: "JSON";
|
|
5474
|
+
readonly TEXT: "TEXT";
|
|
5475
|
+
};
|
|
5476
|
+
/**
|
|
5477
|
+
* @public
|
|
5478
|
+
*/
|
|
5479
|
+
export type RerankDocumentType = (typeof RerankDocumentType)[keyof typeof RerankDocumentType];
|
|
5480
|
+
/**
|
|
5481
|
+
* <p>Contains information about a document to rerank. Choose the <code>type</code> to define and include the field that corresponds to the type.</p>
|
|
5482
|
+
* @public
|
|
5483
|
+
*/
|
|
5484
|
+
export interface RerankDocument {
|
|
5485
|
+
/**
|
|
5486
|
+
* <p>The type of document to rerank.</p>
|
|
5487
|
+
* @public
|
|
5488
|
+
*/
|
|
5489
|
+
type: RerankDocumentType | undefined;
|
|
5490
|
+
/**
|
|
5491
|
+
* <p>Contains information about a text document to rerank.</p>
|
|
5492
|
+
* @public
|
|
5493
|
+
*/
|
|
5494
|
+
textDocument?: RerankTextDocument | undefined;
|
|
5495
|
+
/**
|
|
5496
|
+
* <p>Contains a JSON document to rerank.</p>
|
|
5497
|
+
* @public
|
|
5498
|
+
*/
|
|
5499
|
+
jsonDocument?: __DocumentType | undefined;
|
|
5500
|
+
}
|
|
5501
|
+
/**
|
|
5502
|
+
* @public
|
|
5503
|
+
* @enum
|
|
5504
|
+
*/
|
|
5505
|
+
export declare const RerankSourceType: {
|
|
5506
|
+
readonly INLINE: "INLINE";
|
|
5507
|
+
};
|
|
5508
|
+
/**
|
|
5509
|
+
* @public
|
|
5510
|
+
*/
|
|
5511
|
+
export type RerankSourceType = (typeof RerankSourceType)[keyof typeof RerankSourceType];
|
|
5512
|
+
/**
|
|
5513
|
+
* <p>Contains information about a source for reranking.</p>
|
|
5514
|
+
* @public
|
|
5515
|
+
*/
|
|
5516
|
+
export interface RerankSource {
|
|
5517
|
+
/**
|
|
5518
|
+
* <p>The type of the source.</p>
|
|
5519
|
+
* @public
|
|
5520
|
+
*/
|
|
5521
|
+
type: RerankSourceType | undefined;
|
|
5522
|
+
/**
|
|
5523
|
+
* <p>Contains an inline definition of a source for reranking.</p>
|
|
5524
|
+
* @public
|
|
5525
|
+
*/
|
|
5526
|
+
inlineDocumentSource: RerankDocument | undefined;
|
|
5527
|
+
}
|
|
5528
|
+
/**
|
|
5529
|
+
* @public
|
|
5530
|
+
*/
|
|
5531
|
+
export interface RerankRequest {
|
|
5532
|
+
/**
|
|
5533
|
+
* <p>An array of objects, each of which contains information about a query to submit to the reranker model.</p>
|
|
5534
|
+
* @public
|
|
5535
|
+
*/
|
|
5536
|
+
queries: RerankQuery[] | undefined;
|
|
5537
|
+
/**
|
|
5538
|
+
* <p>An array of objects, each of which contains information about the sources to rerank.</p>
|
|
5539
|
+
* @public
|
|
5540
|
+
*/
|
|
5541
|
+
sources: RerankSource[] | undefined;
|
|
5542
|
+
/**
|
|
5543
|
+
* <p>Contains configurations for reranking.</p>
|
|
5544
|
+
* @public
|
|
5545
|
+
*/
|
|
5546
|
+
rerankingConfiguration: RerankingConfiguration | undefined;
|
|
5547
|
+
/**
|
|
5548
|
+
* <p>If the total number of results was greater than could fit in a response, a token is returned in the <code>nextToken</code> field. You can enter that token in this field to return the next batch of results.</p>
|
|
5549
|
+
* @public
|
|
5550
|
+
*/
|
|
5551
|
+
nextToken?: string | undefined;
|
|
5552
|
+
}
|
|
5553
|
+
/**
|
|
5554
|
+
* <p>Contains information about a document that was reranked.</p>
|
|
5555
|
+
* @public
|
|
5556
|
+
*/
|
|
5557
|
+
export interface RerankResult {
|
|
5558
|
+
/**
|
|
5559
|
+
* <p>The ranking of the document. The lower a number, the higher the document is ranked.</p>
|
|
5560
|
+
* @public
|
|
5561
|
+
*/
|
|
5562
|
+
index: number | undefined;
|
|
5563
|
+
/**
|
|
5564
|
+
* <p>The relevance score of the document.</p>
|
|
5565
|
+
* @public
|
|
5566
|
+
*/
|
|
5567
|
+
relevanceScore: number | undefined;
|
|
5568
|
+
/**
|
|
5569
|
+
* <p>Contains information about the document.</p>
|
|
5570
|
+
* @public
|
|
5571
|
+
*/
|
|
5572
|
+
document?: RerankDocument | undefined;
|
|
5573
|
+
}
|
|
5574
|
+
/**
|
|
5575
|
+
* @public
|
|
5576
|
+
*/
|
|
5577
|
+
export interface RerankResponse {
|
|
4769
5578
|
/**
|
|
4770
|
-
* <p>
|
|
5579
|
+
* <p>An array of objects, each of which contains information about the results of reranking.</p>
|
|
4771
5580
|
* @public
|
|
4772
5581
|
*/
|
|
4773
|
-
|
|
5582
|
+
results: RerankResult[] | undefined;
|
|
5583
|
+
/**
|
|
5584
|
+
* <p>If the total number of results is greater than can fit in the response, use this token in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
5585
|
+
* @public
|
|
5586
|
+
*/
|
|
5587
|
+
nextToken?: string | undefined;
|
|
4774
5588
|
}
|
|
4775
5589
|
/**
|
|
4776
5590
|
* <p>Contains the query made to the knowledge base.</p>
|
|
@@ -5108,65 +5922,389 @@ export type RetrieveAndGenerateType = (typeof RetrieveAndGenerateType)[keyof typ
|
|
|
5108
5922
|
*/
|
|
5109
5923
|
export interface RetrieveAndGenerateSessionConfiguration {
|
|
5110
5924
|
/**
|
|
5111
|
-
* <p>The ARN of the KMS key encrypting the session.</p>
|
|
5925
|
+
* <p>The ARN of the KMS key encrypting the session.</p>
|
|
5926
|
+
* @public
|
|
5927
|
+
*/
|
|
5928
|
+
kmsKeyArn: string | undefined;
|
|
5929
|
+
}
|
|
5930
|
+
/**
|
|
5931
|
+
* @public
|
|
5932
|
+
* @enum
|
|
5933
|
+
*/
|
|
5934
|
+
export declare const GuadrailAction: {
|
|
5935
|
+
readonly INTERVENED: "INTERVENED";
|
|
5936
|
+
readonly NONE: "NONE";
|
|
5937
|
+
};
|
|
5938
|
+
/**
|
|
5939
|
+
* @public
|
|
5940
|
+
*/
|
|
5941
|
+
export type GuadrailAction = (typeof GuadrailAction)[keyof typeof GuadrailAction];
|
|
5942
|
+
/**
|
|
5943
|
+
* <p>Contains the response generated from querying the knowledge base.</p>
|
|
5944
|
+
* <p>This data type is used in the following API operations:</p>
|
|
5945
|
+
* <ul>
|
|
5946
|
+
* <li>
|
|
5947
|
+
* <p>
|
|
5948
|
+
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>output</code> field</p>
|
|
5949
|
+
* </li>
|
|
5950
|
+
* </ul>
|
|
5951
|
+
* @public
|
|
5952
|
+
*/
|
|
5953
|
+
export interface RetrieveAndGenerateOutput {
|
|
5954
|
+
/**
|
|
5955
|
+
* <p>The response generated from querying the knowledge base.</p>
|
|
5956
|
+
* @public
|
|
5957
|
+
*/
|
|
5958
|
+
text: string | undefined;
|
|
5959
|
+
}
|
|
5960
|
+
/**
|
|
5961
|
+
* @public
|
|
5962
|
+
*/
|
|
5963
|
+
export interface RetrieveAndGenerateResponse {
|
|
5964
|
+
/**
|
|
5965
|
+
* <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
|
|
5966
|
+
* @public
|
|
5967
|
+
*/
|
|
5968
|
+
sessionId: string | undefined;
|
|
5969
|
+
/**
|
|
5970
|
+
* <p>Contains the response generated from querying the knowledge base.</p>
|
|
5971
|
+
* @public
|
|
5972
|
+
*/
|
|
5973
|
+
output: RetrieveAndGenerateOutput | undefined;
|
|
5974
|
+
/**
|
|
5975
|
+
* <p>A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.</p>
|
|
5976
|
+
* @public
|
|
5977
|
+
*/
|
|
5978
|
+
citations?: Citation[] | undefined;
|
|
5979
|
+
/**
|
|
5980
|
+
* <p>Specifies if there is a guardrail intervention in the response.</p>
|
|
5981
|
+
* @public
|
|
5982
|
+
*/
|
|
5983
|
+
guardrailAction?: GuadrailAction | undefined;
|
|
5984
|
+
}
|
|
5985
|
+
/**
|
|
5986
|
+
* <p>A citation event.</p>
|
|
5987
|
+
* @public
|
|
5988
|
+
*/
|
|
5989
|
+
export interface CitationEvent {
|
|
5990
|
+
/**
|
|
5991
|
+
* <p>The citation.</p>
|
|
5992
|
+
* @public
|
|
5993
|
+
*/
|
|
5994
|
+
citation?: Citation | undefined;
|
|
5995
|
+
}
|
|
5996
|
+
/**
|
|
5997
|
+
* <p>A guardrail event.</p>
|
|
5998
|
+
* @public
|
|
5999
|
+
*/
|
|
6000
|
+
export interface GuardrailEvent {
|
|
6001
|
+
/**
|
|
6002
|
+
* <p>The guardrail action.</p>
|
|
6003
|
+
* @public
|
|
6004
|
+
*/
|
|
6005
|
+
action?: GuadrailAction | undefined;
|
|
6006
|
+
}
|
|
6007
|
+
/**
|
|
6008
|
+
* <p>A retrieve and generate output event.</p>
|
|
6009
|
+
* @public
|
|
6010
|
+
*/
|
|
6011
|
+
export interface RetrieveAndGenerateOutputEvent {
|
|
6012
|
+
/**
|
|
6013
|
+
* <p>A text response.</p>
|
|
6014
|
+
* @public
|
|
6015
|
+
*/
|
|
6016
|
+
text: string | undefined;
|
|
6017
|
+
}
|
|
6018
|
+
/**
|
|
6019
|
+
* <p>A retrieve and generate stream response output.</p>
|
|
6020
|
+
* @public
|
|
6021
|
+
*/
|
|
6022
|
+
export type RetrieveAndGenerateStreamResponseOutput = RetrieveAndGenerateStreamResponseOutput.AccessDeniedExceptionMember | RetrieveAndGenerateStreamResponseOutput.BadGatewayExceptionMember | RetrieveAndGenerateStreamResponseOutput.CitationMember | RetrieveAndGenerateStreamResponseOutput.ConflictExceptionMember | RetrieveAndGenerateStreamResponseOutput.DependencyFailedExceptionMember | RetrieveAndGenerateStreamResponseOutput.GuardrailMember | RetrieveAndGenerateStreamResponseOutput.InternalServerExceptionMember | RetrieveAndGenerateStreamResponseOutput.OutputMember | RetrieveAndGenerateStreamResponseOutput.ResourceNotFoundExceptionMember | RetrieveAndGenerateStreamResponseOutput.ServiceQuotaExceededExceptionMember | RetrieveAndGenerateStreamResponseOutput.ThrottlingExceptionMember | RetrieveAndGenerateStreamResponseOutput.ValidationExceptionMember | RetrieveAndGenerateStreamResponseOutput.$UnknownMember;
|
|
6023
|
+
/**
|
|
6024
|
+
* @public
|
|
6025
|
+
*/
|
|
6026
|
+
export declare namespace RetrieveAndGenerateStreamResponseOutput {
|
|
6027
|
+
/**
|
|
6028
|
+
* <p>An output event.</p>
|
|
6029
|
+
* @public
|
|
6030
|
+
*/
|
|
6031
|
+
interface OutputMember {
|
|
6032
|
+
output: RetrieveAndGenerateOutputEvent;
|
|
6033
|
+
citation?: never;
|
|
6034
|
+
guardrail?: never;
|
|
6035
|
+
internalServerException?: never;
|
|
6036
|
+
validationException?: never;
|
|
6037
|
+
resourceNotFoundException?: never;
|
|
6038
|
+
serviceQuotaExceededException?: never;
|
|
6039
|
+
throttlingException?: never;
|
|
6040
|
+
accessDeniedException?: never;
|
|
6041
|
+
conflictException?: never;
|
|
6042
|
+
dependencyFailedException?: never;
|
|
6043
|
+
badGatewayException?: never;
|
|
6044
|
+
$unknown?: never;
|
|
6045
|
+
}
|
|
6046
|
+
/**
|
|
6047
|
+
* <p>A citation event.</p>
|
|
6048
|
+
* @public
|
|
6049
|
+
*/
|
|
6050
|
+
interface CitationMember {
|
|
6051
|
+
output?: never;
|
|
6052
|
+
citation: CitationEvent;
|
|
6053
|
+
guardrail?: never;
|
|
6054
|
+
internalServerException?: never;
|
|
6055
|
+
validationException?: never;
|
|
6056
|
+
resourceNotFoundException?: never;
|
|
6057
|
+
serviceQuotaExceededException?: never;
|
|
6058
|
+
throttlingException?: never;
|
|
6059
|
+
accessDeniedException?: never;
|
|
6060
|
+
conflictException?: never;
|
|
6061
|
+
dependencyFailedException?: never;
|
|
6062
|
+
badGatewayException?: never;
|
|
6063
|
+
$unknown?: never;
|
|
6064
|
+
}
|
|
6065
|
+
/**
|
|
6066
|
+
* <p>A guardrail event.</p>
|
|
6067
|
+
* @public
|
|
6068
|
+
*/
|
|
6069
|
+
interface GuardrailMember {
|
|
6070
|
+
output?: never;
|
|
6071
|
+
citation?: never;
|
|
6072
|
+
guardrail: GuardrailEvent;
|
|
6073
|
+
internalServerException?: never;
|
|
6074
|
+
validationException?: never;
|
|
6075
|
+
resourceNotFoundException?: never;
|
|
6076
|
+
serviceQuotaExceededException?: never;
|
|
6077
|
+
throttlingException?: never;
|
|
6078
|
+
accessDeniedException?: never;
|
|
6079
|
+
conflictException?: never;
|
|
6080
|
+
dependencyFailedException?: never;
|
|
6081
|
+
badGatewayException?: never;
|
|
6082
|
+
$unknown?: never;
|
|
6083
|
+
}
|
|
6084
|
+
/**
|
|
6085
|
+
* <p>An internal server error occurred. Retry your request.</p>
|
|
6086
|
+
* @public
|
|
6087
|
+
*/
|
|
6088
|
+
interface InternalServerExceptionMember {
|
|
6089
|
+
output?: never;
|
|
6090
|
+
citation?: never;
|
|
6091
|
+
guardrail?: never;
|
|
6092
|
+
internalServerException: InternalServerException;
|
|
6093
|
+
validationException?: never;
|
|
6094
|
+
resourceNotFoundException?: never;
|
|
6095
|
+
serviceQuotaExceededException?: never;
|
|
6096
|
+
throttlingException?: never;
|
|
6097
|
+
accessDeniedException?: never;
|
|
6098
|
+
conflictException?: never;
|
|
6099
|
+
dependencyFailedException?: never;
|
|
6100
|
+
badGatewayException?: never;
|
|
6101
|
+
$unknown?: never;
|
|
6102
|
+
}
|
|
6103
|
+
/**
|
|
6104
|
+
* <p>The input fails to satisfy the constraints specified by <i>Amazon Bedrock</i>. For troubleshooting this error,
|
|
6105
|
+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error">ValidationError</a> in the Amazon Bedrock User Guide.</p>
|
|
6106
|
+
* @public
|
|
6107
|
+
*/
|
|
6108
|
+
interface ValidationExceptionMember {
|
|
6109
|
+
output?: never;
|
|
6110
|
+
citation?: never;
|
|
6111
|
+
guardrail?: never;
|
|
6112
|
+
internalServerException?: never;
|
|
6113
|
+
validationException: ValidationException;
|
|
6114
|
+
resourceNotFoundException?: never;
|
|
6115
|
+
serviceQuotaExceededException?: never;
|
|
6116
|
+
throttlingException?: never;
|
|
6117
|
+
accessDeniedException?: never;
|
|
6118
|
+
conflictException?: never;
|
|
6119
|
+
dependencyFailedException?: never;
|
|
6120
|
+
badGatewayException?: never;
|
|
6121
|
+
$unknown?: never;
|
|
6122
|
+
}
|
|
6123
|
+
/**
|
|
6124
|
+
* <p>The specified resource ARN was not found. For troubleshooting this error,
|
|
6125
|
+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found">ResourceNotFound</a> in the Amazon Bedrock User Guide.</p>
|
|
6126
|
+
* @public
|
|
6127
|
+
*/
|
|
6128
|
+
interface ResourceNotFoundExceptionMember {
|
|
6129
|
+
output?: never;
|
|
6130
|
+
citation?: never;
|
|
6131
|
+
guardrail?: never;
|
|
6132
|
+
internalServerException?: never;
|
|
6133
|
+
validationException?: never;
|
|
6134
|
+
resourceNotFoundException: ResourceNotFoundException;
|
|
6135
|
+
serviceQuotaExceededException?: never;
|
|
6136
|
+
throttlingException?: never;
|
|
6137
|
+
accessDeniedException?: never;
|
|
6138
|
+
conflictException?: never;
|
|
6139
|
+
dependencyFailedException?: never;
|
|
6140
|
+
badGatewayException?: never;
|
|
6141
|
+
$unknown?: never;
|
|
6142
|
+
}
|
|
6143
|
+
/**
|
|
6144
|
+
* <p>Your request exceeds the service quota for your account. You can view your quotas at <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html">Viewing service quotas</a>. You can resubmit your request later.</p>
|
|
6145
|
+
* @public
|
|
6146
|
+
*/
|
|
6147
|
+
interface ServiceQuotaExceededExceptionMember {
|
|
6148
|
+
output?: never;
|
|
6149
|
+
citation?: never;
|
|
6150
|
+
guardrail?: never;
|
|
6151
|
+
internalServerException?: never;
|
|
6152
|
+
validationException?: never;
|
|
6153
|
+
resourceNotFoundException?: never;
|
|
6154
|
+
serviceQuotaExceededException: ServiceQuotaExceededException;
|
|
6155
|
+
throttlingException?: never;
|
|
6156
|
+
accessDeniedException?: never;
|
|
6157
|
+
conflictException?: never;
|
|
6158
|
+
dependencyFailedException?: never;
|
|
6159
|
+
badGatewayException?: never;
|
|
6160
|
+
$unknown?: never;
|
|
6161
|
+
}
|
|
6162
|
+
/**
|
|
6163
|
+
* <p>Your request was denied due to exceeding the account quotas for <i>Amazon Bedrock</i>. For
|
|
6164
|
+
* troubleshooting this error, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception">ThrottlingException</a> in the Amazon Bedrock User Guide.</p>
|
|
6165
|
+
* @public
|
|
6166
|
+
*/
|
|
6167
|
+
interface ThrottlingExceptionMember {
|
|
6168
|
+
output?: never;
|
|
6169
|
+
citation?: never;
|
|
6170
|
+
guardrail?: never;
|
|
6171
|
+
internalServerException?: never;
|
|
6172
|
+
validationException?: never;
|
|
6173
|
+
resourceNotFoundException?: never;
|
|
6174
|
+
serviceQuotaExceededException?: never;
|
|
6175
|
+
throttlingException: ThrottlingException;
|
|
6176
|
+
accessDeniedException?: never;
|
|
6177
|
+
conflictException?: never;
|
|
6178
|
+
dependencyFailedException?: never;
|
|
6179
|
+
badGatewayException?: never;
|
|
6180
|
+
$unknown?: never;
|
|
6181
|
+
}
|
|
6182
|
+
/**
|
|
6183
|
+
* <p>The request is denied because you do not have sufficient permissions to perform the requested action. For troubleshooting this error,
|
|
6184
|
+
* see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied">AccessDeniedException</a> in the Amazon Bedrock User Guide.</p>
|
|
6185
|
+
* @public
|
|
6186
|
+
*/
|
|
6187
|
+
interface AccessDeniedExceptionMember {
|
|
6188
|
+
output?: never;
|
|
6189
|
+
citation?: never;
|
|
6190
|
+
guardrail?: never;
|
|
6191
|
+
internalServerException?: never;
|
|
6192
|
+
validationException?: never;
|
|
6193
|
+
resourceNotFoundException?: never;
|
|
6194
|
+
serviceQuotaExceededException?: never;
|
|
6195
|
+
throttlingException?: never;
|
|
6196
|
+
accessDeniedException: AccessDeniedException;
|
|
6197
|
+
conflictException?: never;
|
|
6198
|
+
dependencyFailedException?: never;
|
|
6199
|
+
badGatewayException?: never;
|
|
6200
|
+
$unknown?: never;
|
|
6201
|
+
}
|
|
6202
|
+
/**
|
|
6203
|
+
* <p>Error occurred because of a conflict while performing an operation.</p>
|
|
6204
|
+
* @public
|
|
6205
|
+
*/
|
|
6206
|
+
interface ConflictExceptionMember {
|
|
6207
|
+
output?: never;
|
|
6208
|
+
citation?: never;
|
|
6209
|
+
guardrail?: never;
|
|
6210
|
+
internalServerException?: never;
|
|
6211
|
+
validationException?: never;
|
|
6212
|
+
resourceNotFoundException?: never;
|
|
6213
|
+
serviceQuotaExceededException?: never;
|
|
6214
|
+
throttlingException?: never;
|
|
6215
|
+
accessDeniedException?: never;
|
|
6216
|
+
conflictException: ConflictException;
|
|
6217
|
+
dependencyFailedException?: never;
|
|
6218
|
+
badGatewayException?: never;
|
|
6219
|
+
$unknown?: never;
|
|
6220
|
+
}
|
|
6221
|
+
/**
|
|
6222
|
+
* <p>The request failed due to a dependency error.</p>
|
|
5112
6223
|
* @public
|
|
5113
6224
|
*/
|
|
5114
|
-
|
|
5115
|
-
|
|
5116
|
-
|
|
5117
|
-
|
|
5118
|
-
|
|
5119
|
-
|
|
5120
|
-
|
|
5121
|
-
|
|
5122
|
-
|
|
5123
|
-
|
|
5124
|
-
|
|
5125
|
-
|
|
5126
|
-
|
|
5127
|
-
|
|
5128
|
-
|
|
5129
|
-
* <p>Contains the response generated from querying the knowledge base.</p>
|
|
5130
|
-
* <p>This data type is used in the following API operations:</p>
|
|
5131
|
-
* <ul>
|
|
5132
|
-
* <li>
|
|
5133
|
-
* <p>
|
|
5134
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax">RetrieveAndGenerate response</a> – in the <code>output</code> field</p>
|
|
5135
|
-
* </li>
|
|
5136
|
-
* </ul>
|
|
5137
|
-
* @public
|
|
5138
|
-
*/
|
|
5139
|
-
export interface RetrieveAndGenerateOutput {
|
|
6225
|
+
interface DependencyFailedExceptionMember {
|
|
6226
|
+
output?: never;
|
|
6227
|
+
citation?: never;
|
|
6228
|
+
guardrail?: never;
|
|
6229
|
+
internalServerException?: never;
|
|
6230
|
+
validationException?: never;
|
|
6231
|
+
resourceNotFoundException?: never;
|
|
6232
|
+
serviceQuotaExceededException?: never;
|
|
6233
|
+
throttlingException?: never;
|
|
6234
|
+
accessDeniedException?: never;
|
|
6235
|
+
conflictException?: never;
|
|
6236
|
+
dependencyFailedException: DependencyFailedException;
|
|
6237
|
+
badGatewayException?: never;
|
|
6238
|
+
$unknown?: never;
|
|
6239
|
+
}
|
|
5140
6240
|
/**
|
|
5141
|
-
* <p>The
|
|
6241
|
+
* <p>The request failed due to a bad gateway error.</p>
|
|
5142
6242
|
* @public
|
|
5143
6243
|
*/
|
|
5144
|
-
|
|
6244
|
+
interface BadGatewayExceptionMember {
|
|
6245
|
+
output?: never;
|
|
6246
|
+
citation?: never;
|
|
6247
|
+
guardrail?: never;
|
|
6248
|
+
internalServerException?: never;
|
|
6249
|
+
validationException?: never;
|
|
6250
|
+
resourceNotFoundException?: never;
|
|
6251
|
+
serviceQuotaExceededException?: never;
|
|
6252
|
+
throttlingException?: never;
|
|
6253
|
+
accessDeniedException?: never;
|
|
6254
|
+
conflictException?: never;
|
|
6255
|
+
dependencyFailedException?: never;
|
|
6256
|
+
badGatewayException: BadGatewayException;
|
|
6257
|
+
$unknown?: never;
|
|
6258
|
+
}
|
|
6259
|
+
/**
|
|
6260
|
+
* @public
|
|
6261
|
+
*/
|
|
6262
|
+
interface $UnknownMember {
|
|
6263
|
+
output?: never;
|
|
6264
|
+
citation?: never;
|
|
6265
|
+
guardrail?: never;
|
|
6266
|
+
internalServerException?: never;
|
|
6267
|
+
validationException?: never;
|
|
6268
|
+
resourceNotFoundException?: never;
|
|
6269
|
+
serviceQuotaExceededException?: never;
|
|
6270
|
+
throttlingException?: never;
|
|
6271
|
+
accessDeniedException?: never;
|
|
6272
|
+
conflictException?: never;
|
|
6273
|
+
dependencyFailedException?: never;
|
|
6274
|
+
badGatewayException?: never;
|
|
6275
|
+
$unknown: [string, any];
|
|
6276
|
+
}
|
|
6277
|
+
interface Visitor<T> {
|
|
6278
|
+
output: (value: RetrieveAndGenerateOutputEvent) => T;
|
|
6279
|
+
citation: (value: CitationEvent) => T;
|
|
6280
|
+
guardrail: (value: GuardrailEvent) => T;
|
|
6281
|
+
internalServerException: (value: InternalServerException) => T;
|
|
6282
|
+
validationException: (value: ValidationException) => T;
|
|
6283
|
+
resourceNotFoundException: (value: ResourceNotFoundException) => T;
|
|
6284
|
+
serviceQuotaExceededException: (value: ServiceQuotaExceededException) => T;
|
|
6285
|
+
throttlingException: (value: ThrottlingException) => T;
|
|
6286
|
+
accessDeniedException: (value: AccessDeniedException) => T;
|
|
6287
|
+
conflictException: (value: ConflictException) => T;
|
|
6288
|
+
dependencyFailedException: (value: DependencyFailedException) => T;
|
|
6289
|
+
badGatewayException: (value: BadGatewayException) => T;
|
|
6290
|
+
_: (name: string, value: any) => T;
|
|
6291
|
+
}
|
|
6292
|
+
const visit: <T>(value: RetrieveAndGenerateStreamResponseOutput, visitor: Visitor<T>) => T;
|
|
5145
6293
|
}
|
|
5146
6294
|
/**
|
|
5147
6295
|
* @public
|
|
5148
6296
|
*/
|
|
5149
|
-
export interface
|
|
5150
|
-
/**
|
|
5151
|
-
* <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
|
|
5152
|
-
* @public
|
|
5153
|
-
*/
|
|
5154
|
-
sessionId: string | undefined;
|
|
5155
|
-
/**
|
|
5156
|
-
* <p>Contains the response generated from querying the knowledge base.</p>
|
|
5157
|
-
* @public
|
|
5158
|
-
*/
|
|
5159
|
-
output: RetrieveAndGenerateOutput | undefined;
|
|
6297
|
+
export interface RetrieveAndGenerateStreamResponse {
|
|
5160
6298
|
/**
|
|
5161
|
-
* <p>A
|
|
6299
|
+
* <p>A stream of events from the model.</p>
|
|
5162
6300
|
* @public
|
|
5163
6301
|
*/
|
|
5164
|
-
|
|
6302
|
+
stream: AsyncIterable<RetrieveAndGenerateStreamResponseOutput> | undefined;
|
|
5165
6303
|
/**
|
|
5166
|
-
* <p>
|
|
6304
|
+
* <p>The session ID.</p>
|
|
5167
6305
|
* @public
|
|
5168
6306
|
*/
|
|
5169
|
-
|
|
6307
|
+
sessionId: string | undefined;
|
|
5170
6308
|
}
|
|
5171
6309
|
/**
|
|
5172
6310
|
* <p>Contains the query made to the knowledge base.</p>
|
|
@@ -5228,6 +6366,11 @@ export interface RetrieveResponse {
|
|
|
5228
6366
|
* @public
|
|
5229
6367
|
*/
|
|
5230
6368
|
retrievalResults: KnowledgeBaseRetrievalResult[] | undefined;
|
|
6369
|
+
/**
|
|
6370
|
+
* <p>Specifies if there is a guardrail intervention in the response.</p>
|
|
6371
|
+
* @public
|
|
6372
|
+
*/
|
|
6373
|
+
guardrailAction?: GuadrailAction | undefined;
|
|
5231
6374
|
/**
|
|
5232
6375
|
* <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
|
|
5233
6376
|
* @public
|
|
@@ -5636,6 +6779,16 @@ export interface KnowledgeBaseVectorSearchConfiguration {
|
|
|
5636
6779
|
* @public
|
|
5637
6780
|
*/
|
|
5638
6781
|
filter?: RetrievalFilter | undefined;
|
|
6782
|
+
/**
|
|
6783
|
+
* <p>Contains configurations for reranking the retrieved results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/rerank.html">Improve the relevance of query responses with a reranker model</a>.</p>
|
|
6784
|
+
* @public
|
|
6785
|
+
*/
|
|
6786
|
+
rerankingConfiguration?: VectorSearchRerankingConfiguration | undefined;
|
|
6787
|
+
/**
|
|
6788
|
+
* <p>Settings for implicit filtering.</p>
|
|
6789
|
+
* @public
|
|
6790
|
+
*/
|
|
6791
|
+
implicitFilterConfiguration?: ImplicitFilterConfiguration | undefined;
|
|
5639
6792
|
}
|
|
5640
6793
|
/**
|
|
5641
6794
|
* <p>Contains configurations for knowledge base query. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
|
|
@@ -5765,6 +6918,11 @@ export interface RetrieveRequest {
|
|
|
5765
6918
|
* @public
|
|
5766
6919
|
*/
|
|
5767
6920
|
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
6921
|
+
/**
|
|
6922
|
+
* <p>Guardrail settings.</p>
|
|
6923
|
+
* @public
|
|
6924
|
+
*/
|
|
6925
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
5768
6926
|
/**
|
|
5769
6927
|
* <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
|
|
5770
6928
|
* @public
|
|
@@ -5930,6 +7088,31 @@ export interface RetrieveAndGenerateRequest {
|
|
|
5930
7088
|
*/
|
|
5931
7089
|
sessionConfiguration?: RetrieveAndGenerateSessionConfiguration | undefined;
|
|
5932
7090
|
}
|
|
7091
|
+
/**
|
|
7092
|
+
* @public
|
|
7093
|
+
*/
|
|
7094
|
+
export interface RetrieveAndGenerateStreamRequest {
|
|
7095
|
+
/**
|
|
7096
|
+
* <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
|
|
7097
|
+
* @public
|
|
7098
|
+
*/
|
|
7099
|
+
sessionId?: string | undefined;
|
|
7100
|
+
/**
|
|
7101
|
+
* <p>Contains the query to be made to the knowledge base.</p>
|
|
7102
|
+
* @public
|
|
7103
|
+
*/
|
|
7104
|
+
input: RetrieveAndGenerateInput | undefined;
|
|
7105
|
+
/**
|
|
7106
|
+
* <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
|
|
7107
|
+
* @public
|
|
7108
|
+
*/
|
|
7109
|
+
retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration | undefined;
|
|
7110
|
+
/**
|
|
7111
|
+
* <p>Contains details about the session with the knowledge base.</p>
|
|
7112
|
+
* @public
|
|
7113
|
+
*/
|
|
7114
|
+
sessionConfiguration?: RetrieveAndGenerateSessionConfiguration | undefined;
|
|
7115
|
+
}
|
|
5933
7116
|
/**
|
|
5934
7117
|
* <p>Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html">Lambda function</a> for an action group or pass them when making an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
5935
7118
|
* @public
|
|
@@ -5968,6 +7151,11 @@ export interface SessionState {
|
|
|
5968
7151
|
* @public
|
|
5969
7152
|
*/
|
|
5970
7153
|
knowledgeBaseConfigurations?: KnowledgeBaseConfiguration[] | undefined;
|
|
7154
|
+
/**
|
|
7155
|
+
* <p>The state's conversation history.</p>
|
|
7156
|
+
* @public
|
|
7157
|
+
*/
|
|
7158
|
+
conversationHistory?: ConversationHistory | undefined;
|
|
5971
7159
|
}
|
|
5972
7160
|
/**
|
|
5973
7161
|
* @public
|
|
@@ -6026,6 +7214,11 @@ export interface InvokeAgentRequest {
|
|
|
6026
7214
|
* @public
|
|
6027
7215
|
*/
|
|
6028
7216
|
streamingConfigurations?: StreamingConfigurations | undefined;
|
|
7217
|
+
/**
|
|
7218
|
+
* <p>The ARN of the resource making the request.</p>
|
|
7219
|
+
* @public
|
|
7220
|
+
*/
|
|
7221
|
+
sourceArn?: string | undefined;
|
|
6029
7222
|
}
|
|
6030
7223
|
/**
|
|
6031
7224
|
* @internal
|
|
@@ -6051,6 +7244,50 @@ export declare const FunctionSchemaFilterSensitiveLog: (obj: FunctionSchema) =>
|
|
|
6051
7244
|
* @internal
|
|
6052
7245
|
*/
|
|
6053
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;
|
|
6054
7291
|
/**
|
|
6055
7292
|
* @internal
|
|
6056
7293
|
*/
|
|
@@ -6115,6 +7352,18 @@ export declare const FlowResponseStreamFilterSensitiveLog: (obj: FlowResponseStr
|
|
|
6115
7352
|
* @internal
|
|
6116
7353
|
*/
|
|
6117
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;
|
|
6118
7367
|
/**
|
|
6119
7368
|
* @internal
|
|
6120
7369
|
*/
|
|
@@ -6130,11 +7379,27 @@ export declare const InputFileFilterSensitiveLog: (obj: InputFile) => any;
|
|
|
6130
7379
|
/**
|
|
6131
7380
|
* @internal
|
|
6132
7381
|
*/
|
|
6133
|
-
export declare const
|
|
7382
|
+
export declare const MetadataAttributeSchemaFilterSensitiveLog: (obj: MetadataAttributeSchema) => any;
|
|
6134
7383
|
/**
|
|
6135
7384
|
* @internal
|
|
6136
7385
|
*/
|
|
6137
|
-
export declare const
|
|
7386
|
+
export declare const ImplicitFilterConfigurationFilterSensitiveLog: (obj: ImplicitFilterConfiguration) => any;
|
|
7387
|
+
/**
|
|
7388
|
+
* @internal
|
|
7389
|
+
*/
|
|
7390
|
+
export declare const RerankingMetadataSelectiveModeConfigurationFilterSensitiveLog: (obj: RerankingMetadataSelectiveModeConfiguration) => any;
|
|
7391
|
+
/**
|
|
7392
|
+
* @internal
|
|
7393
|
+
*/
|
|
7394
|
+
export declare const MetadataConfigurationForRerankingFilterSensitiveLog: (obj: MetadataConfigurationForReranking) => any;
|
|
7395
|
+
/**
|
|
7396
|
+
* @internal
|
|
7397
|
+
*/
|
|
7398
|
+
export declare const VectorSearchBedrockRerankingConfigurationFilterSensitiveLog: (obj: VectorSearchBedrockRerankingConfiguration) => any;
|
|
7399
|
+
/**
|
|
7400
|
+
* @internal
|
|
7401
|
+
*/
|
|
7402
|
+
export declare const VectorSearchRerankingConfigurationFilterSensitiveLog: (obj: VectorSearchRerankingConfiguration) => any;
|
|
6138
7403
|
/**
|
|
6139
7404
|
* @internal
|
|
6140
7405
|
*/
|
|
@@ -6175,18 +7440,6 @@ export declare const OutputFileFilterSensitiveLog: (obj: OutputFile) => any;
|
|
|
6175
7440
|
* @internal
|
|
6176
7441
|
*/
|
|
6177
7442
|
export declare const FilePartFilterSensitiveLog: (obj: FilePart) => any;
|
|
6178
|
-
/**
|
|
6179
|
-
* @internal
|
|
6180
|
-
*/
|
|
6181
|
-
export declare const ApiInvocationInputFilterSensitiveLog: (obj: ApiInvocationInput) => any;
|
|
6182
|
-
/**
|
|
6183
|
-
* @internal
|
|
6184
|
-
*/
|
|
6185
|
-
export declare const InvocationInputMemberFilterSensitiveLog: (obj: InvocationInputMember) => any;
|
|
6186
|
-
/**
|
|
6187
|
-
* @internal
|
|
6188
|
-
*/
|
|
6189
|
-
export declare const ReturnControlPayloadFilterSensitiveLog: (obj: ReturnControlPayload) => any;
|
|
6190
7443
|
/**
|
|
6191
7444
|
* @internal
|
|
6192
7445
|
*/
|
|
@@ -6323,6 +7576,14 @@ export declare const PreProcessingModelInvocationOutputFilterSensitiveLog: (obj:
|
|
|
6323
7576
|
* @internal
|
|
6324
7577
|
*/
|
|
6325
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;
|
|
6326
7587
|
/**
|
|
6327
7588
|
* @internal
|
|
6328
7589
|
*/
|
|
@@ -6407,6 +7668,34 @@ export declare const OptimizedPromptStreamFilterSensitiveLog: (obj: OptimizedPro
|
|
|
6407
7668
|
* @internal
|
|
6408
7669
|
*/
|
|
6409
7670
|
export declare const OptimizePromptResponseFilterSensitiveLog: (obj: OptimizePromptResponse) => any;
|
|
7671
|
+
/**
|
|
7672
|
+
* @internal
|
|
7673
|
+
*/
|
|
7674
|
+
export declare const RerankTextDocumentFilterSensitiveLog: (obj: RerankTextDocument) => any;
|
|
7675
|
+
/**
|
|
7676
|
+
* @internal
|
|
7677
|
+
*/
|
|
7678
|
+
export declare const RerankQueryFilterSensitiveLog: (obj: RerankQuery) => any;
|
|
7679
|
+
/**
|
|
7680
|
+
* @internal
|
|
7681
|
+
*/
|
|
7682
|
+
export declare const RerankDocumentFilterSensitiveLog: (obj: RerankDocument) => any;
|
|
7683
|
+
/**
|
|
7684
|
+
* @internal
|
|
7685
|
+
*/
|
|
7686
|
+
export declare const RerankSourceFilterSensitiveLog: (obj: RerankSource) => any;
|
|
7687
|
+
/**
|
|
7688
|
+
* @internal
|
|
7689
|
+
*/
|
|
7690
|
+
export declare const RerankRequestFilterSensitiveLog: (obj: RerankRequest) => any;
|
|
7691
|
+
/**
|
|
7692
|
+
* @internal
|
|
7693
|
+
*/
|
|
7694
|
+
export declare const RerankResultFilterSensitiveLog: (obj: RerankResult) => any;
|
|
7695
|
+
/**
|
|
7696
|
+
* @internal
|
|
7697
|
+
*/
|
|
7698
|
+
export declare const RerankResponseFilterSensitiveLog: (obj: RerankResponse) => any;
|
|
6410
7699
|
/**
|
|
6411
7700
|
* @internal
|
|
6412
7701
|
*/
|
|
@@ -6447,6 +7736,22 @@ export declare const RetrieveAndGenerateOutputFilterSensitiveLog: (obj: Retrieve
|
|
|
6447
7736
|
* @internal
|
|
6448
7737
|
*/
|
|
6449
7738
|
export declare const RetrieveAndGenerateResponseFilterSensitiveLog: (obj: RetrieveAndGenerateResponse) => any;
|
|
7739
|
+
/**
|
|
7740
|
+
* @internal
|
|
7741
|
+
*/
|
|
7742
|
+
export declare const CitationEventFilterSensitiveLog: (obj: CitationEvent) => any;
|
|
7743
|
+
/**
|
|
7744
|
+
* @internal
|
|
7745
|
+
*/
|
|
7746
|
+
export declare const RetrieveAndGenerateOutputEventFilterSensitiveLog: (obj: RetrieveAndGenerateOutputEvent) => any;
|
|
7747
|
+
/**
|
|
7748
|
+
* @internal
|
|
7749
|
+
*/
|
|
7750
|
+
export declare const RetrieveAndGenerateStreamResponseOutputFilterSensitiveLog: (obj: RetrieveAndGenerateStreamResponseOutput) => any;
|
|
7751
|
+
/**
|
|
7752
|
+
* @internal
|
|
7753
|
+
*/
|
|
7754
|
+
export declare const RetrieveAndGenerateStreamResponseFilterSensitiveLog: (obj: RetrieveAndGenerateStreamResponse) => any;
|
|
6450
7755
|
/**
|
|
6451
7756
|
* @internal
|
|
6452
7757
|
*/
|
|
@@ -6499,6 +7804,10 @@ export declare const InvokeInlineAgentRequestFilterSensitiveLog: (obj: InvokeInl
|
|
|
6499
7804
|
* @internal
|
|
6500
7805
|
*/
|
|
6501
7806
|
export declare const RetrieveAndGenerateRequestFilterSensitiveLog: (obj: RetrieveAndGenerateRequest) => any;
|
|
7807
|
+
/**
|
|
7808
|
+
* @internal
|
|
7809
|
+
*/
|
|
7810
|
+
export declare const RetrieveAndGenerateStreamRequestFilterSensitiveLog: (obj: RetrieveAndGenerateStreamRequest) => any;
|
|
6502
7811
|
/**
|
|
6503
7812
|
* @internal
|
|
6504
7813
|
*/
|