aws-sdk-bedrockagentruntime 1.75.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockagentruntime/client.rb +1220 -32
- data/lib/aws-sdk-bedrockagentruntime/client_api.rb +358 -2
- data/lib/aws-sdk-bedrockagentruntime/event_streams.rb +89 -0
- data/lib/aws-sdk-bedrockagentruntime/types.rb +1066 -7
- data/lib/aws-sdk-bedrockagentruntime.rb +2 -2
- data/sig/client.rbs +92 -2
- data/sig/params.rbs +61 -38
- data/sig/types.rbs +315 -4
- metadata +1 -1
|
@@ -485,6 +485,469 @@ module Aws::BedrockAgentRuntime
|
|
|
485
485
|
|
|
486
486
|
# @!group API Operations
|
|
487
487
|
|
|
488
|
+
# Retrieves information from one or more knowledge bases using an
|
|
489
|
+
# agentic approach. Agentic retrieval uses a foundation model to
|
|
490
|
+
# intelligently decompose complex queries into sub-queries and
|
|
491
|
+
# iteratively retrieve relevant information from your knowledge bases.
|
|
492
|
+
# This approach improves retrieval accuracy for complex, multi-step
|
|
493
|
+
# questions that a single retrieval pass might not fully address.
|
|
494
|
+
#
|
|
495
|
+
# The operation returns results through a stream that includes retrieval
|
|
496
|
+
# results, trace events for visibility into the process, and a generated
|
|
497
|
+
# response synthesized from the results by default, which can be turned
|
|
498
|
+
# off.
|
|
499
|
+
#
|
|
500
|
+
# @option params [required, Types::AgenticRetrieveConfiguration] :agentic_retrieve_configuration
|
|
501
|
+
# Configuration settings for the agentic retrieval operation.
|
|
502
|
+
#
|
|
503
|
+
# @option params [Boolean] :generate_response
|
|
504
|
+
# Whether to generate a response based on the retrieved results.
|
|
505
|
+
#
|
|
506
|
+
# @option params [required, Array<Types::AgenticRetrieveMessage>] :messages
|
|
507
|
+
# The list of messages for the agentic retrieval conversation.
|
|
508
|
+
#
|
|
509
|
+
# @option params [String] :next_token
|
|
510
|
+
# Opaque continuation token for paginated results.
|
|
511
|
+
#
|
|
512
|
+
# @option params [Types::AgenticRetrievePolicyConfiguration] :policy_configuration
|
|
513
|
+
# Policy configuration for guardrails and content filtering.
|
|
514
|
+
#
|
|
515
|
+
# @option params [required, Array<Types::AgenticRetriever>] :retrievers
|
|
516
|
+
# The list of retrievers to use for agentic retrieval.
|
|
517
|
+
#
|
|
518
|
+
# @option params [Types::UserContext] :user_context
|
|
519
|
+
# Contains information about the user making the request. This is used
|
|
520
|
+
# for access control filtering to ensure that retrieval results only
|
|
521
|
+
# include documents the user is authorized to access.
|
|
522
|
+
#
|
|
523
|
+
# @return [Types::AgenticRetrieveStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
524
|
+
#
|
|
525
|
+
# * {Types::AgenticRetrieveStreamResponse#stream #stream} => Types::AgenticRetrieveStreamResponseOutput
|
|
526
|
+
#
|
|
527
|
+
# @example EventStream Operation Example
|
|
528
|
+
#
|
|
529
|
+
# # You can process the event once it arrives immediately, or wait until the
|
|
530
|
+
# # full response is complete and iterate through the eventstream enumerator.
|
|
531
|
+
#
|
|
532
|
+
# # To interact with event immediately, you need to register agentic_retrieve_stream
|
|
533
|
+
# # with callbacks. Callbacks can be registered for specific events or for all
|
|
534
|
+
# # events, including error events.
|
|
535
|
+
#
|
|
536
|
+
# # Callbacks can be passed into the `:event_stream_handler` option or within a
|
|
537
|
+
# # block statement attached to the #agentic_retrieve_stream call directly. Hybrid
|
|
538
|
+
# # pattern of both is also supported.
|
|
539
|
+
#
|
|
540
|
+
# # `:event_stream_handler` option takes in either a Proc object or
|
|
541
|
+
# # Aws::BedrockAgentRuntime::EventStreams::AgenticRetrieveStreamResponseOutput object.
|
|
542
|
+
#
|
|
543
|
+
# # Usage pattern a): Callbacks with a block attached to #agentic_retrieve_stream
|
|
544
|
+
# # Example for registering callbacks for all event types and an error event
|
|
545
|
+
# client.agentic_retrieve_stream(
|
|
546
|
+
# # params input
|
|
547
|
+
# ) do |stream|
|
|
548
|
+
# stream.on_error_event do |event|
|
|
549
|
+
# # catch unmodeled error event in the stream
|
|
550
|
+
# raise event
|
|
551
|
+
# # => Aws::Errors::EventError
|
|
552
|
+
# # event.event_type => :error
|
|
553
|
+
# # event.error_code => String
|
|
554
|
+
# # event.error_message => String
|
|
555
|
+
# end
|
|
556
|
+
#
|
|
557
|
+
# stream.on_event do |event|
|
|
558
|
+
# # process all events arrive
|
|
559
|
+
# puts event.event_type
|
|
560
|
+
# # ...
|
|
561
|
+
# end
|
|
562
|
+
# end
|
|
563
|
+
#
|
|
564
|
+
# # Usage pattern b): Pass in `:event_stream_handler` for #agentic_retrieve_stream
|
|
565
|
+
# # 1) Create a Aws::BedrockAgentRuntime::EventStreams::AgenticRetrieveStreamResponseOutput object
|
|
566
|
+
# # Example for registering callbacks with specific events
|
|
567
|
+
#
|
|
568
|
+
# handler = Aws::BedrockAgentRuntime::EventStreams::AgenticRetrieveStreamResponseOutput.new
|
|
569
|
+
# handler.on_access_denied_exception_event do |event|
|
|
570
|
+
# event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
|
|
571
|
+
# end
|
|
572
|
+
# handler.on_bad_gateway_exception_event do |event|
|
|
573
|
+
# event # => Aws::BedrockAgentRuntime::Types::badGatewayException
|
|
574
|
+
# end
|
|
575
|
+
# handler.on_conflict_exception_event do |event|
|
|
576
|
+
# event # => Aws::BedrockAgentRuntime::Types::conflictException
|
|
577
|
+
# end
|
|
578
|
+
# handler.on_dependency_failed_exception_event do |event|
|
|
579
|
+
# event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
|
|
580
|
+
# end
|
|
581
|
+
# handler.on_internal_server_exception_event do |event|
|
|
582
|
+
# event # => Aws::BedrockAgentRuntime::Types::internalServerException
|
|
583
|
+
# end
|
|
584
|
+
# handler.on_resource_not_found_exception_event do |event|
|
|
585
|
+
# event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
|
|
586
|
+
# end
|
|
587
|
+
# handler.on_response_event_event do |event|
|
|
588
|
+
# event # => Aws::BedrockAgentRuntime::Types::responseEvent
|
|
589
|
+
# end
|
|
590
|
+
# handler.on_result_event do |event|
|
|
591
|
+
# event # => Aws::BedrockAgentRuntime::Types::result
|
|
592
|
+
# end
|
|
593
|
+
# handler.on_service_quota_exceeded_exception_event do |event|
|
|
594
|
+
# event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
|
|
595
|
+
# end
|
|
596
|
+
# handler.on_throttling_exception_event do |event|
|
|
597
|
+
# event # => Aws::BedrockAgentRuntime::Types::throttlingException
|
|
598
|
+
# end
|
|
599
|
+
# handler.on_trace_event_event do |event|
|
|
600
|
+
# event # => Aws::BedrockAgentRuntime::Types::traceEvent
|
|
601
|
+
# end
|
|
602
|
+
# handler.on_validation_exception_event do |event|
|
|
603
|
+
# event # => Aws::BedrockAgentRuntime::Types::validationException
|
|
604
|
+
# end
|
|
605
|
+
#
|
|
606
|
+
# client.agentic_retrieve_stream(
|
|
607
|
+
# # params inputs
|
|
608
|
+
# event_stream_handler: handler
|
|
609
|
+
# )
|
|
610
|
+
#
|
|
611
|
+
# # 2) Use a Ruby Proc object
|
|
612
|
+
# # Example for registering callbacks with specific events
|
|
613
|
+
# handler = Proc.new do |stream|
|
|
614
|
+
# stream.on_access_denied_exception_event do |event|
|
|
615
|
+
# event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
|
|
616
|
+
# end
|
|
617
|
+
# stream.on_bad_gateway_exception_event do |event|
|
|
618
|
+
# event # => Aws::BedrockAgentRuntime::Types::badGatewayException
|
|
619
|
+
# end
|
|
620
|
+
# stream.on_conflict_exception_event do |event|
|
|
621
|
+
# event # => Aws::BedrockAgentRuntime::Types::conflictException
|
|
622
|
+
# end
|
|
623
|
+
# stream.on_dependency_failed_exception_event do |event|
|
|
624
|
+
# event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
|
|
625
|
+
# end
|
|
626
|
+
# stream.on_internal_server_exception_event do |event|
|
|
627
|
+
# event # => Aws::BedrockAgentRuntime::Types::internalServerException
|
|
628
|
+
# end
|
|
629
|
+
# stream.on_resource_not_found_exception_event do |event|
|
|
630
|
+
# event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
|
|
631
|
+
# end
|
|
632
|
+
# stream.on_response_event_event do |event|
|
|
633
|
+
# event # => Aws::BedrockAgentRuntime::Types::responseEvent
|
|
634
|
+
# end
|
|
635
|
+
# stream.on_result_event do |event|
|
|
636
|
+
# event # => Aws::BedrockAgentRuntime::Types::result
|
|
637
|
+
# end
|
|
638
|
+
# stream.on_service_quota_exceeded_exception_event do |event|
|
|
639
|
+
# event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
|
|
640
|
+
# end
|
|
641
|
+
# stream.on_throttling_exception_event do |event|
|
|
642
|
+
# event # => Aws::BedrockAgentRuntime::Types::throttlingException
|
|
643
|
+
# end
|
|
644
|
+
# stream.on_trace_event_event do |event|
|
|
645
|
+
# event # => Aws::BedrockAgentRuntime::Types::traceEvent
|
|
646
|
+
# end
|
|
647
|
+
# stream.on_validation_exception_event do |event|
|
|
648
|
+
# event # => Aws::BedrockAgentRuntime::Types::validationException
|
|
649
|
+
# end
|
|
650
|
+
# end
|
|
651
|
+
#
|
|
652
|
+
# client.agentic_retrieve_stream(
|
|
653
|
+
# # params inputs
|
|
654
|
+
# event_stream_handler: handler
|
|
655
|
+
# )
|
|
656
|
+
#
|
|
657
|
+
# # Usage pattern c): Hybrid pattern of a) and b)
|
|
658
|
+
# handler = Aws::BedrockAgentRuntime::EventStreams::AgenticRetrieveStreamResponseOutput.new
|
|
659
|
+
# handler.on_access_denied_exception_event do |event|
|
|
660
|
+
# event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
|
|
661
|
+
# end
|
|
662
|
+
# handler.on_bad_gateway_exception_event do |event|
|
|
663
|
+
# event # => Aws::BedrockAgentRuntime::Types::badGatewayException
|
|
664
|
+
# end
|
|
665
|
+
# handler.on_conflict_exception_event do |event|
|
|
666
|
+
# event # => Aws::BedrockAgentRuntime::Types::conflictException
|
|
667
|
+
# end
|
|
668
|
+
# handler.on_dependency_failed_exception_event do |event|
|
|
669
|
+
# event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
|
|
670
|
+
# end
|
|
671
|
+
# handler.on_internal_server_exception_event do |event|
|
|
672
|
+
# event # => Aws::BedrockAgentRuntime::Types::internalServerException
|
|
673
|
+
# end
|
|
674
|
+
# handler.on_resource_not_found_exception_event do |event|
|
|
675
|
+
# event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
|
|
676
|
+
# end
|
|
677
|
+
# handler.on_response_event_event do |event|
|
|
678
|
+
# event # => Aws::BedrockAgentRuntime::Types::responseEvent
|
|
679
|
+
# end
|
|
680
|
+
# handler.on_result_event do |event|
|
|
681
|
+
# event # => Aws::BedrockAgentRuntime::Types::result
|
|
682
|
+
# end
|
|
683
|
+
# handler.on_service_quota_exceeded_exception_event do |event|
|
|
684
|
+
# event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
|
|
685
|
+
# end
|
|
686
|
+
# handler.on_throttling_exception_event do |event|
|
|
687
|
+
# event # => Aws::BedrockAgentRuntime::Types::throttlingException
|
|
688
|
+
# end
|
|
689
|
+
# handler.on_trace_event_event do |event|
|
|
690
|
+
# event # => Aws::BedrockAgentRuntime::Types::traceEvent
|
|
691
|
+
# end
|
|
692
|
+
# handler.on_validation_exception_event do |event|
|
|
693
|
+
# event # => Aws::BedrockAgentRuntime::Types::validationException
|
|
694
|
+
# end
|
|
695
|
+
#
|
|
696
|
+
# client.agentic_retrieve_stream(
|
|
697
|
+
# # params input
|
|
698
|
+
# event_stream_handler: handler
|
|
699
|
+
# ) do |stream|
|
|
700
|
+
# stream.on_error_event do |event|
|
|
701
|
+
# # catch unmodeled error event in the stream
|
|
702
|
+
# raise event
|
|
703
|
+
# # => Aws::Errors::EventError
|
|
704
|
+
# # event.event_type => :error
|
|
705
|
+
# # event.error_code => String
|
|
706
|
+
# # event.error_message => String
|
|
707
|
+
# end
|
|
708
|
+
# end
|
|
709
|
+
#
|
|
710
|
+
# # You can also iterate through events after the response complete.
|
|
711
|
+
# # Events are available at
|
|
712
|
+
# resp.stream # => Enumerator
|
|
713
|
+
# # For parameter input example, please refer to following request syntax.
|
|
714
|
+
#
|
|
715
|
+
# @example Request syntax with placeholder values
|
|
716
|
+
#
|
|
717
|
+
# resp = client.agentic_retrieve_stream({
|
|
718
|
+
# agentic_retrieve_configuration: { # required
|
|
719
|
+
# foundation_model_configuration: {
|
|
720
|
+
# bedrock_foundation_model_configuration: {
|
|
721
|
+
# model_configuration: { # required
|
|
722
|
+
# model_arn: "BedrockModelArn", # required
|
|
723
|
+
# },
|
|
724
|
+
# },
|
|
725
|
+
# type: "BEDROCK_FOUNDATION_MODEL", # required, accepts BEDROCK_FOUNDATION_MODEL
|
|
726
|
+
# },
|
|
727
|
+
# foundation_model_type: "CUSTOM", # accepts CUSTOM, MANAGED
|
|
728
|
+
# max_agent_iteration: 1,
|
|
729
|
+
# reranking_configuration: {
|
|
730
|
+
# bedrock_reranking_configuration: {
|
|
731
|
+
# model_configuration: { # required
|
|
732
|
+
# model_arn: "BedrockModelArn", # required
|
|
733
|
+
# },
|
|
734
|
+
# },
|
|
735
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
|
736
|
+
# },
|
|
737
|
+
# reranking_model_type: "CUSTOM", # accepts CUSTOM, MANAGED, NONE
|
|
738
|
+
# },
|
|
739
|
+
# generate_response: false,
|
|
740
|
+
# messages: [ # required
|
|
741
|
+
# {
|
|
742
|
+
# content: { # required
|
|
743
|
+
# text: "String",
|
|
744
|
+
# },
|
|
745
|
+
# role: "user", # required, accepts user, assistant
|
|
746
|
+
# },
|
|
747
|
+
# ],
|
|
748
|
+
# next_token: "NextToken",
|
|
749
|
+
# policy_configuration: {
|
|
750
|
+
# bedrock_guardrail_configuration: {
|
|
751
|
+
# guardrail_id: "AgenticRetrieveBedrockGuardrailConfigurationGuardrailIdString", # required
|
|
752
|
+
# guardrail_version: "AgenticRetrieveBedrockGuardrailConfigurationGuardrailVersionString", # required
|
|
753
|
+
# },
|
|
754
|
+
# },
|
|
755
|
+
# retrievers: [ # required
|
|
756
|
+
# {
|
|
757
|
+
# configuration: { # required
|
|
758
|
+
# knowledge_base: {
|
|
759
|
+
# knowledge_base_id: "KnowledgeBaseId", # required
|
|
760
|
+
# retrieval_overrides: {
|
|
761
|
+
# filter: {
|
|
762
|
+
# and_all: [
|
|
763
|
+
# {
|
|
764
|
+
# # recursive RetrievalFilter
|
|
765
|
+
# },
|
|
766
|
+
# ],
|
|
767
|
+
# equals: {
|
|
768
|
+
# key: "FilterKey", # required
|
|
769
|
+
# value: { # required
|
|
770
|
+
# },
|
|
771
|
+
# },
|
|
772
|
+
# greater_than: {
|
|
773
|
+
# key: "FilterKey", # required
|
|
774
|
+
# value: { # required
|
|
775
|
+
# },
|
|
776
|
+
# },
|
|
777
|
+
# greater_than_or_equals: {
|
|
778
|
+
# key: "FilterKey", # required
|
|
779
|
+
# value: { # required
|
|
780
|
+
# },
|
|
781
|
+
# },
|
|
782
|
+
# in: {
|
|
783
|
+
# key: "FilterKey", # required
|
|
784
|
+
# value: { # required
|
|
785
|
+
# },
|
|
786
|
+
# },
|
|
787
|
+
# less_than: {
|
|
788
|
+
# key: "FilterKey", # required
|
|
789
|
+
# value: { # required
|
|
790
|
+
# },
|
|
791
|
+
# },
|
|
792
|
+
# less_than_or_equals: {
|
|
793
|
+
# key: "FilterKey", # required
|
|
794
|
+
# value: { # required
|
|
795
|
+
# },
|
|
796
|
+
# },
|
|
797
|
+
# list_contains: {
|
|
798
|
+
# key: "FilterKey", # required
|
|
799
|
+
# value: { # required
|
|
800
|
+
# },
|
|
801
|
+
# },
|
|
802
|
+
# not_equals: {
|
|
803
|
+
# key: "FilterKey", # required
|
|
804
|
+
# value: { # required
|
|
805
|
+
# },
|
|
806
|
+
# },
|
|
807
|
+
# not_in: {
|
|
808
|
+
# key: "FilterKey", # required
|
|
809
|
+
# value: { # required
|
|
810
|
+
# },
|
|
811
|
+
# },
|
|
812
|
+
# or_all: [
|
|
813
|
+
# {
|
|
814
|
+
# # recursive RetrievalFilter
|
|
815
|
+
# },
|
|
816
|
+
# ],
|
|
817
|
+
# starts_with: {
|
|
818
|
+
# key: "FilterKey", # required
|
|
819
|
+
# value: { # required
|
|
820
|
+
# },
|
|
821
|
+
# },
|
|
822
|
+
# string_contains: {
|
|
823
|
+
# key: "FilterKey", # required
|
|
824
|
+
# value: { # required
|
|
825
|
+
# },
|
|
826
|
+
# },
|
|
827
|
+
# },
|
|
828
|
+
# max_number_of_results: 1,
|
|
829
|
+
# },
|
|
830
|
+
# },
|
|
831
|
+
# },
|
|
832
|
+
# description: "String",
|
|
833
|
+
# },
|
|
834
|
+
# ],
|
|
835
|
+
# user_context: {
|
|
836
|
+
# user_id: "String", # required
|
|
837
|
+
# },
|
|
838
|
+
# })
|
|
839
|
+
#
|
|
840
|
+
# @example Response structure
|
|
841
|
+
#
|
|
842
|
+
# # All events are available at resp.stream:
|
|
843
|
+
# resp.stream #=> Enumerator
|
|
844
|
+
# resp.stream.event_types #=> [:access_denied_exception, :bad_gateway_exception, :conflict_exception, :dependency_failed_exception, :internal_server_exception, :resource_not_found_exception, :response_event, :result, :service_quota_exceeded_exception, :throttling_exception, :trace_event, :validation_exception]
|
|
845
|
+
#
|
|
846
|
+
# # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
|
|
847
|
+
# event.message #=> String
|
|
848
|
+
#
|
|
849
|
+
# # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
|
|
850
|
+
# event.message #=> String
|
|
851
|
+
# event.resource_name #=> String
|
|
852
|
+
#
|
|
853
|
+
# # For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
|
|
854
|
+
# event.message #=> String
|
|
855
|
+
#
|
|
856
|
+
# # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
|
|
857
|
+
# event.message #=> String
|
|
858
|
+
# event.resource_name #=> String
|
|
859
|
+
#
|
|
860
|
+
# # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
|
|
861
|
+
# event.message #=> String
|
|
862
|
+
# event.reason #=> String
|
|
863
|
+
#
|
|
864
|
+
# # For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
|
|
865
|
+
# event.message #=> String
|
|
866
|
+
#
|
|
867
|
+
# # For :response_event event available at #on_response_event_event callback and response eventstream enumerator:
|
|
868
|
+
# event.text #=> String
|
|
869
|
+
#
|
|
870
|
+
# # For :result event available at #on_result_event callback and response eventstream enumerator:
|
|
871
|
+
# event.generated_response.answer #=> String
|
|
872
|
+
# event.generated_response.citations #=> Array
|
|
873
|
+
# event.generated_response.citations[0].end_index #=> Integer
|
|
874
|
+
# event.generated_response.citations[0].references #=> Array
|
|
875
|
+
# event.generated_response.citations[0].references[0].result_index #=> Integer
|
|
876
|
+
# event.generated_response.citations[0].start_index #=> Integer
|
|
877
|
+
# event.next_token #=> String
|
|
878
|
+
# event.results #=> Array
|
|
879
|
+
# event.results[0].content.byte_content #=> String
|
|
880
|
+
# event.results[0].content.mime_type #=> String
|
|
881
|
+
# event.results[0].content.text #=> String
|
|
882
|
+
# event.results[0].metadata #=> Hash
|
|
883
|
+
# event.results[0].source_retriever.identifier #=> String
|
|
884
|
+
#
|
|
885
|
+
# # For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
|
|
886
|
+
# event.message #=> String
|
|
887
|
+
#
|
|
888
|
+
# # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
|
|
889
|
+
# event.message #=> String
|
|
890
|
+
#
|
|
891
|
+
# # For :trace_event event available at #on_trace_event_event callback and response eventstream enumerator:
|
|
892
|
+
# event.attributes.actions #=> Array
|
|
893
|
+
# event.attributes.actions[0].full_document_expansion.document_id #=> String
|
|
894
|
+
# event.attributes.actions[0].full_document_expansion.source_retriever.identifier #=> String
|
|
895
|
+
# event.attributes.actions[0].retrieve.input_query.text #=> String
|
|
896
|
+
# event.attributes.actions[0].retrieve.source_retrievers #=> Array
|
|
897
|
+
# event.attributes.actions[0].retrieve.source_retrievers[0].identifier #=> String
|
|
898
|
+
# event.attributes.failures #=> Array
|
|
899
|
+
# event.attributes.failures[0].message #=> String
|
|
900
|
+
# event.attributes.message #=> String
|
|
901
|
+
# event.attributes.retrieval_metadata #=> Array
|
|
902
|
+
# event.attributes.retrieval_metadata[0].identifier #=> String
|
|
903
|
+
# event.attributes.retrieval_metadata[0].retrieval_type #=> String, one of "BedrockKnowledgeBase"
|
|
904
|
+
# event.attributes.retrieval_response #=> Array
|
|
905
|
+
# event.attributes.retrieval_response[0].content.byte_content #=> String
|
|
906
|
+
# event.attributes.retrieval_response[0].content.mime_type #=> String
|
|
907
|
+
# event.attributes.retrieval_response[0].content.text #=> String
|
|
908
|
+
# event.attributes.retrieval_response[0].metadata #=> Hash
|
|
909
|
+
# event.attributes.retrieval_response[0].source_retriever.identifier #=> String
|
|
910
|
+
# event.attributes.status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
|
|
911
|
+
# event.attributes.step #=> String, one of "Planning", "Retrieval", "SpeculativeRetrieval", "FullDocumentExpansion"
|
|
912
|
+
# event.attributes.warnings #=> Array
|
|
913
|
+
# event.attributes.warnings[0].guardrail.action #=> String, one of "INTERVENED", "NONE"
|
|
914
|
+
# event.attributes.warnings[0].guardrail.id #=> String
|
|
915
|
+
# event.attributes.warnings[0].guardrail.message #=> String
|
|
916
|
+
# event.attributes.warnings[0].guardrail.version #=> String
|
|
917
|
+
# event.attributes.warnings[0].message.message #=> String
|
|
918
|
+
# event.id #=> String
|
|
919
|
+
# event.timestamp #=> Integer
|
|
920
|
+
#
|
|
921
|
+
# # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
|
|
922
|
+
# event.message #=> String
|
|
923
|
+
#
|
|
924
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveStream AWS API Documentation
|
|
925
|
+
#
|
|
926
|
+
# @overload agentic_retrieve_stream(params = {})
|
|
927
|
+
# @param [Hash] params ({})
|
|
928
|
+
def agentic_retrieve_stream(params = {}, options = {}, &block)
|
|
929
|
+
params = params.dup
|
|
930
|
+
event_stream_handler = case handler = params.delete(:event_stream_handler)
|
|
931
|
+
when EventStreams::AgenticRetrieveStreamResponseOutput then handler
|
|
932
|
+
when Proc then EventStreams::AgenticRetrieveStreamResponseOutput.new.tap(&handler)
|
|
933
|
+
when nil then EventStreams::AgenticRetrieveStreamResponseOutput.new
|
|
934
|
+
else
|
|
935
|
+
msg = "expected :event_stream_handler to be a block or "\
|
|
936
|
+
"instance of Aws::BedrockAgentRuntime::EventStreams::AgenticRetrieveStreamResponseOutput"\
|
|
937
|
+
", got `#{handler.inspect}` instead"
|
|
938
|
+
raise ArgumentError, msg
|
|
939
|
+
end
|
|
940
|
+
|
|
941
|
+
yield(event_stream_handler) if block_given?
|
|
942
|
+
|
|
943
|
+
req = build_request(:agentic_retrieve_stream, params)
|
|
944
|
+
|
|
945
|
+
req.context[:event_stream_handler] = event_stream_handler
|
|
946
|
+
req.handlers.add(Aws::Binary::DecodeHandler, priority: 95)
|
|
947
|
+
|
|
948
|
+
req.send_request(options, &block)
|
|
949
|
+
end
|
|
950
|
+
|
|
488
951
|
# Creates a new invocation within a session. An invocation groups the
|
|
489
952
|
# related invocation steps that store the content from a conversation.
|
|
490
953
|
# For more information about sessions, see [Store and retrieve
|
|
@@ -864,6 +1327,62 @@ module Aws::BedrockAgentRuntime
|
|
|
864
1327
|
req.send_request(options)
|
|
865
1328
|
end
|
|
866
1329
|
|
|
1330
|
+
# Retrieves the content of an ingested document from a knowledge base.
|
|
1331
|
+
# Returns a pre-signed URL for secure document access.
|
|
1332
|
+
#
|
|
1333
|
+
# @option params [required, String] :data_source_id
|
|
1334
|
+
# The unique identifier of the data source that contains the document.
|
|
1335
|
+
#
|
|
1336
|
+
# @option params [required, String] :document_id
|
|
1337
|
+
# The unique identifier of the document to retrieve content for.
|
|
1338
|
+
#
|
|
1339
|
+
# @option params [required, String] :knowledge_base_id
|
|
1340
|
+
# The unique identifier of the knowledge base that contains the
|
|
1341
|
+
# document.
|
|
1342
|
+
#
|
|
1343
|
+
# @option params [String] :output_format
|
|
1344
|
+
# The output format for the document content. `RAW` returns the original
|
|
1345
|
+
# file. `EXTRACTED` returns parsed text as JSON. Defaults to `RAW`.
|
|
1346
|
+
#
|
|
1347
|
+
# @option params [Types::UserContext] :user_context
|
|
1348
|
+
# Contains information about the user making the request. Use this to
|
|
1349
|
+
# pass user identity information for access control filtering, so that
|
|
1350
|
+
# retrieval results only include documents the user is authorized to
|
|
1351
|
+
# access.
|
|
1352
|
+
#
|
|
1353
|
+
# @return [Types::GetDocumentContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1354
|
+
#
|
|
1355
|
+
# * {Types::GetDocumentContentResponse#document_content_length #document_content_length} => Integer
|
|
1356
|
+
# * {Types::GetDocumentContentResponse#mime_type #mime_type} => String
|
|
1357
|
+
# * {Types::GetDocumentContentResponse#presigned_url #presigned_url} => String
|
|
1358
|
+
#
|
|
1359
|
+
# @example Request syntax with placeholder values
|
|
1360
|
+
#
|
|
1361
|
+
# resp = client.get_document_content({
|
|
1362
|
+
# data_source_id: "DataSourceId", # required
|
|
1363
|
+
# document_id: "DocumentId", # required
|
|
1364
|
+
# knowledge_base_id: "KnowledgeBaseIdentifier", # required
|
|
1365
|
+
# output_format: "RAW", # accepts RAW, EXTRACTED
|
|
1366
|
+
# user_context: {
|
|
1367
|
+
# user_id: "String", # required
|
|
1368
|
+
# },
|
|
1369
|
+
# })
|
|
1370
|
+
#
|
|
1371
|
+
# @example Response structure
|
|
1372
|
+
#
|
|
1373
|
+
# resp.document_content_length #=> Integer
|
|
1374
|
+
# resp.mime_type #=> String
|
|
1375
|
+
# resp.presigned_url #=> String
|
|
1376
|
+
#
|
|
1377
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetDocumentContent AWS API Documentation
|
|
1378
|
+
#
|
|
1379
|
+
# @overload get_document_content(params = {})
|
|
1380
|
+
# @param [Hash] params ({})
|
|
1381
|
+
def get_document_content(params = {}, options = {})
|
|
1382
|
+
req = build_request(:get_document_content, params)
|
|
1383
|
+
req.send_request(options)
|
|
1384
|
+
end
|
|
1385
|
+
|
|
867
1386
|
# Retrieves the flow definition snapshot used for a flow execution. The
|
|
868
1387
|
# snapshot represents the flow metadata and definition as it existed at
|
|
869
1388
|
# the time the execution was started. Note that even if the flow is
|
|
@@ -1440,17 +1959,116 @@ module Aws::BedrockAgentRuntime
|
|
|
1440
1959
|
# s3_location: {
|
|
1441
1960
|
# uri: "S3Uri", # required
|
|
1442
1961
|
# },
|
|
1443
|
-
# source_type: "S3", # required, accepts S3, BYTE_CONTENT
|
|
1444
|
-
# },
|
|
1445
|
-
# use_case: "CODE_INTERPRETER", # required, accepts CODE_INTERPRETER, CHAT
|
|
1446
|
-
# },
|
|
1447
|
-
# ],
|
|
1448
|
-
# invocation_id: "String",
|
|
1449
|
-
# knowledge_base_configurations: [
|
|
1450
|
-
# {
|
|
1451
|
-
# knowledge_base_id: "KnowledgeBaseId", # required
|
|
1452
|
-
# retrieval_configuration: { # required
|
|
1453
|
-
#
|
|
1962
|
+
# source_type: "S3", # required, accepts S3, BYTE_CONTENT
|
|
1963
|
+
# },
|
|
1964
|
+
# use_case: "CODE_INTERPRETER", # required, accepts CODE_INTERPRETER, CHAT
|
|
1965
|
+
# },
|
|
1966
|
+
# ],
|
|
1967
|
+
# invocation_id: "String",
|
|
1968
|
+
# knowledge_base_configurations: [
|
|
1969
|
+
# {
|
|
1970
|
+
# knowledge_base_id: "KnowledgeBaseId", # required
|
|
1971
|
+
# retrieval_configuration: { # required
|
|
1972
|
+
# managed_search_configuration: {
|
|
1973
|
+
# filter: {
|
|
1974
|
+
# and_all: [
|
|
1975
|
+
# {
|
|
1976
|
+
# # recursive RetrievalFilter
|
|
1977
|
+
# },
|
|
1978
|
+
# ],
|
|
1979
|
+
# equals: {
|
|
1980
|
+
# key: "FilterKey", # required
|
|
1981
|
+
# value: { # required
|
|
1982
|
+
# },
|
|
1983
|
+
# },
|
|
1984
|
+
# greater_than: {
|
|
1985
|
+
# key: "FilterKey", # required
|
|
1986
|
+
# value: { # required
|
|
1987
|
+
# },
|
|
1988
|
+
# },
|
|
1989
|
+
# greater_than_or_equals: {
|
|
1990
|
+
# key: "FilterKey", # required
|
|
1991
|
+
# value: { # required
|
|
1992
|
+
# },
|
|
1993
|
+
# },
|
|
1994
|
+
# in: {
|
|
1995
|
+
# key: "FilterKey", # required
|
|
1996
|
+
# value: { # required
|
|
1997
|
+
# },
|
|
1998
|
+
# },
|
|
1999
|
+
# less_than: {
|
|
2000
|
+
# key: "FilterKey", # required
|
|
2001
|
+
# value: { # required
|
|
2002
|
+
# },
|
|
2003
|
+
# },
|
|
2004
|
+
# less_than_or_equals: {
|
|
2005
|
+
# key: "FilterKey", # required
|
|
2006
|
+
# value: { # required
|
|
2007
|
+
# },
|
|
2008
|
+
# },
|
|
2009
|
+
# list_contains: {
|
|
2010
|
+
# key: "FilterKey", # required
|
|
2011
|
+
# value: { # required
|
|
2012
|
+
# },
|
|
2013
|
+
# },
|
|
2014
|
+
# not_equals: {
|
|
2015
|
+
# key: "FilterKey", # required
|
|
2016
|
+
# value: { # required
|
|
2017
|
+
# },
|
|
2018
|
+
# },
|
|
2019
|
+
# not_in: {
|
|
2020
|
+
# key: "FilterKey", # required
|
|
2021
|
+
# value: { # required
|
|
2022
|
+
# },
|
|
2023
|
+
# },
|
|
2024
|
+
# or_all: [
|
|
2025
|
+
# {
|
|
2026
|
+
# # recursive RetrievalFilter
|
|
2027
|
+
# },
|
|
2028
|
+
# ],
|
|
2029
|
+
# starts_with: {
|
|
2030
|
+
# key: "FilterKey", # required
|
|
2031
|
+
# value: { # required
|
|
2032
|
+
# },
|
|
2033
|
+
# },
|
|
2034
|
+
# string_contains: {
|
|
2035
|
+
# key: "FilterKey", # required
|
|
2036
|
+
# value: { # required
|
|
2037
|
+
# },
|
|
2038
|
+
# },
|
|
2039
|
+
# },
|
|
2040
|
+
# number_of_results: 1,
|
|
2041
|
+
# reranking_configuration: {
|
|
2042
|
+
# bedrock_reranking_configuration: {
|
|
2043
|
+
# metadata_configuration: {
|
|
2044
|
+
# selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
|
|
2045
|
+
# selective_mode_configuration: {
|
|
2046
|
+
# fields_to_exclude: [
|
|
2047
|
+
# {
|
|
2048
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
2049
|
+
# },
|
|
2050
|
+
# ],
|
|
2051
|
+
# fields_to_include: [
|
|
2052
|
+
# {
|
|
2053
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
2054
|
+
# },
|
|
2055
|
+
# ],
|
|
2056
|
+
# },
|
|
2057
|
+
# },
|
|
2058
|
+
# model_configuration: { # required
|
|
2059
|
+
# additional_model_request_fields: {
|
|
2060
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
2061
|
+
# },
|
|
2062
|
+
# },
|
|
2063
|
+
# model_arn: "BedrockRerankingModelArn", # required
|
|
2064
|
+
# },
|
|
2065
|
+
# number_of_reranked_results: 1,
|
|
2066
|
+
# },
|
|
2067
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
|
2068
|
+
# },
|
|
2069
|
+
# reranking_model_type: "CUSTOM", # accepts CUSTOM, MANAGED, NONE
|
|
2070
|
+
# },
|
|
2071
|
+
# vector_search_configuration: {
|
|
1454
2072
|
# filter: {
|
|
1455
2073
|
# and_all: [
|
|
1456
2074
|
# {
|
|
@@ -1654,12 +2272,14 @@ module Aws::BedrockAgentRuntime
|
|
|
1654
2272
|
# event.attribution.citations[0].retrieved_references[0].content.video.summary #=> String
|
|
1655
2273
|
# event.attribution.citations[0].retrieved_references[0].location.confluence_location.url #=> String
|
|
1656
2274
|
# event.attribution.citations[0].retrieved_references[0].location.custom_document_location.id #=> String
|
|
2275
|
+
# event.attribution.citations[0].retrieved_references[0].location.google_drive_location.url #=> String
|
|
1657
2276
|
# event.attribution.citations[0].retrieved_references[0].location.kendra_document_location.uri #=> String
|
|
2277
|
+
# event.attribution.citations[0].retrieved_references[0].location.one_drive_location.url #=> String
|
|
1658
2278
|
# event.attribution.citations[0].retrieved_references[0].location.s3_location.uri #=> String
|
|
1659
2279
|
# event.attribution.citations[0].retrieved_references[0].location.salesforce_location.url #=> String
|
|
1660
2280
|
# event.attribution.citations[0].retrieved_references[0].location.share_point_location.url #=> String
|
|
1661
2281
|
# event.attribution.citations[0].retrieved_references[0].location.sql_location.query #=> String
|
|
1662
|
-
# event.attribution.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
|
2282
|
+
# event.attribution.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL", "ONEDRIVE", "GOOGLEDRIVE"
|
|
1663
2283
|
# event.attribution.citations[0].retrieved_references[0].location.web_location.url #=> String
|
|
1664
2284
|
# event.attribution.citations[0].retrieved_references[0].metadata #=> Hash
|
|
1665
2285
|
# event.bytes #=> String
|
|
@@ -1962,12 +2582,14 @@ module Aws::BedrockAgentRuntime
|
|
|
1962
2582
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.video.summary #=> String
|
|
1963
2583
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
|
1964
2584
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
|
2585
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.google_drive_location.url #=> String
|
|
1965
2586
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
|
|
2587
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.one_drive_location.url #=> String
|
|
1966
2588
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
|
1967
2589
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
|
1968
2590
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
|
1969
2591
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
|
|
1970
|
-
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
|
2592
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL", "ONEDRIVE", "GOOGLEDRIVE"
|
|
1971
2593
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
|
1972
2594
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
|
1973
2595
|
# event.trace.orchestration_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
|
@@ -2187,12 +2809,14 @@ module Aws::BedrockAgentRuntime
|
|
|
2187
2809
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.video.summary #=> String
|
|
2188
2810
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
|
2189
2811
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
|
2812
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.google_drive_location.url #=> String
|
|
2190
2813
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
|
|
2814
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.one_drive_location.url #=> String
|
|
2191
2815
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
|
2192
2816
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
|
2193
2817
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
|
2194
2818
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
|
|
2195
|
-
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
|
2819
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL", "ONEDRIVE", "GOOGLEDRIVE"
|
|
2196
2820
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
|
2197
2821
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
|
2198
2822
|
# event.trace.routing_classifier_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
|
@@ -2788,12 +3412,14 @@ module Aws::BedrockAgentRuntime
|
|
|
2788
3412
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.video.summary #=> String
|
|
2789
3413
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
|
2790
3414
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
|
3415
|
+
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.google_drive_location.url #=> String
|
|
2791
3416
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
|
|
3417
|
+
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.one_drive_location.url #=> String
|
|
2792
3418
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
|
2793
3419
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
|
2794
3420
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
|
2795
3421
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
|
|
2796
|
-
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
|
3422
|
+
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL", "ONEDRIVE", "GOOGLEDRIVE"
|
|
2797
3423
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
|
2798
3424
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
|
2799
3425
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.orchestration_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
|
@@ -3013,12 +3639,14 @@ module Aws::BedrockAgentRuntime
|
|
|
3013
3639
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.video.summary #=> String
|
|
3014
3640
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
|
3015
3641
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
|
3642
|
+
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.google_drive_location.url #=> String
|
|
3016
3643
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
|
|
3644
|
+
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.one_drive_location.url #=> String
|
|
3017
3645
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
|
3018
3646
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
|
3019
3647
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
|
3020
3648
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
|
|
3021
|
-
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
|
3649
|
+
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL", "ONEDRIVE", "GOOGLEDRIVE"
|
|
3022
3650
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
|
3023
3651
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
|
3024
3652
|
# event.trace.node_dependency_trace.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
|
@@ -3562,7 +4190,106 @@ module Aws::BedrockAgentRuntime
|
|
|
3562
4190
|
# description: "ResourceDescription", # required
|
|
3563
4191
|
# knowledge_base_id: "KnowledgeBaseId", # required
|
|
3564
4192
|
# retrieval_configuration: {
|
|
3565
|
-
#
|
|
4193
|
+
# managed_search_configuration: {
|
|
4194
|
+
# filter: {
|
|
4195
|
+
# and_all: [
|
|
4196
|
+
# {
|
|
4197
|
+
# # recursive RetrievalFilter
|
|
4198
|
+
# },
|
|
4199
|
+
# ],
|
|
4200
|
+
# equals: {
|
|
4201
|
+
# key: "FilterKey", # required
|
|
4202
|
+
# value: { # required
|
|
4203
|
+
# },
|
|
4204
|
+
# },
|
|
4205
|
+
# greater_than: {
|
|
4206
|
+
# key: "FilterKey", # required
|
|
4207
|
+
# value: { # required
|
|
4208
|
+
# },
|
|
4209
|
+
# },
|
|
4210
|
+
# greater_than_or_equals: {
|
|
4211
|
+
# key: "FilterKey", # required
|
|
4212
|
+
# value: { # required
|
|
4213
|
+
# },
|
|
4214
|
+
# },
|
|
4215
|
+
# in: {
|
|
4216
|
+
# key: "FilterKey", # required
|
|
4217
|
+
# value: { # required
|
|
4218
|
+
# },
|
|
4219
|
+
# },
|
|
4220
|
+
# less_than: {
|
|
4221
|
+
# key: "FilterKey", # required
|
|
4222
|
+
# value: { # required
|
|
4223
|
+
# },
|
|
4224
|
+
# },
|
|
4225
|
+
# less_than_or_equals: {
|
|
4226
|
+
# key: "FilterKey", # required
|
|
4227
|
+
# value: { # required
|
|
4228
|
+
# },
|
|
4229
|
+
# },
|
|
4230
|
+
# list_contains: {
|
|
4231
|
+
# key: "FilterKey", # required
|
|
4232
|
+
# value: { # required
|
|
4233
|
+
# },
|
|
4234
|
+
# },
|
|
4235
|
+
# not_equals: {
|
|
4236
|
+
# key: "FilterKey", # required
|
|
4237
|
+
# value: { # required
|
|
4238
|
+
# },
|
|
4239
|
+
# },
|
|
4240
|
+
# not_in: {
|
|
4241
|
+
# key: "FilterKey", # required
|
|
4242
|
+
# value: { # required
|
|
4243
|
+
# },
|
|
4244
|
+
# },
|
|
4245
|
+
# or_all: [
|
|
4246
|
+
# {
|
|
4247
|
+
# # recursive RetrievalFilter
|
|
4248
|
+
# },
|
|
4249
|
+
# ],
|
|
4250
|
+
# starts_with: {
|
|
4251
|
+
# key: "FilterKey", # required
|
|
4252
|
+
# value: { # required
|
|
4253
|
+
# },
|
|
4254
|
+
# },
|
|
4255
|
+
# string_contains: {
|
|
4256
|
+
# key: "FilterKey", # required
|
|
4257
|
+
# value: { # required
|
|
4258
|
+
# },
|
|
4259
|
+
# },
|
|
4260
|
+
# },
|
|
4261
|
+
# number_of_results: 1,
|
|
4262
|
+
# reranking_configuration: {
|
|
4263
|
+
# bedrock_reranking_configuration: {
|
|
4264
|
+
# metadata_configuration: {
|
|
4265
|
+
# selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
|
|
4266
|
+
# selective_mode_configuration: {
|
|
4267
|
+
# fields_to_exclude: [
|
|
4268
|
+
# {
|
|
4269
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
4270
|
+
# },
|
|
4271
|
+
# ],
|
|
4272
|
+
# fields_to_include: [
|
|
4273
|
+
# {
|
|
4274
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
4275
|
+
# },
|
|
4276
|
+
# ],
|
|
4277
|
+
# },
|
|
4278
|
+
# },
|
|
4279
|
+
# model_configuration: { # required
|
|
4280
|
+
# additional_model_request_fields: {
|
|
4281
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
4282
|
+
# },
|
|
4283
|
+
# },
|
|
4284
|
+
# model_arn: "BedrockRerankingModelArn", # required
|
|
4285
|
+
# },
|
|
4286
|
+
# number_of_reranked_results: 1,
|
|
4287
|
+
# },
|
|
4288
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
|
4289
|
+
# },
|
|
4290
|
+
# reranking_model_type: "CUSTOM", # accepts CUSTOM, MANAGED, NONE
|
|
4291
|
+
# },
|
|
4292
|
+
# vector_search_configuration: {
|
|
3566
4293
|
# filter: {
|
|
3567
4294
|
# and_all: [
|
|
3568
4295
|
# {
|
|
@@ -3802,7 +4529,106 @@ module Aws::BedrockAgentRuntime
|
|
|
3802
4529
|
# description: "ResourceDescription", # required
|
|
3803
4530
|
# knowledge_base_id: "KnowledgeBaseId", # required
|
|
3804
4531
|
# retrieval_configuration: {
|
|
3805
|
-
#
|
|
4532
|
+
# managed_search_configuration: {
|
|
4533
|
+
# filter: {
|
|
4534
|
+
# and_all: [
|
|
4535
|
+
# {
|
|
4536
|
+
# # recursive RetrievalFilter
|
|
4537
|
+
# },
|
|
4538
|
+
# ],
|
|
4539
|
+
# equals: {
|
|
4540
|
+
# key: "FilterKey", # required
|
|
4541
|
+
# value: { # required
|
|
4542
|
+
# },
|
|
4543
|
+
# },
|
|
4544
|
+
# greater_than: {
|
|
4545
|
+
# key: "FilterKey", # required
|
|
4546
|
+
# value: { # required
|
|
4547
|
+
# },
|
|
4548
|
+
# },
|
|
4549
|
+
# greater_than_or_equals: {
|
|
4550
|
+
# key: "FilterKey", # required
|
|
4551
|
+
# value: { # required
|
|
4552
|
+
# },
|
|
4553
|
+
# },
|
|
4554
|
+
# in: {
|
|
4555
|
+
# key: "FilterKey", # required
|
|
4556
|
+
# value: { # required
|
|
4557
|
+
# },
|
|
4558
|
+
# },
|
|
4559
|
+
# less_than: {
|
|
4560
|
+
# key: "FilterKey", # required
|
|
4561
|
+
# value: { # required
|
|
4562
|
+
# },
|
|
4563
|
+
# },
|
|
4564
|
+
# less_than_or_equals: {
|
|
4565
|
+
# key: "FilterKey", # required
|
|
4566
|
+
# value: { # required
|
|
4567
|
+
# },
|
|
4568
|
+
# },
|
|
4569
|
+
# list_contains: {
|
|
4570
|
+
# key: "FilterKey", # required
|
|
4571
|
+
# value: { # required
|
|
4572
|
+
# },
|
|
4573
|
+
# },
|
|
4574
|
+
# not_equals: {
|
|
4575
|
+
# key: "FilterKey", # required
|
|
4576
|
+
# value: { # required
|
|
4577
|
+
# },
|
|
4578
|
+
# },
|
|
4579
|
+
# not_in: {
|
|
4580
|
+
# key: "FilterKey", # required
|
|
4581
|
+
# value: { # required
|
|
4582
|
+
# },
|
|
4583
|
+
# },
|
|
4584
|
+
# or_all: [
|
|
4585
|
+
# {
|
|
4586
|
+
# # recursive RetrievalFilter
|
|
4587
|
+
# },
|
|
4588
|
+
# ],
|
|
4589
|
+
# starts_with: {
|
|
4590
|
+
# key: "FilterKey", # required
|
|
4591
|
+
# value: { # required
|
|
4592
|
+
# },
|
|
4593
|
+
# },
|
|
4594
|
+
# string_contains: {
|
|
4595
|
+
# key: "FilterKey", # required
|
|
4596
|
+
# value: { # required
|
|
4597
|
+
# },
|
|
4598
|
+
# },
|
|
4599
|
+
# },
|
|
4600
|
+
# number_of_results: 1,
|
|
4601
|
+
# reranking_configuration: {
|
|
4602
|
+
# bedrock_reranking_configuration: {
|
|
4603
|
+
# metadata_configuration: {
|
|
4604
|
+
# selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
|
|
4605
|
+
# selective_mode_configuration: {
|
|
4606
|
+
# fields_to_exclude: [
|
|
4607
|
+
# {
|
|
4608
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
4609
|
+
# },
|
|
4610
|
+
# ],
|
|
4611
|
+
# fields_to_include: [
|
|
4612
|
+
# {
|
|
4613
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
4614
|
+
# },
|
|
4615
|
+
# ],
|
|
4616
|
+
# },
|
|
4617
|
+
# },
|
|
4618
|
+
# model_configuration: { # required
|
|
4619
|
+
# additional_model_request_fields: {
|
|
4620
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
4621
|
+
# },
|
|
4622
|
+
# },
|
|
4623
|
+
# model_arn: "BedrockRerankingModelArn", # required
|
|
4624
|
+
# },
|
|
4625
|
+
# number_of_reranked_results: 1,
|
|
4626
|
+
# },
|
|
4627
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
|
4628
|
+
# },
|
|
4629
|
+
# reranking_model_type: "CUSTOM", # accepts CUSTOM, MANAGED, NONE
|
|
4630
|
+
# },
|
|
4631
|
+
# vector_search_configuration: {
|
|
3806
4632
|
# filter: {
|
|
3807
4633
|
# and_all: [
|
|
3808
4634
|
# {
|
|
@@ -3980,12 +4806,14 @@ module Aws::BedrockAgentRuntime
|
|
|
3980
4806
|
# event.attribution.citations[0].retrieved_references[0].content.video.summary #=> String
|
|
3981
4807
|
# event.attribution.citations[0].retrieved_references[0].location.confluence_location.url #=> String
|
|
3982
4808
|
# event.attribution.citations[0].retrieved_references[0].location.custom_document_location.id #=> String
|
|
4809
|
+
# event.attribution.citations[0].retrieved_references[0].location.google_drive_location.url #=> String
|
|
3983
4810
|
# event.attribution.citations[0].retrieved_references[0].location.kendra_document_location.uri #=> String
|
|
4811
|
+
# event.attribution.citations[0].retrieved_references[0].location.one_drive_location.url #=> String
|
|
3984
4812
|
# event.attribution.citations[0].retrieved_references[0].location.s3_location.uri #=> String
|
|
3985
4813
|
# event.attribution.citations[0].retrieved_references[0].location.salesforce_location.url #=> String
|
|
3986
4814
|
# event.attribution.citations[0].retrieved_references[0].location.share_point_location.url #=> String
|
|
3987
4815
|
# event.attribution.citations[0].retrieved_references[0].location.sql_location.query #=> String
|
|
3988
|
-
# event.attribution.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
|
4816
|
+
# event.attribution.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL", "ONEDRIVE", "GOOGLEDRIVE"
|
|
3989
4817
|
# event.attribution.citations[0].retrieved_references[0].location.web_location.url #=> String
|
|
3990
4818
|
# event.attribution.citations[0].retrieved_references[0].metadata #=> Hash
|
|
3991
4819
|
# event.bytes #=> String
|
|
@@ -4282,12 +5110,14 @@ module Aws::BedrockAgentRuntime
|
|
|
4282
5110
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.video.summary #=> String
|
|
4283
5111
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
|
4284
5112
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
|
5113
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.google_drive_location.url #=> String
|
|
4285
5114
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
|
|
5115
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.one_drive_location.url #=> String
|
|
4286
5116
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
|
4287
5117
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
|
4288
5118
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
|
4289
5119
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
|
|
4290
|
-
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
|
5120
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL", "ONEDRIVE", "GOOGLEDRIVE"
|
|
4291
5121
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
|
4292
5122
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
|
4293
5123
|
# event.trace.orchestration_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
|
@@ -4507,12 +5337,14 @@ module Aws::BedrockAgentRuntime
|
|
|
4507
5337
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.video.summary #=> String
|
|
4508
5338
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
|
4509
5339
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
|
5340
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.google_drive_location.url #=> String
|
|
4510
5341
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
|
|
5342
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.one_drive_location.url #=> String
|
|
4511
5343
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
|
4512
5344
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
|
4513
5345
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
|
4514
5346
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
|
|
4515
|
-
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
|
5347
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL", "ONEDRIVE", "GOOGLEDRIVE"
|
|
4516
5348
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
|
4517
5349
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
|
4518
5350
|
# event.trace.routing_classifier_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
|
@@ -4869,12 +5701,14 @@ module Aws::BedrockAgentRuntime
|
|
|
4869
5701
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.video.summary #=> String
|
|
4870
5702
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
|
4871
5703
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
|
5704
|
+
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.google_drive_location.url #=> String
|
|
4872
5705
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
|
|
5706
|
+
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.one_drive_location.url #=> String
|
|
4873
5707
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
|
4874
5708
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
|
4875
5709
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
|
4876
5710
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
|
|
4877
|
-
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
|
5711
|
+
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL", "ONEDRIVE", "GOOGLEDRIVE"
|
|
4878
5712
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
|
4879
5713
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
|
4880
5714
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.orchestration_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
|
@@ -5094,12 +5928,14 @@ module Aws::BedrockAgentRuntime
|
|
|
5094
5928
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.video.summary #=> String
|
|
5095
5929
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
|
5096
5930
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
|
5931
|
+
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.google_drive_location.url #=> String
|
|
5097
5932
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
|
|
5933
|
+
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.one_drive_location.url #=> String
|
|
5098
5934
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
|
5099
5935
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
|
5100
5936
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
|
5101
5937
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
|
|
5102
|
-
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
|
5938
|
+
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL", "ONEDRIVE", "GOOGLEDRIVE"
|
|
5103
5939
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
|
5104
5940
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
|
5105
5941
|
# resp.flow_execution_events[0].node_dependency_event.trace_elements.agent_traces[0].trace.routing_classifier_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
|
@@ -5847,6 +6683,12 @@ module Aws::BedrockAgentRuntime
|
|
|
5847
6683
|
# @option params [required, Types::KnowledgeBaseQuery] :retrieval_query
|
|
5848
6684
|
# Contains the query to send the knowledge base.
|
|
5849
6685
|
#
|
|
6686
|
+
# @option params [Types::UserContext] :user_context
|
|
6687
|
+
# Contains information about the user making the request. Use this to
|
|
6688
|
+
# pass user identity information for access control filtering, so that
|
|
6689
|
+
# retrieval results only include documents the user is authorized to
|
|
6690
|
+
# access.
|
|
6691
|
+
#
|
|
5850
6692
|
# @return [Types::RetrieveResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
5851
6693
|
#
|
|
5852
6694
|
# * {Types::RetrieveResponse#guardrail_action #guardrail_action} => String
|
|
@@ -5862,10 +6704,109 @@ module Aws::BedrockAgentRuntime
|
|
|
5862
6704
|
# guardrail_id: "GuardrailConfigurationGuardrailIdString", # required
|
|
5863
6705
|
# guardrail_version: "GuardrailConfigurationGuardrailVersionString", # required
|
|
5864
6706
|
# },
|
|
5865
|
-
# knowledge_base_id: "
|
|
6707
|
+
# knowledge_base_id: "KnowledgeBaseIdentifier", # required
|
|
5866
6708
|
# next_token: "NextToken",
|
|
5867
6709
|
# retrieval_configuration: {
|
|
5868
|
-
#
|
|
6710
|
+
# managed_search_configuration: {
|
|
6711
|
+
# filter: {
|
|
6712
|
+
# and_all: [
|
|
6713
|
+
# {
|
|
6714
|
+
# # recursive RetrievalFilter
|
|
6715
|
+
# },
|
|
6716
|
+
# ],
|
|
6717
|
+
# equals: {
|
|
6718
|
+
# key: "FilterKey", # required
|
|
6719
|
+
# value: { # required
|
|
6720
|
+
# },
|
|
6721
|
+
# },
|
|
6722
|
+
# greater_than: {
|
|
6723
|
+
# key: "FilterKey", # required
|
|
6724
|
+
# value: { # required
|
|
6725
|
+
# },
|
|
6726
|
+
# },
|
|
6727
|
+
# greater_than_or_equals: {
|
|
6728
|
+
# key: "FilterKey", # required
|
|
6729
|
+
# value: { # required
|
|
6730
|
+
# },
|
|
6731
|
+
# },
|
|
6732
|
+
# in: {
|
|
6733
|
+
# key: "FilterKey", # required
|
|
6734
|
+
# value: { # required
|
|
6735
|
+
# },
|
|
6736
|
+
# },
|
|
6737
|
+
# less_than: {
|
|
6738
|
+
# key: "FilterKey", # required
|
|
6739
|
+
# value: { # required
|
|
6740
|
+
# },
|
|
6741
|
+
# },
|
|
6742
|
+
# less_than_or_equals: {
|
|
6743
|
+
# key: "FilterKey", # required
|
|
6744
|
+
# value: { # required
|
|
6745
|
+
# },
|
|
6746
|
+
# },
|
|
6747
|
+
# list_contains: {
|
|
6748
|
+
# key: "FilterKey", # required
|
|
6749
|
+
# value: { # required
|
|
6750
|
+
# },
|
|
6751
|
+
# },
|
|
6752
|
+
# not_equals: {
|
|
6753
|
+
# key: "FilterKey", # required
|
|
6754
|
+
# value: { # required
|
|
6755
|
+
# },
|
|
6756
|
+
# },
|
|
6757
|
+
# not_in: {
|
|
6758
|
+
# key: "FilterKey", # required
|
|
6759
|
+
# value: { # required
|
|
6760
|
+
# },
|
|
6761
|
+
# },
|
|
6762
|
+
# or_all: [
|
|
6763
|
+
# {
|
|
6764
|
+
# # recursive RetrievalFilter
|
|
6765
|
+
# },
|
|
6766
|
+
# ],
|
|
6767
|
+
# starts_with: {
|
|
6768
|
+
# key: "FilterKey", # required
|
|
6769
|
+
# value: { # required
|
|
6770
|
+
# },
|
|
6771
|
+
# },
|
|
6772
|
+
# string_contains: {
|
|
6773
|
+
# key: "FilterKey", # required
|
|
6774
|
+
# value: { # required
|
|
6775
|
+
# },
|
|
6776
|
+
# },
|
|
6777
|
+
# },
|
|
6778
|
+
# number_of_results: 1,
|
|
6779
|
+
# reranking_configuration: {
|
|
6780
|
+
# bedrock_reranking_configuration: {
|
|
6781
|
+
# metadata_configuration: {
|
|
6782
|
+
# selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
|
|
6783
|
+
# selective_mode_configuration: {
|
|
6784
|
+
# fields_to_exclude: [
|
|
6785
|
+
# {
|
|
6786
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
6787
|
+
# },
|
|
6788
|
+
# ],
|
|
6789
|
+
# fields_to_include: [
|
|
6790
|
+
# {
|
|
6791
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
6792
|
+
# },
|
|
6793
|
+
# ],
|
|
6794
|
+
# },
|
|
6795
|
+
# },
|
|
6796
|
+
# model_configuration: { # required
|
|
6797
|
+
# additional_model_request_fields: {
|
|
6798
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
6799
|
+
# },
|
|
6800
|
+
# },
|
|
6801
|
+
# model_arn: "BedrockRerankingModelArn", # required
|
|
6802
|
+
# },
|
|
6803
|
+
# number_of_reranked_results: 1,
|
|
6804
|
+
# },
|
|
6805
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
|
6806
|
+
# },
|
|
6807
|
+
# reranking_model_type: "CUSTOM", # accepts CUSTOM, MANAGED, NONE
|
|
6808
|
+
# },
|
|
6809
|
+
# vector_search_configuration: {
|
|
5869
6810
|
# filter: {
|
|
5870
6811
|
# and_all: [
|
|
5871
6812
|
# {
|
|
@@ -5983,6 +6924,9 @@ module Aws::BedrockAgentRuntime
|
|
|
5983
6924
|
# text: "KnowledgeBaseQueryTextString",
|
|
5984
6925
|
# type: "TEXT", # accepts TEXT, IMAGE
|
|
5985
6926
|
# },
|
|
6927
|
+
# user_context: {
|
|
6928
|
+
# user_id: "String", # required
|
|
6929
|
+
# },
|
|
5986
6930
|
# })
|
|
5987
6931
|
#
|
|
5988
6932
|
# @example Response structure
|
|
@@ -6001,14 +6945,17 @@ module Aws::BedrockAgentRuntime
|
|
|
6001
6945
|
# resp.retrieval_results[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW", "AUDIO", "VIDEO"
|
|
6002
6946
|
# resp.retrieval_results[0].content.video.s3_uri #=> String
|
|
6003
6947
|
# resp.retrieval_results[0].content.video.summary #=> String
|
|
6948
|
+
# resp.retrieval_results[0].document_id #=> String
|
|
6004
6949
|
# resp.retrieval_results[0].location.confluence_location.url #=> String
|
|
6005
6950
|
# resp.retrieval_results[0].location.custom_document_location.id #=> String
|
|
6951
|
+
# resp.retrieval_results[0].location.google_drive_location.url #=> String
|
|
6006
6952
|
# resp.retrieval_results[0].location.kendra_document_location.uri #=> String
|
|
6953
|
+
# resp.retrieval_results[0].location.one_drive_location.url #=> String
|
|
6007
6954
|
# resp.retrieval_results[0].location.s3_location.uri #=> String
|
|
6008
6955
|
# resp.retrieval_results[0].location.salesforce_location.url #=> String
|
|
6009
6956
|
# resp.retrieval_results[0].location.share_point_location.url #=> String
|
|
6010
6957
|
# resp.retrieval_results[0].location.sql_location.query #=> String
|
|
6011
|
-
# resp.retrieval_results[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
|
6958
|
+
# resp.retrieval_results[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL", "ONEDRIVE", "GOOGLEDRIVE"
|
|
6012
6959
|
# resp.retrieval_results[0].location.web_location.url #=> String
|
|
6013
6960
|
# resp.retrieval_results[0].metadata #=> Hash
|
|
6014
6961
|
# resp.retrieval_results[0].score #=> Float
|
|
@@ -6027,9 +6974,17 @@ module Aws::BedrockAgentRuntime
|
|
|
6027
6974
|
# [inference profile][1]. The response only cites sources that are
|
|
6028
6975
|
# relevant to the query.
|
|
6029
6976
|
#
|
|
6977
|
+
# <note markdown="1"> This API cannot be used with managed knowledge bases. Use
|
|
6978
|
+
# [AgenticRetrieveStream][2] or [Retrieve][3] with managed knowledge
|
|
6979
|
+
# bases.
|
|
6980
|
+
#
|
|
6981
|
+
# </note>
|
|
6982
|
+
#
|
|
6030
6983
|
#
|
|
6031
6984
|
#
|
|
6032
6985
|
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html
|
|
6986
|
+
# [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_AgenticRetrieveStream.html
|
|
6987
|
+
# [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html
|
|
6033
6988
|
#
|
|
6034
6989
|
# @option params [required, Types::RetrieveAndGenerateInput] :input
|
|
6035
6990
|
# Contains the query to be made to the knowledge base.
|
|
@@ -6053,6 +7008,12 @@ module Aws::BedrockAgentRuntime
|
|
|
6053
7008
|
# maintain context and knowledge from previous interactions. You can't
|
|
6054
7009
|
# explicitly set the `sessionId` yourself.
|
|
6055
7010
|
#
|
|
7011
|
+
# @option params [Types::UserContext] :user_context
|
|
7012
|
+
# Contains information about the user making the request. Use this to
|
|
7013
|
+
# pass user identity information for access control filtering, so that
|
|
7014
|
+
# retrieval results only include documents the user is authorized to
|
|
7015
|
+
# access.
|
|
7016
|
+
#
|
|
6056
7017
|
# @return [Types::RetrieveAndGenerateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6057
7018
|
#
|
|
6058
7019
|
# * {Types::RetrieveAndGenerateResponse#citations #citations} => Array<Types::Citation>
|
|
@@ -6158,7 +7119,106 @@ module Aws::BedrockAgentRuntime
|
|
|
6158
7119
|
# },
|
|
6159
7120
|
# },
|
|
6160
7121
|
# retrieval_configuration: {
|
|
6161
|
-
#
|
|
7122
|
+
# managed_search_configuration: {
|
|
7123
|
+
# filter: {
|
|
7124
|
+
# and_all: [
|
|
7125
|
+
# {
|
|
7126
|
+
# # recursive RetrievalFilter
|
|
7127
|
+
# },
|
|
7128
|
+
# ],
|
|
7129
|
+
# equals: {
|
|
7130
|
+
# key: "FilterKey", # required
|
|
7131
|
+
# value: { # required
|
|
7132
|
+
# },
|
|
7133
|
+
# },
|
|
7134
|
+
# greater_than: {
|
|
7135
|
+
# key: "FilterKey", # required
|
|
7136
|
+
# value: { # required
|
|
7137
|
+
# },
|
|
7138
|
+
# },
|
|
7139
|
+
# greater_than_or_equals: {
|
|
7140
|
+
# key: "FilterKey", # required
|
|
7141
|
+
# value: { # required
|
|
7142
|
+
# },
|
|
7143
|
+
# },
|
|
7144
|
+
# in: {
|
|
7145
|
+
# key: "FilterKey", # required
|
|
7146
|
+
# value: { # required
|
|
7147
|
+
# },
|
|
7148
|
+
# },
|
|
7149
|
+
# less_than: {
|
|
7150
|
+
# key: "FilterKey", # required
|
|
7151
|
+
# value: { # required
|
|
7152
|
+
# },
|
|
7153
|
+
# },
|
|
7154
|
+
# less_than_or_equals: {
|
|
7155
|
+
# key: "FilterKey", # required
|
|
7156
|
+
# value: { # required
|
|
7157
|
+
# },
|
|
7158
|
+
# },
|
|
7159
|
+
# list_contains: {
|
|
7160
|
+
# key: "FilterKey", # required
|
|
7161
|
+
# value: { # required
|
|
7162
|
+
# },
|
|
7163
|
+
# },
|
|
7164
|
+
# not_equals: {
|
|
7165
|
+
# key: "FilterKey", # required
|
|
7166
|
+
# value: { # required
|
|
7167
|
+
# },
|
|
7168
|
+
# },
|
|
7169
|
+
# not_in: {
|
|
7170
|
+
# key: "FilterKey", # required
|
|
7171
|
+
# value: { # required
|
|
7172
|
+
# },
|
|
7173
|
+
# },
|
|
7174
|
+
# or_all: [
|
|
7175
|
+
# {
|
|
7176
|
+
# # recursive RetrievalFilter
|
|
7177
|
+
# },
|
|
7178
|
+
# ],
|
|
7179
|
+
# starts_with: {
|
|
7180
|
+
# key: "FilterKey", # required
|
|
7181
|
+
# value: { # required
|
|
7182
|
+
# },
|
|
7183
|
+
# },
|
|
7184
|
+
# string_contains: {
|
|
7185
|
+
# key: "FilterKey", # required
|
|
7186
|
+
# value: { # required
|
|
7187
|
+
# },
|
|
7188
|
+
# },
|
|
7189
|
+
# },
|
|
7190
|
+
# number_of_results: 1,
|
|
7191
|
+
# reranking_configuration: {
|
|
7192
|
+
# bedrock_reranking_configuration: {
|
|
7193
|
+
# metadata_configuration: {
|
|
7194
|
+
# selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
|
|
7195
|
+
# selective_mode_configuration: {
|
|
7196
|
+
# fields_to_exclude: [
|
|
7197
|
+
# {
|
|
7198
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
7199
|
+
# },
|
|
7200
|
+
# ],
|
|
7201
|
+
# fields_to_include: [
|
|
7202
|
+
# {
|
|
7203
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
7204
|
+
# },
|
|
7205
|
+
# ],
|
|
7206
|
+
# },
|
|
7207
|
+
# },
|
|
7208
|
+
# model_configuration: { # required
|
|
7209
|
+
# additional_model_request_fields: {
|
|
7210
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
7211
|
+
# },
|
|
7212
|
+
# },
|
|
7213
|
+
# model_arn: "BedrockRerankingModelArn", # required
|
|
7214
|
+
# },
|
|
7215
|
+
# number_of_reranked_results: 1,
|
|
7216
|
+
# },
|
|
7217
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
|
7218
|
+
# },
|
|
7219
|
+
# reranking_model_type: "CUSTOM", # accepts CUSTOM, MANAGED, NONE
|
|
7220
|
+
# },
|
|
7221
|
+
# vector_search_configuration: {
|
|
6162
7222
|
# filter: {
|
|
6163
7223
|
# and_all: [
|
|
6164
7224
|
# {
|
|
@@ -6275,6 +7335,9 @@ module Aws::BedrockAgentRuntime
|
|
|
6275
7335
|
# kms_key_arn: "KmsKeyArn", # required
|
|
6276
7336
|
# },
|
|
6277
7337
|
# session_id: "SessionId",
|
|
7338
|
+
# user_context: {
|
|
7339
|
+
# user_id: "String", # required
|
|
7340
|
+
# },
|
|
6278
7341
|
# })
|
|
6279
7342
|
#
|
|
6280
7343
|
# @example Response structure
|
|
@@ -6297,12 +7360,14 @@ module Aws::BedrockAgentRuntime
|
|
|
6297
7360
|
# resp.citations[0].retrieved_references[0].content.video.summary #=> String
|
|
6298
7361
|
# resp.citations[0].retrieved_references[0].location.confluence_location.url #=> String
|
|
6299
7362
|
# resp.citations[0].retrieved_references[0].location.custom_document_location.id #=> String
|
|
7363
|
+
# resp.citations[0].retrieved_references[0].location.google_drive_location.url #=> String
|
|
6300
7364
|
# resp.citations[0].retrieved_references[0].location.kendra_document_location.uri #=> String
|
|
7365
|
+
# resp.citations[0].retrieved_references[0].location.one_drive_location.url #=> String
|
|
6301
7366
|
# resp.citations[0].retrieved_references[0].location.s3_location.uri #=> String
|
|
6302
7367
|
# resp.citations[0].retrieved_references[0].location.salesforce_location.url #=> String
|
|
6303
7368
|
# resp.citations[0].retrieved_references[0].location.share_point_location.url #=> String
|
|
6304
7369
|
# resp.citations[0].retrieved_references[0].location.sql_location.query #=> String
|
|
6305
|
-
# resp.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
|
7370
|
+
# resp.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL", "ONEDRIVE", "GOOGLEDRIVE"
|
|
6306
7371
|
# resp.citations[0].retrieved_references[0].location.web_location.url #=> String
|
|
6307
7372
|
# resp.citations[0].retrieved_references[0].metadata #=> Hash
|
|
6308
7373
|
# resp.guardrail_action #=> String, one of "INTERVENED", "NONE"
|
|
@@ -6321,6 +7386,12 @@ module Aws::BedrockAgentRuntime
|
|
|
6321
7386
|
# Queries a knowledge base and generates responses based on the
|
|
6322
7387
|
# retrieved results, with output in streaming format.
|
|
6323
7388
|
#
|
|
7389
|
+
# <note markdown="1"> This API cannot be used with managed knowledge bases. Use
|
|
7390
|
+
# [AgenticRetrieveStream][1] or [Retrieve][2] with managed knowledge
|
|
7391
|
+
# bases.
|
|
7392
|
+
#
|
|
7393
|
+
# </note>
|
|
7394
|
+
#
|
|
6324
7395
|
# <note markdown="1"> The CLI doesn't support streaming operations in Amazon Bedrock,
|
|
6325
7396
|
# including `InvokeModelWithResponseStream`.
|
|
6326
7397
|
#
|
|
@@ -6329,6 +7400,11 @@ module Aws::BedrockAgentRuntime
|
|
|
6329
7400
|
# This operation requires permission for the `
|
|
6330
7401
|
# bedrock:RetrieveAndGenerate` action.
|
|
6331
7402
|
#
|
|
7403
|
+
#
|
|
7404
|
+
#
|
|
7405
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_AgenticRetrieveStream.html
|
|
7406
|
+
# [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html
|
|
7407
|
+
#
|
|
6332
7408
|
# @option params [required, Types::RetrieveAndGenerateInput] :input
|
|
6333
7409
|
# Contains the query to be made to the knowledge base.
|
|
6334
7410
|
#
|
|
@@ -6351,6 +7427,12 @@ module Aws::BedrockAgentRuntime
|
|
|
6351
7427
|
# maintain context and knowledge from previous interactions. You can't
|
|
6352
7428
|
# explicitly set the `sessionId` yourself.
|
|
6353
7429
|
#
|
|
7430
|
+
# @option params [Types::UserContext] :user_context
|
|
7431
|
+
# Contains information about the user making the request. Use this to
|
|
7432
|
+
# pass user identity information for access control filtering, so that
|
|
7433
|
+
# retrieval results only include documents the user is authorized to
|
|
7434
|
+
# access.
|
|
7435
|
+
#
|
|
6354
7436
|
# @return [Types::RetrieveAndGenerateStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6355
7437
|
#
|
|
6356
7438
|
# * {Types::RetrieveAndGenerateStreamResponse#session_id #session_id} => String
|
|
@@ -6642,7 +7724,106 @@ module Aws::BedrockAgentRuntime
|
|
|
6642
7724
|
# },
|
|
6643
7725
|
# },
|
|
6644
7726
|
# retrieval_configuration: {
|
|
6645
|
-
#
|
|
7727
|
+
# managed_search_configuration: {
|
|
7728
|
+
# filter: {
|
|
7729
|
+
# and_all: [
|
|
7730
|
+
# {
|
|
7731
|
+
# # recursive RetrievalFilter
|
|
7732
|
+
# },
|
|
7733
|
+
# ],
|
|
7734
|
+
# equals: {
|
|
7735
|
+
# key: "FilterKey", # required
|
|
7736
|
+
# value: { # required
|
|
7737
|
+
# },
|
|
7738
|
+
# },
|
|
7739
|
+
# greater_than: {
|
|
7740
|
+
# key: "FilterKey", # required
|
|
7741
|
+
# value: { # required
|
|
7742
|
+
# },
|
|
7743
|
+
# },
|
|
7744
|
+
# greater_than_or_equals: {
|
|
7745
|
+
# key: "FilterKey", # required
|
|
7746
|
+
# value: { # required
|
|
7747
|
+
# },
|
|
7748
|
+
# },
|
|
7749
|
+
# in: {
|
|
7750
|
+
# key: "FilterKey", # required
|
|
7751
|
+
# value: { # required
|
|
7752
|
+
# },
|
|
7753
|
+
# },
|
|
7754
|
+
# less_than: {
|
|
7755
|
+
# key: "FilterKey", # required
|
|
7756
|
+
# value: { # required
|
|
7757
|
+
# },
|
|
7758
|
+
# },
|
|
7759
|
+
# less_than_or_equals: {
|
|
7760
|
+
# key: "FilterKey", # required
|
|
7761
|
+
# value: { # required
|
|
7762
|
+
# },
|
|
7763
|
+
# },
|
|
7764
|
+
# list_contains: {
|
|
7765
|
+
# key: "FilterKey", # required
|
|
7766
|
+
# value: { # required
|
|
7767
|
+
# },
|
|
7768
|
+
# },
|
|
7769
|
+
# not_equals: {
|
|
7770
|
+
# key: "FilterKey", # required
|
|
7771
|
+
# value: { # required
|
|
7772
|
+
# },
|
|
7773
|
+
# },
|
|
7774
|
+
# not_in: {
|
|
7775
|
+
# key: "FilterKey", # required
|
|
7776
|
+
# value: { # required
|
|
7777
|
+
# },
|
|
7778
|
+
# },
|
|
7779
|
+
# or_all: [
|
|
7780
|
+
# {
|
|
7781
|
+
# # recursive RetrievalFilter
|
|
7782
|
+
# },
|
|
7783
|
+
# ],
|
|
7784
|
+
# starts_with: {
|
|
7785
|
+
# key: "FilterKey", # required
|
|
7786
|
+
# value: { # required
|
|
7787
|
+
# },
|
|
7788
|
+
# },
|
|
7789
|
+
# string_contains: {
|
|
7790
|
+
# key: "FilterKey", # required
|
|
7791
|
+
# value: { # required
|
|
7792
|
+
# },
|
|
7793
|
+
# },
|
|
7794
|
+
# },
|
|
7795
|
+
# number_of_results: 1,
|
|
7796
|
+
# reranking_configuration: {
|
|
7797
|
+
# bedrock_reranking_configuration: {
|
|
7798
|
+
# metadata_configuration: {
|
|
7799
|
+
# selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
|
|
7800
|
+
# selective_mode_configuration: {
|
|
7801
|
+
# fields_to_exclude: [
|
|
7802
|
+
# {
|
|
7803
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
7804
|
+
# },
|
|
7805
|
+
# ],
|
|
7806
|
+
# fields_to_include: [
|
|
7807
|
+
# {
|
|
7808
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
7809
|
+
# },
|
|
7810
|
+
# ],
|
|
7811
|
+
# },
|
|
7812
|
+
# },
|
|
7813
|
+
# model_configuration: { # required
|
|
7814
|
+
# additional_model_request_fields: {
|
|
7815
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
7816
|
+
# },
|
|
7817
|
+
# },
|
|
7818
|
+
# model_arn: "BedrockRerankingModelArn", # required
|
|
7819
|
+
# },
|
|
7820
|
+
# number_of_reranked_results: 1,
|
|
7821
|
+
# },
|
|
7822
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
|
7823
|
+
# },
|
|
7824
|
+
# reranking_model_type: "CUSTOM", # accepts CUSTOM, MANAGED, NONE
|
|
7825
|
+
# },
|
|
7826
|
+
# vector_search_configuration: {
|
|
6646
7827
|
# filter: {
|
|
6647
7828
|
# and_all: [
|
|
6648
7829
|
# {
|
|
@@ -6759,6 +7940,9 @@ module Aws::BedrockAgentRuntime
|
|
|
6759
7940
|
# kms_key_arn: "KmsKeyArn", # required
|
|
6760
7941
|
# },
|
|
6761
7942
|
# session_id: "SessionId",
|
|
7943
|
+
# user_context: {
|
|
7944
|
+
# user_id: "String", # required
|
|
7945
|
+
# },
|
|
6762
7946
|
# })
|
|
6763
7947
|
#
|
|
6764
7948
|
# @example Response structure
|
|
@@ -6793,12 +7977,14 @@ module Aws::BedrockAgentRuntime
|
|
|
6793
7977
|
# event.citation.retrieved_references[0].content.video.summary #=> String
|
|
6794
7978
|
# event.citation.retrieved_references[0].location.confluence_location.url #=> String
|
|
6795
7979
|
# event.citation.retrieved_references[0].location.custom_document_location.id #=> String
|
|
7980
|
+
# event.citation.retrieved_references[0].location.google_drive_location.url #=> String
|
|
6796
7981
|
# event.citation.retrieved_references[0].location.kendra_document_location.uri #=> String
|
|
7982
|
+
# event.citation.retrieved_references[0].location.one_drive_location.url #=> String
|
|
6797
7983
|
# event.citation.retrieved_references[0].location.s3_location.uri #=> String
|
|
6798
7984
|
# event.citation.retrieved_references[0].location.salesforce_location.url #=> String
|
|
6799
7985
|
# event.citation.retrieved_references[0].location.share_point_location.url #=> String
|
|
6800
7986
|
# event.citation.retrieved_references[0].location.sql_location.query #=> String
|
|
6801
|
-
# event.citation.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
|
7987
|
+
# event.citation.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL", "ONEDRIVE", "GOOGLEDRIVE"
|
|
6802
7988
|
# event.citation.retrieved_references[0].location.web_location.url #=> String
|
|
6803
7989
|
# event.citation.retrieved_references[0].metadata #=> Hash
|
|
6804
7990
|
# event.generated_response_part.text_response_part.span.end #=> Integer
|
|
@@ -6818,12 +8004,14 @@ module Aws::BedrockAgentRuntime
|
|
|
6818
8004
|
# event.retrieved_references[0].content.video.summary #=> String
|
|
6819
8005
|
# event.retrieved_references[0].location.confluence_location.url #=> String
|
|
6820
8006
|
# event.retrieved_references[0].location.custom_document_location.id #=> String
|
|
8007
|
+
# event.retrieved_references[0].location.google_drive_location.url #=> String
|
|
6821
8008
|
# event.retrieved_references[0].location.kendra_document_location.uri #=> String
|
|
8009
|
+
# event.retrieved_references[0].location.one_drive_location.url #=> String
|
|
6822
8010
|
# event.retrieved_references[0].location.s3_location.uri #=> String
|
|
6823
8011
|
# event.retrieved_references[0].location.salesforce_location.url #=> String
|
|
6824
8012
|
# event.retrieved_references[0].location.share_point_location.url #=> String
|
|
6825
8013
|
# event.retrieved_references[0].location.sql_location.query #=> String
|
|
6826
|
-
# event.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
|
8014
|
+
# event.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL", "ONEDRIVE", "GOOGLEDRIVE"
|
|
6827
8015
|
# event.retrieved_references[0].location.web_location.url #=> String
|
|
6828
8016
|
# event.retrieved_references[0].metadata #=> Hash
|
|
6829
8017
|
#
|
|
@@ -7125,7 +8313,7 @@ module Aws::BedrockAgentRuntime
|
|
|
7125
8313
|
tracer: tracer
|
|
7126
8314
|
)
|
|
7127
8315
|
context[:gem_name] = 'aws-sdk-bedrockagentruntime'
|
|
7128
|
-
context[:gem_version] = '1.
|
|
8316
|
+
context[:gem_version] = '1.77.0'
|
|
7129
8317
|
Seahorse::Client::Request.new(handlers, context)
|
|
7130
8318
|
end
|
|
7131
8319
|
|