aws-sdk-bedrockagentruntime 1.76.0 → 1.77.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.
@@ -378,6 +378,634 @@ module Aws::BedrockAgentRuntime
378
378
  include Aws::Structure
379
379
  end
380
380
 
381
+ # An action taken during agentic retrieval.
382
+ #
383
+ # @!attribute [rw] full_document_expansion
384
+ # Details of a full document expansion action.
385
+ # @return [Types::AgenticRetrieveFullDocExpansionDetails]
386
+ #
387
+ # @!attribute [rw] retrieve
388
+ # Details of the retrieve action.
389
+ # @return [Types::AgenticRetrieveActionDetails]
390
+ #
391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveAction AWS API Documentation
392
+ #
393
+ class AgenticRetrieveAction < Struct.new(
394
+ :full_document_expansion,
395
+ :retrieve)
396
+ SENSITIVE = []
397
+ include Aws::Structure
398
+ end
399
+
400
+ # Details of a retrieve action including the query and target
401
+ # retrievers.
402
+ #
403
+ # @!attribute [rw] input_query
404
+ # The input query used for retrieval.
405
+ # @return [Types::AgenticRetrieveMessageContent]
406
+ #
407
+ # @!attribute [rw] source_retrievers
408
+ # The list of source retrievers targeted by this action.
409
+ # @return [Array<Types::AgenticRetrieveSourceRetriever>]
410
+ #
411
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveActionDetails AWS API Documentation
412
+ #
413
+ class AgenticRetrieveActionDetails < Struct.new(
414
+ :input_query,
415
+ :source_retrievers)
416
+ SENSITIVE = [:input_query]
417
+ include Aws::Structure
418
+ end
419
+
420
+ # Configuration for a Bedrock guardrail applied during agentic
421
+ # retrieval.
422
+ #
423
+ # @!attribute [rw] guardrail_id
424
+ # The unique identifier of the guardrail.
425
+ # @return [String]
426
+ #
427
+ # @!attribute [rw] guardrail_version
428
+ # The version of the guardrail to use.
429
+ # @return [String]
430
+ #
431
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveBedrockGuardrailConfiguration AWS API Documentation
432
+ #
433
+ class AgenticRetrieveBedrockGuardrailConfiguration < Struct.new(
434
+ :guardrail_id,
435
+ :guardrail_version)
436
+ SENSITIVE = []
437
+ include Aws::Structure
438
+ end
439
+
440
+ # Configuration for a Bedrock reranking model.
441
+ #
442
+ # @!attribute [rw] model_configuration
443
+ # The model configuration containing the model ARN.
444
+ # @return [Types::AgenticRetrieveBedrockRerankingModelConfiguration]
445
+ #
446
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveBedrockRerankingConfiguration AWS API Documentation
447
+ #
448
+ class AgenticRetrieveBedrockRerankingConfiguration < Struct.new(
449
+ :model_configuration)
450
+ SENSITIVE = []
451
+ include Aws::Structure
452
+ end
453
+
454
+ # Model configuration for a Bedrock reranking model.
455
+ #
456
+ # @!attribute [rw] model_arn
457
+ # The ARN of the Bedrock reranking model.
458
+ # @return [String]
459
+ #
460
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveBedrockRerankingModelConfiguration AWS API Documentation
461
+ #
462
+ class AgenticRetrieveBedrockRerankingModelConfiguration < Struct.new(
463
+ :model_arn)
464
+ SENSITIVE = []
465
+ include Aws::Structure
466
+ end
467
+
468
+ # A citation mapping a span of the generated answer to supporting
469
+ # results.
470
+ #
471
+ # @!attribute [rw] end_index
472
+ # Character offset end (exclusive) in the answer text.
473
+ # @return [Integer]
474
+ #
475
+ # @!attribute [rw] references
476
+ # References to results that support this span.
477
+ # @return [Array<Types::AgenticRetrieveCitationReference>]
478
+ #
479
+ # @!attribute [rw] start_index
480
+ # Character offset start in the answer text.
481
+ # @return [Integer]
482
+ #
483
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveCitation AWS API Documentation
484
+ #
485
+ class AgenticRetrieveCitation < Struct.new(
486
+ :end_index,
487
+ :references,
488
+ :start_index)
489
+ SENSITIVE = []
490
+ include Aws::Structure
491
+ end
492
+
493
+ # A reference to a specific result item.
494
+ #
495
+ # @!attribute [rw] result_index
496
+ # Index into the results array on the same event.
497
+ # @return [Integer]
498
+ #
499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveCitationReference AWS API Documentation
500
+ #
501
+ class AgenticRetrieveCitationReference < Struct.new(
502
+ :result_index)
503
+ SENSITIVE = []
504
+ include Aws::Structure
505
+ end
506
+
507
+ # Configuration settings for the agentic retrieval operation.
508
+ #
509
+ # @!attribute [rw] foundation_model_configuration
510
+ # The foundation model configuration. Required when
511
+ # foundationModelType is CUSTOM.
512
+ # @return [Types::FoundationModelConfiguration]
513
+ #
514
+ # @!attribute [rw] foundation_model_type
515
+ # The type of foundation model to use. CUSTOM uses a specified model,
516
+ # MANAGED uses the service default.
517
+ # @return [String]
518
+ #
519
+ # @!attribute [rw] max_agent_iteration
520
+ # The maximum number of agent iterations for retrieval.
521
+ # @return [Integer]
522
+ #
523
+ # @!attribute [rw] reranking_configuration
524
+ # The reranking model configuration. Required when rerankingModelType
525
+ # is CUSTOM.
526
+ # @return [Types::AgenticRetrieveRerankingConfiguration]
527
+ #
528
+ # @!attribute [rw] reranking_model_type
529
+ # The type of reranking model to use. CUSTOM uses a specified model,
530
+ # MANAGED uses the service default. If not specified, defaults to
531
+ # MANAGED for managed embedding knowledge bases and NONE for custom
532
+ # embedding knowledge bases.
533
+ # @return [String]
534
+ #
535
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveConfiguration AWS API Documentation
536
+ #
537
+ class AgenticRetrieveConfiguration < Struct.new(
538
+ :foundation_model_configuration,
539
+ :foundation_model_type,
540
+ :max_agent_iteration,
541
+ :reranking_configuration,
542
+ :reranking_model_type)
543
+ SENSITIVE = []
544
+ include Aws::Structure
545
+ end
546
+
547
+ # A failure that occurred during agentic retrieval.
548
+ #
549
+ # @!attribute [rw] message
550
+ # A message describing the failure.
551
+ # @return [String]
552
+ #
553
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveFailure AWS API Documentation
554
+ #
555
+ class AgenticRetrieveFailure < Struct.new(
556
+ :message)
557
+ SENSITIVE = []
558
+ include Aws::Structure
559
+ end
560
+
561
+ # Details of a full document expansion action.
562
+ #
563
+ # @!attribute [rw] document_id
564
+ # The identifier of the document to expand.
565
+ # @return [String]
566
+ #
567
+ # @!attribute [rw] source_retriever
568
+ # The source retriever associated with the document.
569
+ # @return [Types::AgenticRetrieveSourceRetriever]
570
+ #
571
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveFullDocExpansionDetails AWS API Documentation
572
+ #
573
+ class AgenticRetrieveFullDocExpansionDetails < Struct.new(
574
+ :document_id,
575
+ :source_retriever)
576
+ SENSITIVE = []
577
+ include Aws::Structure
578
+ end
579
+
580
+ # The generated response synthesized from retrieved results.
581
+ #
582
+ # @!attribute [rw] answer
583
+ # The generated answer text.
584
+ # @return [String]
585
+ #
586
+ # @!attribute [rw] citations
587
+ # Citations mapping spans of the answer to supporting results.
588
+ # @return [Array<Types::AgenticRetrieveCitation>]
589
+ #
590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveGeneratedResponse AWS API Documentation
591
+ #
592
+ class AgenticRetrieveGeneratedResponse < Struct.new(
593
+ :answer,
594
+ :citations)
595
+ SENSITIVE = []
596
+ include Aws::Structure
597
+ end
598
+
599
+ # A warning generated by a guardrail during agentic retrieval.
600
+ #
601
+ # @!attribute [rw] action
602
+ # The action taken by the guardrail.
603
+ # @return [String]
604
+ #
605
+ # @!attribute [rw] id
606
+ # The unique identifier of the guardrail.
607
+ # @return [String]
608
+ #
609
+ # @!attribute [rw] message
610
+ # A message describing the guardrail evaluation result.
611
+ # @return [String]
612
+ #
613
+ # @!attribute [rw] version
614
+ # The version of the guardrail.
615
+ # @return [String]
616
+ #
617
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveGuardrailWarning AWS API Documentation
618
+ #
619
+ class AgenticRetrieveGuardrailWarning < Struct.new(
620
+ :action,
621
+ :id,
622
+ :message,
623
+ :version)
624
+ SENSITIVE = []
625
+ include Aws::Structure
626
+ end
627
+
628
+ # A message in the agentic retrieval conversation.
629
+ #
630
+ # @!attribute [rw] content
631
+ # The content of the message.
632
+ # @return [Types::AgenticRetrieveMessageContent]
633
+ #
634
+ # @!attribute [rw] role
635
+ # The role of the message sender (e.g., user or assistant).
636
+ # @return [String]
637
+ #
638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveMessage AWS API Documentation
639
+ #
640
+ class AgenticRetrieveMessage < Struct.new(
641
+ :content,
642
+ :role)
643
+ SENSITIVE = [:content]
644
+ include Aws::Structure
645
+ end
646
+
647
+ # The content of an agentic retrieval message.
648
+ #
649
+ # @!attribute [rw] text
650
+ # The text content of the message.
651
+ # @return [String]
652
+ #
653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveMessageContent AWS API Documentation
654
+ #
655
+ class AgenticRetrieveMessageContent < Struct.new(
656
+ :text)
657
+ SENSITIVE = []
658
+ include Aws::Structure
659
+ end
660
+
661
+ # Policy configuration for agentic retrieval.
662
+ #
663
+ # @!attribute [rw] bedrock_guardrail_configuration
664
+ # Configuration for Bedrock guardrails to apply during retrieval.
665
+ # @return [Types::AgenticRetrieveBedrockGuardrailConfiguration]
666
+ #
667
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrievePolicyConfiguration AWS API Documentation
668
+ #
669
+ class AgenticRetrievePolicyConfiguration < Struct.new(
670
+ :bedrock_guardrail_configuration)
671
+ SENSITIVE = []
672
+ include Aws::Structure
673
+ end
674
+
675
+ # Configuration for the reranking model.
676
+ #
677
+ # @!attribute [rw] bedrock_reranking_configuration
678
+ # The Bedrock reranking model configuration.
679
+ # @return [Types::AgenticRetrieveBedrockRerankingConfiguration]
680
+ #
681
+ # @!attribute [rw] type
682
+ # The type of reranking configuration.
683
+ # @return [String]
684
+ #
685
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveRerankingConfiguration AWS API Documentation
686
+ #
687
+ class AgenticRetrieveRerankingConfiguration < Struct.new(
688
+ :bedrock_reranking_configuration,
689
+ :type)
690
+ SENSITIVE = []
691
+ include Aws::Structure
692
+ end
693
+
694
+ # A chunk of the generated answer text.
695
+ #
696
+ # @!attribute [rw] text
697
+ # The generated text chunk.
698
+ # @return [String]
699
+ #
700
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveResponseEvent AWS API Documentation
701
+ #
702
+ class AgenticRetrieveResponseEvent < Struct.new(
703
+ :text,
704
+ :event_type)
705
+ SENSITIVE = []
706
+ include Aws::Structure
707
+ end
708
+
709
+ # An event containing agentic retrieval results.
710
+ #
711
+ # @!attribute [rw] generated_response
712
+ # The generated response. Present only when generateResponse is true.
713
+ # @return [Types::AgenticRetrieveGeneratedResponse]
714
+ #
715
+ # @!attribute [rw] next_token
716
+ # Opaque continuation token for paginated results.
717
+ # @return [String]
718
+ #
719
+ # @!attribute [rw] results
720
+ # The list of retrieved result items.
721
+ # @return [Array<Types::AgenticRetrieveResultItem>]
722
+ #
723
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveResultEvent AWS API Documentation
724
+ #
725
+ class AgenticRetrieveResultEvent < Struct.new(
726
+ :generated_response,
727
+ :next_token,
728
+ :results,
729
+ :event_type)
730
+ SENSITIVE = []
731
+ include Aws::Structure
732
+ end
733
+
734
+ # A single item from the agentic retrieval results.
735
+ #
736
+ # @!attribute [rw] content
737
+ # The retrieved content.
738
+ # @return [Types::RetrievalContent]
739
+ #
740
+ # @!attribute [rw] metadata
741
+ # Metadata associated with the retrieved item.
742
+ # @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
743
+ #
744
+ # @!attribute [rw] source_retriever
745
+ # The source retriever that produced this result.
746
+ # @return [Types::AgenticRetrieveSourceRetriever]
747
+ #
748
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveResultItem AWS API Documentation
749
+ #
750
+ class AgenticRetrieveResultItem < Struct.new(
751
+ :content,
752
+ :metadata,
753
+ :source_retriever)
754
+ SENSITIVE = []
755
+ include Aws::Structure
756
+ end
757
+
758
+ # Metadata about a retrieval source.
759
+ #
760
+ # @!attribute [rw] identifier
761
+ # The identifier of the retrieval source.
762
+ # @return [String]
763
+ #
764
+ # @!attribute [rw] retrieval_type
765
+ # The type of retrieval source.
766
+ # @return [String]
767
+ #
768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveSourceMetadata AWS API Documentation
769
+ #
770
+ class AgenticRetrieveSourceMetadata < Struct.new(
771
+ :identifier,
772
+ :retrieval_type)
773
+ SENSITIVE = []
774
+ include Aws::Structure
775
+ end
776
+
777
+ # A source retriever that produced retrieval results.
778
+ #
779
+ # @!attribute [rw] identifier
780
+ # The unique identifier of the source retriever.
781
+ # @return [String]
782
+ #
783
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveSourceRetriever AWS API Documentation
784
+ #
785
+ class AgenticRetrieveSourceRetriever < Struct.new(
786
+ :identifier)
787
+ SENSITIVE = []
788
+ include Aws::Structure
789
+ end
790
+
791
+ # Request structure for the agentic retrieve stream operation.
792
+ #
793
+ # @!attribute [rw] agentic_retrieve_configuration
794
+ # Configuration settings for the agentic retrieval operation.
795
+ # @return [Types::AgenticRetrieveConfiguration]
796
+ #
797
+ # @!attribute [rw] generate_response
798
+ # Whether to generate a response based on the retrieved results.
799
+ # @return [Boolean]
800
+ #
801
+ # @!attribute [rw] messages
802
+ # The list of messages for the agentic retrieval conversation.
803
+ # @return [Array<Types::AgenticRetrieveMessage>]
804
+ #
805
+ # @!attribute [rw] next_token
806
+ # Opaque continuation token for paginated results.
807
+ # @return [String]
808
+ #
809
+ # @!attribute [rw] policy_configuration
810
+ # Policy configuration for guardrails and content filtering.
811
+ # @return [Types::AgenticRetrievePolicyConfiguration]
812
+ #
813
+ # @!attribute [rw] retrievers
814
+ # The list of retrievers to use for agentic retrieval.
815
+ # @return [Array<Types::AgenticRetriever>]
816
+ #
817
+ # @!attribute [rw] user_context
818
+ # Contains information about the user making the request. This is used
819
+ # for access control filtering to ensure that retrieval results only
820
+ # include documents the user is authorized to access.
821
+ # @return [Types::UserContext]
822
+ #
823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveStreamRequest AWS API Documentation
824
+ #
825
+ class AgenticRetrieveStreamRequest < Struct.new(
826
+ :agentic_retrieve_configuration,
827
+ :generate_response,
828
+ :messages,
829
+ :next_token,
830
+ :policy_configuration,
831
+ :retrievers,
832
+ :user_context)
833
+ SENSITIVE = [:user_context]
834
+ include Aws::Structure
835
+ end
836
+
837
+ # Response structure for the agentic retrieve stream operation.
838
+ #
839
+ # @!attribute [rw] stream
840
+ # The output stream containing retrieval results and trace events.
841
+ # @return [Types::AgenticRetrieveStreamResponseOutput]
842
+ #
843
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveStreamResponse AWS API Documentation
844
+ #
845
+ class AgenticRetrieveStreamResponse < Struct.new(
846
+ :stream)
847
+ SENSITIVE = []
848
+ include Aws::Structure
849
+ end
850
+
851
+ # A trace event providing visibility into the agentic retrieval process.
852
+ #
853
+ # @!attribute [rw] attributes
854
+ # The attributes describing the trace event details.
855
+ # @return [Types::AgenticRetrieveTraceEventAttributes]
856
+ #
857
+ # @!attribute [rw] id
858
+ # The unique identifier of the trace event.
859
+ # @return [String]
860
+ #
861
+ # @!attribute [rw] timestamp
862
+ # The timestamp when the trace event occurred.
863
+ # @return [Integer]
864
+ #
865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveTraceEvent AWS API Documentation
866
+ #
867
+ class AgenticRetrieveTraceEvent < Struct.new(
868
+ :attributes,
869
+ :id,
870
+ :timestamp,
871
+ :event_type)
872
+ SENSITIVE = []
873
+ include Aws::Structure
874
+ end
875
+
876
+ # Attributes describing the details of an agentic retrieval trace event.
877
+ #
878
+ # @!attribute [rw] actions
879
+ # The list of actions taken during this step.
880
+ # @return [Array<Types::AgenticRetrieveAction>]
881
+ #
882
+ # @!attribute [rw] failures
883
+ # Failures that occurred during this step.
884
+ # @return [Array<Types::AgenticRetrieveFailure>]
885
+ #
886
+ # @!attribute [rw] message
887
+ # A human-readable message describing the trace event.
888
+ # @return [String]
889
+ #
890
+ # @!attribute [rw] retrieval_metadata
891
+ # Metadata about the retrieval sources used.
892
+ # @return [Array<Types::AgenticRetrieveSourceMetadata>]
893
+ #
894
+ # @!attribute [rw] retrieval_response
895
+ # The retrieval results from this step.
896
+ # @return [Array<Types::AgenticRetrieveTraceResultItem>]
897
+ #
898
+ # @!attribute [rw] status
899
+ # The status of the current step.
900
+ # @return [String]
901
+ #
902
+ # @!attribute [rw] step
903
+ # The current step in the retrieval process.
904
+ # @return [String]
905
+ #
906
+ # @!attribute [rw] warnings
907
+ # Warnings generated during this step.
908
+ # @return [Array<Types::AgenticRetrieveWarning>]
909
+ #
910
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveTraceEventAttributes AWS API Documentation
911
+ #
912
+ class AgenticRetrieveTraceEventAttributes < Struct.new(
913
+ :actions,
914
+ :failures,
915
+ :message,
916
+ :retrieval_metadata,
917
+ :retrieval_response,
918
+ :status,
919
+ :step,
920
+ :warnings)
921
+ SENSITIVE = []
922
+ include Aws::Structure
923
+ end
924
+
925
+ # A result item from an agentic retrieval trace.
926
+ #
927
+ # @!attribute [rw] content
928
+ # The retrieved content.
929
+ # @return [Types::RetrievalContent]
930
+ #
931
+ # @!attribute [rw] metadata
932
+ # Metadata associated with the retrieved item.
933
+ # @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
934
+ #
935
+ # @!attribute [rw] source_retriever
936
+ # The source retriever that produced this result.
937
+ # @return [Types::AgenticRetrieveSourceRetriever]
938
+ #
939
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveTraceResultItem AWS API Documentation
940
+ #
941
+ class AgenticRetrieveTraceResultItem < Struct.new(
942
+ :content,
943
+ :metadata,
944
+ :source_retriever)
945
+ SENSITIVE = []
946
+ include Aws::Structure
947
+ end
948
+
949
+ # A warning generated during agentic retrieval.
950
+ #
951
+ # @note AgenticRetrieveWarning is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AgenticRetrieveWarning corresponding to the set member.
952
+ #
953
+ # @!attribute [rw] guardrail
954
+ # A warning from a guardrail evaluation.
955
+ # @return [Types::AgenticRetrieveGuardrailWarning]
956
+ #
957
+ # @!attribute [rw] message
958
+ # A general warning message.
959
+ # @return [Types::AgenticRetrieveWarningMessage]
960
+ #
961
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveWarning AWS API Documentation
962
+ #
963
+ class AgenticRetrieveWarning < Struct.new(
964
+ :guardrail,
965
+ :message,
966
+ :unknown)
967
+ SENSITIVE = []
968
+ include Aws::Structure
969
+ include Aws::Structure::Union
970
+
971
+ class Guardrail < AgenticRetrieveWarning; end
972
+ class Message < AgenticRetrieveWarning; end
973
+ class Unknown < AgenticRetrieveWarning; end
974
+ end
975
+
976
+ # A general warning message from agentic retrieval.
977
+ #
978
+ # @!attribute [rw] message
979
+ # The warning message text.
980
+ # @return [String]
981
+ #
982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveWarningMessage AWS API Documentation
983
+ #
984
+ class AgenticRetrieveWarningMessage < Struct.new(
985
+ :message)
986
+ SENSITIVE = []
987
+ include Aws::Structure
988
+ end
989
+
990
+ # A retriever used in agentic retrieval.
991
+ #
992
+ # @!attribute [rw] configuration
993
+ # The configuration for this retriever.
994
+ # @return [Types::RetrieverConfiguration]
995
+ #
996
+ # @!attribute [rw] description
997
+ # A description of the retriever's purpose.
998
+ # @return [String]
999
+ #
1000
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetriever AWS API Documentation
1001
+ #
1002
+ class AgenticRetriever < Struct.new(
1003
+ :configuration,
1004
+ :description)
1005
+ SENSITIVE = []
1006
+ include Aws::Structure
1007
+ end
1008
+
381
1009
  # An event in which the prompt was analyzed in preparation for
382
1010
  # optimization.
383
1011
  #
@@ -652,6 +1280,34 @@ module Aws::BedrockAgentRuntime
652
1280
  include Aws::Structure
653
1281
  end
654
1282
 
1283
+ # Configuration for a Bedrock foundation model.
1284
+ #
1285
+ # @!attribute [rw] model_configuration
1286
+ # The model configuration containing the model ARN.
1287
+ # @return [Types::BedrockFoundationModelModelConfiguration]
1288
+ #
1289
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/BedrockFoundationModelConfiguration AWS API Documentation
1290
+ #
1291
+ class BedrockFoundationModelConfiguration < Struct.new(
1292
+ :model_configuration)
1293
+ SENSITIVE = []
1294
+ include Aws::Structure
1295
+ end
1296
+
1297
+ # Model configuration for a Bedrock foundation model.
1298
+ #
1299
+ # @!attribute [rw] model_arn
1300
+ # The ARN of the Bedrock foundation model.
1301
+ # @return [String]
1302
+ #
1303
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/BedrockFoundationModelModelConfiguration AWS API Documentation
1304
+ #
1305
+ class BedrockFoundationModelModelConfiguration < Struct.new(
1306
+ :model_arn)
1307
+ SENSITIVE = []
1308
+ include Aws::Structure
1309
+ end
1310
+
655
1311
  # Settings for a model called with InvokeAgent.
656
1312
  #
657
1313
  # @!attribute [rw] performance_config
@@ -1615,7 +2271,7 @@ module Aws::BedrockAgentRuntime
1615
2271
  # @return [String]
1616
2272
  #
1617
2273
  # @!attribute [rw] value
1618
- # The value to whcih to compare the value of the metadata attribute.
2274
+ # The value to which to compare the value of the metadata attribute.
1619
2275
  # @return [Hash,Array,String,Numeric,Boolean]
1620
2276
  #
1621
2277
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FilterAttribute AWS API Documentation
@@ -2612,6 +3268,25 @@ module Aws::BedrockAgentRuntime
2612
3268
  include Aws::Structure
2613
3269
  end
2614
3270
 
3271
+ # Configuration for the foundation model.
3272
+ #
3273
+ # @!attribute [rw] bedrock_foundation_model_configuration
3274
+ # The Bedrock foundation model configuration.
3275
+ # @return [Types::BedrockFoundationModelConfiguration]
3276
+ #
3277
+ # @!attribute [rw] type
3278
+ # The type of foundation model configuration.
3279
+ # @return [String]
3280
+ #
3281
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FoundationModelConfiguration AWS API Documentation
3282
+ #
3283
+ class FoundationModelConfiguration < Struct.new(
3284
+ :bedrock_foundation_model_configuration,
3285
+ :type)
3286
+ SENSITIVE = []
3287
+ include Aws::Structure
3288
+ end
3289
+
2615
3290
  # Defines parameters that the agent needs to invoke from the user to
2616
3291
  # complete the function. Corresponds to an action in an action group.
2617
3292
  #
@@ -3015,6 +3690,70 @@ module Aws::BedrockAgentRuntime
3015
3690
  include Aws::Structure
3016
3691
  end
3017
3692
 
3693
+ # @!attribute [rw] data_source_id
3694
+ # The unique identifier of the data source that contains the document.
3695
+ # @return [String]
3696
+ #
3697
+ # @!attribute [rw] document_id
3698
+ # The unique identifier of the document to retrieve content for.
3699
+ # @return [String]
3700
+ #
3701
+ # @!attribute [rw] knowledge_base_id
3702
+ # The unique identifier of the knowledge base that contains the
3703
+ # document.
3704
+ # @return [String]
3705
+ #
3706
+ # @!attribute [rw] output_format
3707
+ # The output format for the document content. `RAW` returns the
3708
+ # original file. `EXTRACTED` returns parsed text as JSON. Defaults to
3709
+ # `RAW`.
3710
+ # @return [String]
3711
+ #
3712
+ # @!attribute [rw] user_context
3713
+ # Contains information about the user making the request. Use this to
3714
+ # pass user identity information for access control filtering, so that
3715
+ # retrieval results only include documents the user is authorized to
3716
+ # access.
3717
+ # @return [Types::UserContext]
3718
+ #
3719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetDocumentContentRequest AWS API Documentation
3720
+ #
3721
+ class GetDocumentContentRequest < Struct.new(
3722
+ :data_source_id,
3723
+ :document_id,
3724
+ :knowledge_base_id,
3725
+ :output_format,
3726
+ :user_context)
3727
+ SENSITIVE = [:user_context]
3728
+ include Aws::Structure
3729
+ end
3730
+
3731
+ # @!attribute [rw] document_content_length
3732
+ # The size of the document content in bytes available at the
3733
+ # pre-signed URL.
3734
+ # @return [Integer]
3735
+ #
3736
+ # @!attribute [rw] mime_type
3737
+ # The MIME type of the document content. For `RAW` format, this is the
3738
+ # original file type (for example, `application/pdf`). For `EXTRACTED`
3739
+ # format, this is always `application/json`.
3740
+ # @return [String]
3741
+ #
3742
+ # @!attribute [rw] presigned_url
3743
+ # A pre-signed URL for downloading the document content. The URL
3744
+ # expires after 5 minutes.
3745
+ # @return [String]
3746
+ #
3747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetDocumentContentResponse AWS API Documentation
3748
+ #
3749
+ class GetDocumentContentResponse < Struct.new(
3750
+ :document_content_length,
3751
+ :mime_type,
3752
+ :presigned_url)
3753
+ SENSITIVE = [:presigned_url]
3754
+ include Aws::Structure
3755
+ end
3756
+
3018
3757
  # @!attribute [rw] execution_identifier
3019
3758
  # The unique identifier of the flow execution.
3020
3759
  # @return [String]
@@ -4885,6 +5624,15 @@ module Aws::BedrockAgentRuntime
4885
5624
  # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax
4886
5625
  # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
4887
5626
  #
5627
+ # @!attribute [rw] managed_search_configuration
5628
+ # Contains configurations for managed search. For more information,
5629
+ # see [Query configurations][1].
5630
+ #
5631
+ #
5632
+ #
5633
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
5634
+ # @return [Types::ManagedSearchConfiguration]
5635
+ #
4888
5636
  # @!attribute [rw] vector_search_configuration
4889
5637
  # Contains details about how the results from the vector search should
4890
5638
  # be returned. For more information, see [Query configurations][1].
@@ -4897,6 +5645,7 @@ module Aws::BedrockAgentRuntime
4897
5645
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/KnowledgeBaseRetrievalConfiguration AWS API Documentation
4898
5646
  #
4899
5647
  class KnowledgeBaseRetrievalConfiguration < Struct.new(
5648
+ :managed_search_configuration,
4900
5649
  :vector_search_configuration)
4901
5650
  SENSITIVE = []
4902
5651
  include Aws::Structure
@@ -4918,6 +5667,11 @@ module Aws::BedrockAgentRuntime
4918
5667
  # Contains information about the content of the chunk.
4919
5668
  # @return [Types::RetrievalResultContent]
4920
5669
  #
5670
+ # @!attribute [rw] document_id
5671
+ # The unique identifier of the document. Use with `GetDocumentContent`
5672
+ # to retrieve the full document.
5673
+ # @return [String]
5674
+ #
4921
5675
  # @!attribute [rw] location
4922
5676
  # Contains information about the location of the data source.
4923
5677
  # @return [Types::RetrievalResultLocation]
@@ -4939,6 +5693,7 @@ module Aws::BedrockAgentRuntime
4939
5693
  #
4940
5694
  class KnowledgeBaseRetrievalResult < Struct.new(
4941
5695
  :content,
5696
+ :document_id,
4942
5697
  :location,
4943
5698
  :metadata,
4944
5699
  :score)
@@ -5000,6 +5755,25 @@ module Aws::BedrockAgentRuntime
5000
5755
  include Aws::Structure
5001
5756
  end
5002
5757
 
5758
+ # Configuration for retrieving from a Bedrock knowledge base.
5759
+ #
5760
+ # @!attribute [rw] knowledge_base_id
5761
+ # The unique identifier of the knowledge base.
5762
+ # @return [String]
5763
+ #
5764
+ # @!attribute [rw] retrieval_overrides
5765
+ # Overrides for retrieval behavior such as filters and result limits.
5766
+ # @return [Types::RetrievalOverrides]
5767
+ #
5768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/KnowledgeBaseRetrieverConfiguration AWS API Documentation
5769
+ #
5770
+ class KnowledgeBaseRetrieverConfiguration < Struct.new(
5771
+ :knowledge_base_id,
5772
+ :retrieval_overrides)
5773
+ SENSITIVE = []
5774
+ include Aws::Structure
5775
+ end
5776
+
5003
5777
  # Configurations for how to perform the search query and return results.
5004
5778
  # For more information, see [Query configurations][1].
5005
5779
  #
@@ -5360,6 +6134,118 @@ module Aws::BedrockAgentRuntime
5360
6134
  include Aws::Structure
5361
6135
  end
5362
6136
 
6137
+ # Configuration for a Bedrock reranking model used in managed search.
6138
+ #
6139
+ # @!attribute [rw] metadata_configuration
6140
+ # The metadata configuration for reranking.
6141
+ # @return [Types::MetadataConfigurationForReranking]
6142
+ #
6143
+ # @!attribute [rw] model_configuration
6144
+ # The model configuration containing the model ARN for reranking.
6145
+ # @return [Types::ManagedSearchBedrockRerankingModelConfiguration]
6146
+ #
6147
+ # @!attribute [rw] number_of_reranked_results
6148
+ # The number of results to return after reranking.
6149
+ # @return [Integer]
6150
+ #
6151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ManagedSearchBedrockRerankingConfiguration AWS API Documentation
6152
+ #
6153
+ class ManagedSearchBedrockRerankingConfiguration < Struct.new(
6154
+ :metadata_configuration,
6155
+ :model_configuration,
6156
+ :number_of_reranked_results)
6157
+ SENSITIVE = []
6158
+ include Aws::Structure
6159
+ end
6160
+
6161
+ # Model configuration for a Bedrock reranking model used in managed
6162
+ # search.
6163
+ #
6164
+ # @!attribute [rw] additional_model_request_fields
6165
+ # Additional request fields to pass to the reranking model.
6166
+ # @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
6167
+ #
6168
+ # @!attribute [rw] model_arn
6169
+ # The ARN of the Bedrock reranking model.
6170
+ # @return [String]
6171
+ #
6172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ManagedSearchBedrockRerankingModelConfiguration AWS API Documentation
6173
+ #
6174
+ class ManagedSearchBedrockRerankingModelConfiguration < Struct.new(
6175
+ :additional_model_request_fields,
6176
+ :model_arn)
6177
+ SENSITIVE = []
6178
+ include Aws::Structure
6179
+ end
6180
+
6181
+ # Configuration for managed search in a knowledge base. Managed search
6182
+ # automatically determines the best search strategy based on your data
6183
+ # store configuration.
6184
+ #
6185
+ # @!attribute [rw] filter
6186
+ # Specifies the filters to use on the metadata attributes in the
6187
+ # knowledge base data sources before returning results. For more
6188
+ # information, see [Query configurations][1]. See the examples below
6189
+ # to see how to use these filters.
6190
+ #
6191
+ # This data type is used in the following API operations:
6192
+ #
6193
+ # * [Retrieve request][2] – in the `filter` field
6194
+ #
6195
+ # * [RetrieveAndGenerate request][3] – in the `filter` field
6196
+ #
6197
+ #
6198
+ #
6199
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
6200
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax
6201
+ # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
6202
+ # @return [Types::RetrievalFilter]
6203
+ #
6204
+ # @!attribute [rw] number_of_results
6205
+ # The number of results to retrieve.
6206
+ # @return [Integer]
6207
+ #
6208
+ # @!attribute [rw] reranking_configuration
6209
+ # Contains configurations for reranking the results retrieved from the
6210
+ # managed search.
6211
+ # @return [Types::ManagedSearchRerankingConfiguration]
6212
+ #
6213
+ # @!attribute [rw] reranking_model_type
6214
+ # The type of reranking model to use when reranking results retrieved
6215
+ # from the managed search. Use `CUSTOM` to specify a model, `MANAGED`
6216
+ # to use the service default, or `NONE` to disable reranking.
6217
+ # @return [String]
6218
+ #
6219
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ManagedSearchConfiguration AWS API Documentation
6220
+ #
6221
+ class ManagedSearchConfiguration < Struct.new(
6222
+ :filter,
6223
+ :number_of_results,
6224
+ :reranking_configuration,
6225
+ :reranking_model_type)
6226
+ SENSITIVE = [:filter]
6227
+ include Aws::Structure
6228
+ end
6229
+
6230
+ # Configuration for the reranking model used in managed search.
6231
+ #
6232
+ # @!attribute [rw] bedrock_reranking_configuration
6233
+ # The Bedrock reranking model configuration for managed search.
6234
+ # @return [Types::ManagedSearchBedrockRerankingConfiguration]
6235
+ #
6236
+ # @!attribute [rw] type
6237
+ # The type of reranking configuration.
6238
+ # @return [String]
6239
+ #
6240
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ManagedSearchRerankingConfiguration AWS API Documentation
6241
+ #
6242
+ class ManagedSearchRerankingConfiguration < Struct.new(
6243
+ :bedrock_reranking_configuration,
6244
+ :type)
6245
+ SENSITIVE = []
6246
+ include Aws::Structure
6247
+ end
6248
+
5363
6249
  # Contains sessions summaries.
5364
6250
  #
5365
6251
  # @note Memory is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Memory corresponding to the set member.
@@ -7264,6 +8150,30 @@ module Aws::BedrockAgentRuntime
7264
8150
  include Aws::Structure
7265
8151
  end
7266
8152
 
8153
+ # The content retrieved from a knowledge source.
8154
+ #
8155
+ # @!attribute [rw] byte_content
8156
+ # The binary content of the retrieved item.
8157
+ # @return [String]
8158
+ #
8159
+ # @!attribute [rw] mime_type
8160
+ # The MIME type of the retrieved content.
8161
+ # @return [String]
8162
+ #
8163
+ # @!attribute [rw] text
8164
+ # The text content of the retrieved item.
8165
+ # @return [String]
8166
+ #
8167
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalContent AWS API Documentation
8168
+ #
8169
+ class RetrievalContent < Struct.new(
8170
+ :byte_content,
8171
+ :mime_type,
8172
+ :text)
8173
+ SENSITIVE = []
8174
+ include Aws::Structure
8175
+ end
8176
+
7267
8177
  # Specifies the filters to use on the metadata attributes in the
7268
8178
  # knowledge base data sources before returning results. For more
7269
8179
  # information, see [Query configurations][1]. See the examples below to
@@ -7465,6 +8375,25 @@ module Aws::BedrockAgentRuntime
7465
8375
  class Unknown < RetrievalFilter; end
7466
8376
  end
7467
8377
 
8378
+ # Overrides for retrieval behavior.
8379
+ #
8380
+ # @!attribute [rw] filter
8381
+ # A filter to apply to the retrieval results.
8382
+ # @return [Types::RetrievalFilter]
8383
+ #
8384
+ # @!attribute [rw] max_number_of_results
8385
+ # The maximum number of results to return.
8386
+ # @return [Integer]
8387
+ #
8388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalOverrides AWS API Documentation
8389
+ #
8390
+ class RetrievalOverrides < Struct.new(
8391
+ :filter,
8392
+ :max_number_of_results)
8393
+ SENSITIVE = [:filter]
8394
+ include Aws::Structure
8395
+ end
8396
+
7468
8397
  # The Confluence data source location.
7469
8398
  #
7470
8399
  # @!attribute [rw] url
@@ -7579,6 +8508,20 @@ module Aws::BedrockAgentRuntime
7579
8508
  include Aws::Structure
7580
8509
  end
7581
8510
 
8511
+ # The Google Drive location of a retrieval result.
8512
+ #
8513
+ # @!attribute [rw] url
8514
+ # The Google Drive URL for the data source location.
8515
+ # @return [String]
8516
+ #
8517
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalResultGoogleDriveLocation AWS API Documentation
8518
+ #
8519
+ class RetrievalResultGoogleDriveLocation < Struct.new(
8520
+ :url)
8521
+ SENSITIVE = []
8522
+ include Aws::Structure
8523
+ end
8524
+
7582
8525
  # The location of a result in Amazon Kendra.
7583
8526
  #
7584
8527
  # @!attribute [rw] uri
@@ -7617,10 +8560,18 @@ module Aws::BedrockAgentRuntime
7617
8560
  # Specifies the location of a document in a custom data source.
7618
8561
  # @return [Types::RetrievalResultCustomDocumentLocation]
7619
8562
  #
8563
+ # @!attribute [rw] google_drive_location
8564
+ # The Google Drive data source location.
8565
+ # @return [Types::RetrievalResultGoogleDriveLocation]
8566
+ #
7620
8567
  # @!attribute [rw] kendra_document_location
7621
8568
  # The location of a document in Amazon Kendra.
7622
8569
  # @return [Types::RetrievalResultKendraDocumentLocation]
7623
8570
  #
8571
+ # @!attribute [rw] one_drive_location
8572
+ # The Microsoft OneDrive data source location.
8573
+ # @return [Types::RetrievalResultOneDriveLocation]
8574
+ #
7624
8575
  # @!attribute [rw] s3_location
7625
8576
  # The S3 data source location.
7626
8577
  # @return [Types::RetrievalResultS3Location]
@@ -7651,7 +8602,9 @@ module Aws::BedrockAgentRuntime
7651
8602
  class RetrievalResultLocation < Struct.new(
7652
8603
  :confluence_location,
7653
8604
  :custom_document_location,
8605
+ :google_drive_location,
7654
8606
  :kendra_document_location,
8607
+ :one_drive_location,
7655
8608
  :s3_location,
7656
8609
  :salesforce_location,
7657
8610
  :share_point_location,
@@ -7662,6 +8615,20 @@ module Aws::BedrockAgentRuntime
7662
8615
  include Aws::Structure
7663
8616
  end
7664
8617
 
8618
+ # The Microsoft OneDrive location of a retrieval result.
8619
+ #
8620
+ # @!attribute [rw] url
8621
+ # The OneDrive URL for the data source location.
8622
+ # @return [String]
8623
+ #
8624
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalResultOneDriveLocation AWS API Documentation
8625
+ #
8626
+ class RetrievalResultOneDriveLocation < Struct.new(
8627
+ :url)
8628
+ SENSITIVE = []
8629
+ include Aws::Structure
8630
+ end
8631
+
7665
8632
  # The S3 data source location.
7666
8633
  #
7667
8634
  # This data type is used in the following API operations:
@@ -7878,14 +8845,22 @@ module Aws::BedrockAgentRuntime
7878
8845
  # interactions. You can't explicitly set the `sessionId` yourself.
7879
8846
  # @return [String]
7880
8847
  #
8848
+ # @!attribute [rw] user_context
8849
+ # Contains information about the user making the request. Use this to
8850
+ # pass user identity information for access control filtering, so that
8851
+ # retrieval results only include documents the user is authorized to
8852
+ # access.
8853
+ # @return [Types::UserContext]
8854
+ #
7881
8855
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateRequest AWS API Documentation
7882
8856
  #
7883
8857
  class RetrieveAndGenerateRequest < Struct.new(
7884
8858
  :input,
7885
8859
  :retrieve_and_generate_configuration,
7886
8860
  :session_configuration,
7887
- :session_id)
7888
- SENSITIVE = [:input]
8861
+ :session_id,
8862
+ :user_context)
8863
+ SENSITIVE = [:input, :user_context]
7889
8864
  include Aws::Structure
7890
8865
  end
7891
8866
 
@@ -7974,14 +8949,22 @@ module Aws::BedrockAgentRuntime
7974
8949
  # interactions. You can't explicitly set the `sessionId` yourself.
7975
8950
  # @return [String]
7976
8951
  #
8952
+ # @!attribute [rw] user_context
8953
+ # Contains information about the user making the request. Use this to
8954
+ # pass user identity information for access control filtering, so that
8955
+ # retrieval results only include documents the user is authorized to
8956
+ # access.
8957
+ # @return [Types::UserContext]
8958
+ #
7977
8959
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStreamRequest AWS API Documentation
7978
8960
  #
7979
8961
  class RetrieveAndGenerateStreamRequest < Struct.new(
7980
8962
  :input,
7981
8963
  :retrieve_and_generate_configuration,
7982
8964
  :session_configuration,
7983
- :session_id)
7984
- SENSITIVE = [:input]
8965
+ :session_id,
8966
+ :user_context)
8967
+ SENSITIVE = [:input, :user_context]
7985
8968
  include Aws::Structure
7986
8969
  end
7987
8970
 
@@ -8029,6 +9012,13 @@ module Aws::BedrockAgentRuntime
8029
9012
  # Contains the query to send the knowledge base.
8030
9013
  # @return [Types::KnowledgeBaseQuery]
8031
9014
  #
9015
+ # @!attribute [rw] user_context
9016
+ # Contains information about the user making the request. Use this to
9017
+ # pass user identity information for access control filtering, so that
9018
+ # retrieval results only include documents the user is authorized to
9019
+ # access.
9020
+ # @return [Types::UserContext]
9021
+ #
8032
9022
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveRequest AWS API Documentation
8033
9023
  #
8034
9024
  class RetrieveRequest < Struct.new(
@@ -8036,8 +9026,9 @@ module Aws::BedrockAgentRuntime
8036
9026
  :knowledge_base_id,
8037
9027
  :next_token,
8038
9028
  :retrieval_configuration,
8039
- :retrieval_query)
8040
- SENSITIVE = [:retrieval_query]
9029
+ :retrieval_query,
9030
+ :user_context)
9031
+ SENSITIVE = [:retrieval_query, :user_context]
8041
9032
  include Aws::Structure
8042
9033
  end
8043
9034
 
@@ -8106,6 +9097,28 @@ module Aws::BedrockAgentRuntime
8106
9097
  include Aws::Structure
8107
9098
  end
8108
9099
 
9100
+ # Configuration for a retriever, specified as a union of retriever
9101
+ # types.
9102
+ #
9103
+ # @note RetrieverConfiguration is a union - when making an API calls you must set exactly one of the members.
9104
+ #
9105
+ # @!attribute [rw] knowledge_base
9106
+ # Configuration for a knowledge base retriever.
9107
+ # @return [Types::KnowledgeBaseRetrieverConfiguration]
9108
+ #
9109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieverConfiguration AWS API Documentation
9110
+ #
9111
+ class RetrieverConfiguration < Struct.new(
9112
+ :knowledge_base,
9113
+ :unknown)
9114
+ SENSITIVE = []
9115
+ include Aws::Structure
9116
+ include Aws::Structure::Union
9117
+
9118
+ class KnowledgeBase < RetrieverConfiguration; end
9119
+ class Unknown < RetrieverConfiguration; end
9120
+ end
9121
+
8109
9122
  # Contains information to return from the action group that the agent
8110
9123
  # has predicted to invoke.
8111
9124
  #
@@ -9056,6 +10069,23 @@ module Aws::BedrockAgentRuntime
9056
10069
  include Aws::Structure
9057
10070
  end
9058
10071
 
10072
+ # Contains information about the user making the request. Use this to
10073
+ # pass user identity information for access control filtering, so that
10074
+ # retrieval results only include documents the user is authorized to
10075
+ # access.
10076
+ #
10077
+ # @!attribute [rw] user_id
10078
+ # The identifier of the user making the retrieval request.
10079
+ # @return [String]
10080
+ #
10081
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/UserContext AWS API Documentation
10082
+ #
10083
+ class UserContext < Struct.new(
10084
+ :user_id)
10085
+ SENSITIVE = []
10086
+ include Aws::Structure
10087
+ end
10088
+
9059
10089
  # Input validation failed. Check your request parameters and retry the
9060
10090
  # request.
9061
10091
  #
@@ -9166,6 +10196,35 @@ module Aws::BedrockAgentRuntime
9166
10196
  include Aws::Structure
9167
10197
  end
9168
10198
 
10199
+ # The streaming output for agentic retrieval, containing results,
10200
+ # traces, and errors.
10201
+ #
10202
+ # EventStream is an Enumerator of Events.
10203
+ # #event_types #=> Array, returns all modeled event types in the stream
10204
+ #
10205
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveStreamResponseOutput AWS API Documentation
10206
+ #
10207
+ class AgenticRetrieveStreamResponseOutput < Enumerator
10208
+
10209
+ def event_types
10210
+ [
10211
+ :access_denied_exception,
10212
+ :bad_gateway_exception,
10213
+ :conflict_exception,
10214
+ :dependency_failed_exception,
10215
+ :internal_server_exception,
10216
+ :resource_not_found_exception,
10217
+ :response_event,
10218
+ :result,
10219
+ :service_quota_exceeded_exception,
10220
+ :throttling_exception,
10221
+ :trace_event,
10222
+ :validation_exception
10223
+ ]
10224
+ end
10225
+
10226
+ end
10227
+
9169
10228
  # The output of the flow.
9170
10229
  #
9171
10230
  # EventStream is an Enumerator of Events.