aws-sdk-bedrockagentruntime 1.78.0 → 1.80.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.
@@ -384,6 +384,11 @@ module Aws::BedrockAgentRuntime
384
384
  # Details of a full document expansion action.
385
385
  # @return [Types::AgenticRetrieveFullDocExpansionDetails]
386
386
  #
387
+ # @!attribute [rw] memory_retrieve
388
+ # The details of a long-term memory retrieval that the agent chose to
389
+ # perform.
390
+ # @return [Types::AgenticRetrieveMemoryRetrieveDetails]
391
+ #
387
392
  # @!attribute [rw] retrieve
388
393
  # Details of the retrieve action.
389
394
  # @return [Types::AgenticRetrieveActionDetails]
@@ -392,6 +397,7 @@ module Aws::BedrockAgentRuntime
392
397
  #
393
398
  class AgenticRetrieveAction < Struct.new(
394
399
  :full_document_expansion,
400
+ :memory_retrieve,
395
401
  :retrieve)
396
402
  SENSITIVE = []
397
403
  include Aws::Structure
@@ -625,6 +631,270 @@ module Aws::BedrockAgentRuntime
625
631
  include Aws::Structure
626
632
  end
627
633
 
634
+ # Specifies an AgentCore Memory resource and how this retrieval uses it.
635
+ # Set sessionBinding to restore and continue a session. Set
636
+ # retrievalConfigs to let the agent retrieve from long-term memory. You
637
+ # must specify at least one of the two.
638
+ #
639
+ # @!attribute [rw] memory_id
640
+ # The identifier of the AgentCore Memory resource to use. The resource
641
+ # must exist in your account and be in the ACTIVE state.
642
+ # @return [String]
643
+ #
644
+ # @!attribute [rw] persistence_mode
645
+ # Specifies whether the agent-generated answer is written back to the
646
+ # given short-term memory session, and applies only when
647
+ # sessionBinding is set. Valid values:
648
+ #
649
+ # * `DEFAULT` (default) – Specifies that the question and the
650
+ # agent-generated answer are persisted to the session as a single
651
+ # event. This value requires generateResponse to be true.
652
+ #
653
+ # * `NONE` – Specifies that the session is left unchanged.
654
+ # @return [String]
655
+ #
656
+ # @!attribute [rw] retrieval_configs
657
+ # Specifies the long-term memory configuration the agent can retrieve
658
+ # from. The agent decides whether to retrieve and composes its own
659
+ # query. This field currently accepts at most one entry.
660
+ # @return [Array<Types::AgenticRetrieveMemoryRetrievalConfig>]
661
+ #
662
+ # @!attribute [rw] session_binding
663
+ # The short-term memory session whose history is restored for this
664
+ # retrieval. To persist the agent-generated answer to the session,
665
+ # omit persistenceMode or set it to DEFAULT. To leave the session
666
+ # unchanged, set persistenceMode to NONE. Supply session history
667
+ # through the existing messages parameter or through short-term
668
+ # memory, but not both.
669
+ # @return [Types::AgenticRetrieveMemorySessionBinding]
670
+ #
671
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveMemoryConfiguration AWS API Documentation
672
+ #
673
+ class AgenticRetrieveMemoryConfiguration < Struct.new(
674
+ :memory_id,
675
+ :persistence_mode,
676
+ :retrieval_configs,
677
+ :session_binding)
678
+ SENSITIVE = []
679
+ include Aws::Structure
680
+ end
681
+
682
+ # A metadata filter expression, in the form accepted by the AgentCore
683
+ # Memory RetrieveMemoryRecords operation. The expression has a left
684
+ # operand that names the metadata key, an operator, and a right operand.
685
+ # For the EXISTS and NOT\_EXISTS operators, omit the right operand.
686
+ #
687
+ # @!attribute [rw] left
688
+ # The metadata key that the expression evaluates.
689
+ # @return [Types::AgenticRetrieveMemoryMetadataFilterLeft]
690
+ #
691
+ # @!attribute [rw] operator
692
+ # The relationship that the metadata key and value must have for a
693
+ # memory record to match.
694
+ # @return [String]
695
+ #
696
+ # @!attribute [rw] right
697
+ # The value that the expression compares the metadata key against.
698
+ # Supply this value for every operator except EXISTS and NOT\_EXISTS.
699
+ # @return [Types::AgenticRetrieveMemoryMetadataFilterRight]
700
+ #
701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveMemoryMetadataFilter AWS API Documentation
702
+ #
703
+ class AgenticRetrieveMemoryMetadataFilter < Struct.new(
704
+ :left,
705
+ :operator,
706
+ :right)
707
+ SENSITIVE = []
708
+ include Aws::Structure
709
+ end
710
+
711
+ # The left operand of a metadata filter expression. Set exactly one
712
+ # member.
713
+ #
714
+ # @note AgenticRetrieveMemoryMetadataFilterLeft is a union - when making an API calls you must set exactly one of the members.
715
+ #
716
+ # @!attribute [rw] metadata_key
717
+ # The metadata key to filter on.
718
+ # @return [String]
719
+ #
720
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveMemoryMetadataFilterLeft AWS API Documentation
721
+ #
722
+ class AgenticRetrieveMemoryMetadataFilterLeft < Struct.new(
723
+ :metadata_key,
724
+ :unknown)
725
+ SENSITIVE = []
726
+ include Aws::Structure
727
+ include Aws::Structure::Union
728
+
729
+ class MetadataKey < AgenticRetrieveMemoryMetadataFilterLeft; end
730
+ class Unknown < AgenticRetrieveMemoryMetadataFilterLeft; end
731
+ end
732
+
733
+ # The right operand of a metadata filter expression. Set exactly one
734
+ # member.
735
+ #
736
+ # @note AgenticRetrieveMemoryMetadataFilterRight is a union - when making an API calls you must set exactly one of the members.
737
+ #
738
+ # @!attribute [rw] metadata_value
739
+ # The value to compare the metadata key against.
740
+ # @return [Types::AgenticRetrieveMemoryMetadataValue]
741
+ #
742
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveMemoryMetadataFilterRight AWS API Documentation
743
+ #
744
+ class AgenticRetrieveMemoryMetadataFilterRight < Struct.new(
745
+ :metadata_value,
746
+ :unknown)
747
+ SENSITIVE = []
748
+ include Aws::Structure
749
+ include Aws::Structure::Union
750
+
751
+ class MetadataValue < AgenticRetrieveMemoryMetadataFilterRight; end
752
+ class Unknown < AgenticRetrieveMemoryMetadataFilterRight; end
753
+ end
754
+
755
+ # A metadata value that a filter expression compares against. Set
756
+ # exactly one member.
757
+ #
758
+ # @note AgenticRetrieveMemoryMetadataValue is a union - when making an API calls you must set exactly one of the members.
759
+ #
760
+ # @!attribute [rw] date_time_value
761
+ # A timestamp value in ISO 8601 UTC format.
762
+ # @return [Time]
763
+ #
764
+ # @!attribute [rw] number_value
765
+ # A numeric value.
766
+ # @return [Float]
767
+ #
768
+ # @!attribute [rw] string_list_value
769
+ # A list of string values.
770
+ # @return [Array<String>]
771
+ #
772
+ # @!attribute [rw] string_value
773
+ # A string value.
774
+ # @return [String]
775
+ #
776
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveMemoryMetadataValue AWS API Documentation
777
+ #
778
+ class AgenticRetrieveMemoryMetadataValue < Struct.new(
779
+ :date_time_value,
780
+ :number_value,
781
+ :string_list_value,
782
+ :string_value,
783
+ :unknown)
784
+ SENSITIVE = []
785
+ include Aws::Structure
786
+ include Aws::Structure::Union
787
+
788
+ class DateTimeValue < AgenticRetrieveMemoryMetadataValue; end
789
+ class NumberValue < AgenticRetrieveMemoryMetadataValue; end
790
+ class StringListValue < AgenticRetrieveMemoryMetadataValue; end
791
+ class StringValue < AgenticRetrieveMemoryMetadataValue; end
792
+ class Unknown < AgenticRetrieveMemoryMetadataValue; end
793
+ end
794
+
795
+ # The long-term memory namespace that the agent might retrieve memory
796
+ # records from, and the filters applied to that retrieval. You must
797
+ # specify either namespace or namespacePath.
798
+ #
799
+ # @!attribute [rw] metadata_filters
800
+ # The metadata filter expressions that restrict retrieval to matching
801
+ # memory records. You can specify a maximum of 5 expressions.
802
+ # @return [Array<Types::AgenticRetrieveMemoryMetadataFilter>]
803
+ #
804
+ # @!attribute [rw] namespace
805
+ # The namespace prefix to filter memory records by. The agent
806
+ # retrieves memory records in namespaces that start with the provided
807
+ # prefix. You must specify either namespace or namespacePath.
808
+ # @return [String]
809
+ #
810
+ # @!attribute [rw] namespace_path
811
+ # The parent namespace to use for hierarchical retrievals. The agent
812
+ # retrieves all memory records whose namespace falls under the same
813
+ # parent hierarchy. You must specify either namespace or
814
+ # namespacePath.
815
+ # @return [String]
816
+ #
817
+ # @!attribute [rw] strategy_id
818
+ # The extraction strategy ID that restricts retrieval to memory
819
+ # records produced by a single strategy. Omit this parameter to
820
+ # retrieve records from every strategy on the memory resource.
821
+ # @return [String]
822
+ #
823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveMemoryRetrievalConfig AWS API Documentation
824
+ #
825
+ class AgenticRetrieveMemoryRetrievalConfig < Struct.new(
826
+ :metadata_filters,
827
+ :namespace,
828
+ :namespace_path,
829
+ :strategy_id)
830
+ SENSITIVE = []
831
+ include Aws::Structure
832
+ end
833
+
834
+ # A long-term memory retrieval that the agent chose to perform. The
835
+ # record reports the query and the namespace. The corresponding
836
+ # Retrieval step reports the results.
837
+ #
838
+ # @!attribute [rw] input_query
839
+ # The query that the agent composed.
840
+ # @return [Types::AgenticRetrieveMessageContent]
841
+ #
842
+ # @!attribute [rw] memory_id
843
+ # The identifier of the AgentCore Memory resource retrieved from.
844
+ # @return [String]
845
+ #
846
+ # @!attribute [rw] namespace
847
+ # The namespace prefix retrieved from, as supplied in the request.
848
+ # This field is present when the request specified namespace.
849
+ # @return [String]
850
+ #
851
+ # @!attribute [rw] namespace_path
852
+ # The parent namespace retrieved from hierarchically, as supplied in
853
+ # the request. This field is present when the request specified
854
+ # namespacePath.
855
+ # @return [String]
856
+ #
857
+ # @!attribute [rw] strategy_id
858
+ # The extraction strategy that restricted retrieval, if the request
859
+ # specified one.
860
+ # @return [String]
861
+ #
862
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveMemoryRetrieveDetails AWS API Documentation
863
+ #
864
+ class AgenticRetrieveMemoryRetrieveDetails < Struct.new(
865
+ :input_query,
866
+ :memory_id,
867
+ :namespace,
868
+ :namespace_path,
869
+ :strategy_id)
870
+ SENSITIVE = [:input_query]
871
+ include Aws::Structure
872
+ end
873
+
874
+ # The short-term memory session that this retrieval reads from and
875
+ # writes to.
876
+ #
877
+ # @!attribute [rw] actor_id
878
+ # The identifier of the end user or agent that the session belongs to.
879
+ # This identifier scopes session history so that one actor's history
880
+ # is never returned for another. You are responsible for sending the
881
+ # correct actor value.
882
+ # @return [String]
883
+ #
884
+ # @!attribute [rw] session_id
885
+ # The identifier of the session to restore and continue. You are
886
+ # responsible for sending the correct session value.
887
+ # @return [String]
888
+ #
889
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgenticRetrieveMemorySessionBinding AWS API Documentation
890
+ #
891
+ class AgenticRetrieveMemorySessionBinding < Struct.new(
892
+ :actor_id,
893
+ :session_id)
894
+ SENSITIVE = []
895
+ include Aws::Structure
896
+ end
897
+
628
898
  # A message in the agentic retrieval conversation.
629
899
  #
630
900
  # @!attribute [rw] content
@@ -798,6 +1068,11 @@ module Aws::BedrockAgentRuntime
798
1068
  # Whether to generate a response based on the retrieved results.
799
1069
  # @return [Boolean]
800
1070
  #
1071
+ # @!attribute [rw] memory_configuration
1072
+ # The configuration for using an Amazon Bedrock AgentCore Memory
1073
+ # resource with this retrieval.
1074
+ # @return [Types::AgenticRetrieveMemoryConfiguration]
1075
+ #
801
1076
  # @!attribute [rw] messages
802
1077
  # The list of messages for the agentic retrieval conversation.
803
1078
  # @return [Array<Types::AgenticRetrieveMessage>]
@@ -825,6 +1100,7 @@ module Aws::BedrockAgentRuntime
825
1100
  class AgenticRetrieveStreamRequest < Struct.new(
826
1101
  :agentic_retrieve_configuration,
827
1102
  :generate_response,
1103
+ :memory_configuration,
828
1104
  :messages,
829
1105
  :next_token,
830
1106
  :policy_configuration,
@@ -1469,6 +1745,50 @@ module Aws::BedrockAgentRuntime
1469
1745
  class Unknown < Caller; end
1470
1746
  end
1471
1747
 
1748
+ # @!attribute [rw] data_source_id
1749
+ # The unique identifier of the data source that contains the document.
1750
+ # @return [String]
1751
+ #
1752
+ # @!attribute [rw] document_id
1753
+ # The unique identifier of the document to check access for.
1754
+ # @return [String]
1755
+ #
1756
+ # @!attribute [rw] knowledge_base_id
1757
+ # The unique identifier of the knowledge base that contains the
1758
+ # document.
1759
+ # @return [String]
1760
+ #
1761
+ # @!attribute [rw] user_context
1762
+ # The context object containing identity information for access
1763
+ # control filtering, including user ID and optional group memberships
1764
+ # used to evaluate the document access control list (ACL).
1765
+ # @return [Types::UserContext]
1766
+ #
1767
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/CheckIngestedDocumentAclRequest AWS API Documentation
1768
+ #
1769
+ class CheckIngestedDocumentAclRequest < Struct.new(
1770
+ :data_source_id,
1771
+ :document_id,
1772
+ :knowledge_base_id,
1773
+ :user_context)
1774
+ SENSITIVE = [:user_context]
1775
+ include Aws::Structure
1776
+ end
1777
+
1778
+ # @!attribute [rw] has_access
1779
+ # Specifies whether the user has access to the document based on the
1780
+ # ingested access control list (ACL). Returns `true` if the user is
1781
+ # allowed access, and `false` otherwise.
1782
+ # @return [Boolean]
1783
+ #
1784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/CheckIngestedDocumentAclResponse AWS API Documentation
1785
+ #
1786
+ class CheckIngestedDocumentAclResponse < Struct.new(
1787
+ :has_access)
1788
+ SENSITIVE = []
1789
+ include Aws::Structure
1790
+ end
1791
+
1472
1792
  # An object containing a segment of the generated response that is based
1473
1793
  # on a source in the knowledge base, alongside information about the
1474
1794
  # source.
@@ -2037,6 +2357,114 @@ module Aws::BedrockAgentRuntime
2037
2357
  include Aws::Structure
2038
2358
  end
2039
2359
 
2360
+ # The access control list for a document, containing allow and deny
2361
+ # membership lists. Each list specifies conditions that determine which
2362
+ # users and groups are granted or denied access.
2363
+ #
2364
+ # @!attribute [rw] allow_list
2365
+ # The list of principals allowed access to the document.
2366
+ # @return [Types::DocumentAclMembership]
2367
+ #
2368
+ # @!attribute [rw] deny_list
2369
+ # The list of principals denied access to the document.
2370
+ # @return [Types::DocumentAclMembership]
2371
+ #
2372
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/DocumentAcl AWS API Documentation
2373
+ #
2374
+ class DocumentAcl < Struct.new(
2375
+ :allow_list,
2376
+ :deny_list)
2377
+ SENSITIVE = []
2378
+ include Aws::Structure
2379
+ end
2380
+
2381
+ # A condition within a document access control list (ACL) membership,
2382
+ # specifying users and groups that are evaluated together.
2383
+ #
2384
+ # @!attribute [rw] condition_operator
2385
+ # The logical operator for combining users and groups within this
2386
+ # condition. Valid values: `AND` – Both a user match and a group match
2387
+ # are required. `OR` – Either a user match or a group match is
2388
+ # sufficient.
2389
+ # @return [String]
2390
+ #
2391
+ # @!attribute [rw] groups
2392
+ # The list of group entries in this condition.
2393
+ # @return [Array<Types::DocumentAclGroup>]
2394
+ #
2395
+ # @!attribute [rw] users
2396
+ # The list of user entries in this condition.
2397
+ # @return [Array<Types::DocumentAclUser>]
2398
+ #
2399
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/DocumentAclCondition AWS API Documentation
2400
+ #
2401
+ class DocumentAclCondition < Struct.new(
2402
+ :condition_operator,
2403
+ :groups,
2404
+ :users)
2405
+ SENSITIVE = []
2406
+ include Aws::Structure
2407
+ end
2408
+
2409
+ # A group entry within a document access control list (ACL) condition.
2410
+ #
2411
+ # @!attribute [rw] id
2412
+ # The identifier of the group.
2413
+ # @return [String]
2414
+ #
2415
+ # @!attribute [rw] type
2416
+ # The membership type indicating the scope of the group entry.
2417
+ # @return [String]
2418
+ #
2419
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/DocumentAclGroup AWS API Documentation
2420
+ #
2421
+ class DocumentAclGroup < Struct.new(
2422
+ :id,
2423
+ :type)
2424
+ SENSITIVE = []
2425
+ include Aws::Structure
2426
+ end
2427
+
2428
+ # The membership entry for a document access control list (ACL),
2429
+ # containing conditions and their logical relation.
2430
+ #
2431
+ # @!attribute [rw] conditions
2432
+ # The list of conditions that determine membership.
2433
+ # @return [Array<Types::DocumentAclCondition>]
2434
+ #
2435
+ # @!attribute [rw] member_relation
2436
+ # The logical relation between conditions. Valid values: `AND` – All
2437
+ # conditions must match. `OR` – At least one condition must match.
2438
+ # @return [String]
2439
+ #
2440
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/DocumentAclMembership AWS API Documentation
2441
+ #
2442
+ class DocumentAclMembership < Struct.new(
2443
+ :conditions,
2444
+ :member_relation)
2445
+ SENSITIVE = []
2446
+ include Aws::Structure
2447
+ end
2448
+
2449
+ # A user entry within a document access control list (ACL) condition.
2450
+ #
2451
+ # @!attribute [rw] id
2452
+ # The identifier of the user.
2453
+ # @return [String]
2454
+ #
2455
+ # @!attribute [rw] type
2456
+ # The membership type indicating the scope of the user entry.
2457
+ # @return [String]
2458
+ #
2459
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/DocumentAclUser AWS API Documentation
2460
+ #
2461
+ class DocumentAclUser < Struct.new(
2462
+ :id,
2463
+ :type)
2464
+ SENSITIVE = []
2465
+ include Aws::Structure
2466
+ end
2467
+
2040
2468
  # @!attribute [rw] session_identifier
2041
2469
  # The unique identifier for the session to end. You can specify either
2042
2470
  # the session's `sessionId` or its Amazon Resource Name (ARN).
@@ -3710,10 +4138,9 @@ module Aws::BedrockAgentRuntime
3710
4138
  # @return [String]
3711
4139
  #
3712
4140
  # @!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.
4141
+ # Contains information about the user making the request. This is used
4142
+ # for access control filtering to ensure that results only include
4143
+ # documents the user is authorized to access.
3717
4144
  # @return [Types::UserContext]
3718
4145
  #
3719
4146
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetDocumentContentRequest AWS API Documentation
@@ -3900,6 +4327,43 @@ module Aws::BedrockAgentRuntime
3900
4327
  include Aws::Structure
3901
4328
  end
3902
4329
 
4330
+ # @!attribute [rw] data_source_id
4331
+ # The unique identifier of the data source that contains the document.
4332
+ # @return [String]
4333
+ #
4334
+ # @!attribute [rw] document_id
4335
+ # The unique identifier of the document to retrieve the ingested
4336
+ # access control list (ACL) for.
4337
+ # @return [String]
4338
+ #
4339
+ # @!attribute [rw] knowledge_base_id
4340
+ # The unique identifier of the knowledge base that contains the
4341
+ # document.
4342
+ # @return [String]
4343
+ #
4344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetIngestedDocumentAclRequest AWS API Documentation
4345
+ #
4346
+ class GetIngestedDocumentAclRequest < Struct.new(
4347
+ :data_source_id,
4348
+ :document_id,
4349
+ :knowledge_base_id)
4350
+ SENSITIVE = []
4351
+ include Aws::Structure
4352
+ end
4353
+
4354
+ # @!attribute [rw] document_acl
4355
+ # The ingested document access control list (ACL) containing allow and
4356
+ # deny membership information.
4357
+ # @return [Types::DocumentAcl]
4358
+ #
4359
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetIngestedDocumentAclResponse AWS API Documentation
4360
+ #
4361
+ class GetIngestedDocumentAclResponse < Struct.new(
4362
+ :document_acl)
4363
+ SENSITIVE = [:document_acl]
4364
+ include Aws::Structure
4365
+ end
4366
+
3903
4367
  # @!attribute [rw] invocation_identifier
3904
4368
  # The unique identifier for the invocation in UUID format.
3905
4369
  # @return [String]
@@ -6183,22 +6647,8 @@ module Aws::BedrockAgentRuntime
6183
6647
  # store configuration.
6184
6648
  #
6185
6649
  # @!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
6650
+ # Filters the metadata of the retrieved results so that Amazon Bedrock
6651
+ # returns only results that match the filter.
6202
6652
  # @return [Types::RetrievalFilter]
6203
6653
  #
6204
6654
  # @!attribute [rw] number_of_results
@@ -8846,10 +9296,9 @@ module Aws::BedrockAgentRuntime
8846
9296
  # @return [String]
8847
9297
  #
8848
9298
  # @!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.
9299
+ # Contains information about the user making the request. This is used
9300
+ # for access control filtering to ensure that retrieval results only
9301
+ # include documents the user is authorized to access.
8853
9302
  # @return [Types::UserContext]
8854
9303
  #
8855
9304
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateRequest AWS API Documentation
@@ -8950,10 +9399,9 @@ module Aws::BedrockAgentRuntime
8950
9399
  # @return [String]
8951
9400
  #
8952
9401
  # @!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.
9402
+ # Contains information about the user making the request. This is used
9403
+ # for access control filtering to ensure that retrieval results only
9404
+ # include documents the user is authorized to access.
8957
9405
  # @return [Types::UserContext]
8958
9406
  #
8959
9407
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStreamRequest AWS API Documentation
@@ -9013,10 +9461,9 @@ module Aws::BedrockAgentRuntime
9013
9461
  # @return [Types::KnowledgeBaseQuery]
9014
9462
  #
9015
9463
  # @!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.
9464
+ # Contains information about the user making the request. This is used
9465
+ # for access control filtering to ensure that retrieval results only
9466
+ # include documents the user is authorized to access.
9020
9467
  # @return [Types::UserContext]
9021
9468
  #
9022
9469
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveRequest AWS API Documentation
@@ -56,7 +56,7 @@ module Aws::BedrockAgentRuntime
56
56
  autoload :Endpoints, 'aws-sdk-bedrockagentruntime/endpoints'
57
57
  autoload :EventStreams, 'aws-sdk-bedrockagentruntime/event_streams'
58
58
 
59
- GEM_VERSION = '1.78.0'
59
+ GEM_VERSION = '1.80.0'
60
60
 
61
61
  end
62
62
 
data/sig/client.rbs CHANGED
@@ -109,6 +109,37 @@ module Aws
109
109
  reranking_model_type: ("CUSTOM" | "MANAGED" | "NONE")?
110
110
  },
111
111
  ?generate_response: bool,
112
+ ?memory_configuration: {
113
+ memory_id: ::String,
114
+ persistence_mode: ("DEFAULT" | "NONE")?,
115
+ retrieval_configs: Array[
116
+ {
117
+ metadata_filters: Array[
118
+ {
119
+ left: {
120
+ metadata_key: ::String?
121
+ },
122
+ operator: ("EQUALS_TO" | "EXISTS" | "NOT_EXISTS" | "BEFORE" | "AFTER" | "CONTAINS" | "GREATER_THAN" | "GREATER_THAN_OR_EQUALS" | "LESS_THAN" | "LESS_THAN_OR_EQUALS"),
123
+ right: {
124
+ metadata_value: {
125
+ date_time_value: ::Time?,
126
+ number_value: ::Float?,
127
+ string_list_value: Array[::String]?,
128
+ string_value: ::String?
129
+ }?
130
+ }?
131
+ }
132
+ ]?,
133
+ namespace: ::String?,
134
+ namespace_path: ::String?,
135
+ strategy_id: ::String?
136
+ }
137
+ ]?,
138
+ session_binding: {
139
+ actor_id: ::String,
140
+ session_id: ::String
141
+ }?
142
+ },
112
143
  messages: Array[
113
144
  {
114
145
  content: {
@@ -144,6 +175,21 @@ module Aws
144
175
  ) ?{ (*untyped) -> void } -> _AgenticRetrieveStreamResponseSuccess
145
176
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) ?{ (*untyped) -> void } -> _AgenticRetrieveStreamResponseSuccess
146
177
 
178
+ interface _CheckIngestedDocumentAclResponseSuccess
179
+ include ::Seahorse::Client::_ResponseSuccess[Types::CheckIngestedDocumentAclResponse]
180
+ def has_access: () -> bool
181
+ end
182
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgentRuntime/Client.html#check_ingested_document_acl-instance_method
183
+ def check_ingested_document_acl: (
184
+ data_source_id: ::String,
185
+ document_id: ::String,
186
+ knowledge_base_id: ::String,
187
+ user_context: {
188
+ user_id: ::String
189
+ }
190
+ ) -> _CheckIngestedDocumentAclResponseSuccess
191
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CheckIngestedDocumentAclResponseSuccess
192
+
147
193
  interface _CreateInvocationResponseSuccess
148
194
  include ::Seahorse::Client::_ResponseSuccess[Types::CreateInvocationResponse]
149
195
  def created_at: () -> ::Time
@@ -298,6 +344,18 @@ module Aws
298
344
  ) -> _GetFlowExecutionResponseSuccess
299
345
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetFlowExecutionResponseSuccess
300
346
 
347
+ interface _GetIngestedDocumentAclResponseSuccess
348
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetIngestedDocumentAclResponse]
349
+ def document_acl: () -> Types::DocumentAcl
350
+ end
351
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgentRuntime/Client.html#get_ingested_document_acl-instance_method
352
+ def get_ingested_document_acl: (
353
+ data_source_id: ::String,
354
+ document_id: ::String,
355
+ knowledge_base_id: ::String
356
+ ) -> _GetIngestedDocumentAclResponseSuccess
357
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetIngestedDocumentAclResponseSuccess
358
+
301
359
  interface _GetInvocationStepResponseSuccess
302
360
  include ::Seahorse::Client::_ResponseSuccess[Types::GetInvocationStepResponse]
303
361
  def invocation_step: () -> Types::InvocationStep