aws-sdk-bedrockagentruntime 1.15.0 → 1.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockagentruntime/client.rb +545 -10
- data/lib/aws-sdk-bedrockagentruntime/client_api.rb +293 -0
- data/lib/aws-sdk-bedrockagentruntime/endpoints.rb +42 -0
- data/lib/aws-sdk-bedrockagentruntime/event_streams.rb +89 -0
- data/lib/aws-sdk-bedrockagentruntime/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-bedrockagentruntime/types.rb +848 -17
- data/lib/aws-sdk-bedrockagentruntime.rb +2 -2
- data/sig/client.rbs +145 -0
- data/sig/types.rbs +236 -4
- metadata +2 -2
@@ -41,10 +41,24 @@ module Aws::BedrockAgentRuntime
|
|
41
41
|
# The path to the API to call, based off the action group.
|
42
42
|
# @return [String]
|
43
43
|
#
|
44
|
+
# @!attribute [rw] execution_type
|
45
|
+
# How fulfillment of the action is handled. For more information, see
|
46
|
+
# [Handling fulfillment of the action][1].
|
47
|
+
#
|
48
|
+
#
|
49
|
+
#
|
50
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/action-handle.html
|
51
|
+
# @return [String]
|
52
|
+
#
|
44
53
|
# @!attribute [rw] function
|
45
54
|
# The function in the action group to call.
|
46
55
|
# @return [String]
|
47
56
|
#
|
57
|
+
# @!attribute [rw] invocation_id
|
58
|
+
# The unique identifier of the invocation. Only returned if the
|
59
|
+
# `executionType` is `RETURN_CONTROL`.
|
60
|
+
# @return [String]
|
61
|
+
#
|
48
62
|
# @!attribute [rw] parameters
|
49
63
|
# The parameters in the Lambda input event.
|
50
64
|
# @return [Array<Types::Parameter>]
|
@@ -62,7 +76,9 @@ module Aws::BedrockAgentRuntime
|
|
62
76
|
class ActionGroupInvocationInput < Struct.new(
|
63
77
|
:action_group_name,
|
64
78
|
:api_path,
|
79
|
+
:execution_type,
|
65
80
|
:function,
|
81
|
+
:invocation_id,
|
66
82
|
:parameters,
|
67
83
|
:request_body,
|
68
84
|
:verb)
|
@@ -312,6 +328,28 @@ module Aws::BedrockAgentRuntime
|
|
312
328
|
include Aws::Structure
|
313
329
|
end
|
314
330
|
|
331
|
+
# The property contains the file to chat with, along with its
|
332
|
+
# attributes.
|
333
|
+
#
|
334
|
+
# @!attribute [rw] data
|
335
|
+
# The byte value of the file to attach, encoded as Base-64 string. The
|
336
|
+
# maximum size of all files that is attached is 10MB. You can attach a
|
337
|
+
# maximum of 5 files.
|
338
|
+
# @return [String]
|
339
|
+
#
|
340
|
+
# @!attribute [rw] media_type
|
341
|
+
# The MIME type of data contained in the file used for chat.
|
342
|
+
# @return [String]
|
343
|
+
#
|
344
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ByteContentFile AWS API Documentation
|
345
|
+
#
|
346
|
+
class ByteContentFile < Struct.new(
|
347
|
+
:data,
|
348
|
+
:media_type)
|
349
|
+
SENSITIVE = [:data]
|
350
|
+
include Aws::Structure
|
351
|
+
end
|
352
|
+
|
315
353
|
# An object containing a segment of the generated response that is based
|
316
354
|
# on a source in the knowledge base, alongside information about the
|
317
355
|
# source.
|
@@ -345,6 +383,55 @@ module Aws::BedrockAgentRuntime
|
|
345
383
|
include Aws::Structure
|
346
384
|
end
|
347
385
|
|
386
|
+
# Contains information about the code interpreter being invoked.
|
387
|
+
#
|
388
|
+
# @!attribute [rw] code
|
389
|
+
# The code for the code interpreter to use.
|
390
|
+
# @return [String]
|
391
|
+
#
|
392
|
+
# @!attribute [rw] files
|
393
|
+
# Files that are uploaded for code interpreter to use.
|
394
|
+
# @return [Array<String>]
|
395
|
+
#
|
396
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/CodeInterpreterInvocationInput AWS API Documentation
|
397
|
+
#
|
398
|
+
class CodeInterpreterInvocationInput < Struct.new(
|
399
|
+
:code,
|
400
|
+
:files)
|
401
|
+
SENSITIVE = []
|
402
|
+
include Aws::Structure
|
403
|
+
end
|
404
|
+
|
405
|
+
# Contains the JSON-formatted string returned by the API invoked by the
|
406
|
+
# code interpreter.
|
407
|
+
#
|
408
|
+
# @!attribute [rw] execution_error
|
409
|
+
# Contains the error returned from code execution.
|
410
|
+
# @return [String]
|
411
|
+
#
|
412
|
+
# @!attribute [rw] execution_output
|
413
|
+
# Contains the successful output returned from code execution
|
414
|
+
# @return [String]
|
415
|
+
#
|
416
|
+
# @!attribute [rw] execution_timeout
|
417
|
+
# Indicates if the execution of the code timed out.
|
418
|
+
# @return [Boolean]
|
419
|
+
#
|
420
|
+
# @!attribute [rw] files
|
421
|
+
# Contains output files, if generated by code execution.
|
422
|
+
# @return [Array<String>]
|
423
|
+
#
|
424
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/CodeInterpreterInvocationOutput AWS API Documentation
|
425
|
+
#
|
426
|
+
class CodeInterpreterInvocationOutput < Struct.new(
|
427
|
+
:execution_error,
|
428
|
+
:execution_output,
|
429
|
+
:execution_timeout,
|
430
|
+
:files)
|
431
|
+
SENSITIVE = []
|
432
|
+
include Aws::Structure
|
433
|
+
end
|
434
|
+
|
348
435
|
# There was a conflict performing an operation. Resolve the conflict and
|
349
436
|
# retry your request.
|
350
437
|
#
|
@@ -385,6 +472,32 @@ module Aws::BedrockAgentRuntime
|
|
385
472
|
include Aws::Structure
|
386
473
|
end
|
387
474
|
|
475
|
+
# @!attribute [rw] agent_alias_id
|
476
|
+
# The unique identifier of an alias of an agent.
|
477
|
+
# @return [String]
|
478
|
+
#
|
479
|
+
# @!attribute [rw] agent_id
|
480
|
+
# The unique identifier of the agent to which the alias belongs.
|
481
|
+
# @return [String]
|
482
|
+
#
|
483
|
+
# @!attribute [rw] memory_id
|
484
|
+
# The unique identifier of the memory.
|
485
|
+
# @return [String]
|
486
|
+
#
|
487
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/DeleteAgentMemoryRequest AWS API Documentation
|
488
|
+
#
|
489
|
+
class DeleteAgentMemoryRequest < Struct.new(
|
490
|
+
:agent_alias_id,
|
491
|
+
:agent_id,
|
492
|
+
:memory_id)
|
493
|
+
SENSITIVE = []
|
494
|
+
include Aws::Structure
|
495
|
+
end
|
496
|
+
|
497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/DeleteAgentMemoryResponse AWS API Documentation
|
498
|
+
#
|
499
|
+
class DeleteAgentMemoryResponse < Aws::EmptyStructure; end
|
500
|
+
|
388
501
|
# There was an issue with a dependency. Check the resource
|
389
502
|
# configurations and retry the request.
|
390
503
|
#
|
@@ -514,6 +627,46 @@ module Aws::BedrockAgentRuntime
|
|
514
627
|
include Aws::Structure
|
515
628
|
end
|
516
629
|
|
630
|
+
# Contains intermediate response for code interpreter if any files have
|
631
|
+
# been generated.
|
632
|
+
#
|
633
|
+
# @!attribute [rw] files
|
634
|
+
# Files containing intermediate response for the user.
|
635
|
+
# @return [Array<Types::OutputFile>]
|
636
|
+
#
|
637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FilePart AWS API Documentation
|
638
|
+
#
|
639
|
+
class FilePart < Struct.new(
|
640
|
+
:files,
|
641
|
+
:event_type)
|
642
|
+
SENSITIVE = [:files]
|
643
|
+
include Aws::Structure
|
644
|
+
end
|
645
|
+
|
646
|
+
# The source file of the content contained in the wrapper object.
|
647
|
+
#
|
648
|
+
# @!attribute [rw] byte_content
|
649
|
+
# The data and the text of the attached files.
|
650
|
+
# @return [Types::ByteContentFile]
|
651
|
+
#
|
652
|
+
# @!attribute [rw] s3_location
|
653
|
+
# The s3 location of the files to attach.
|
654
|
+
# @return [Types::S3ObjectFile]
|
655
|
+
#
|
656
|
+
# @!attribute [rw] source_type
|
657
|
+
# The source type of the files to attach.
|
658
|
+
# @return [String]
|
659
|
+
#
|
660
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FileSource AWS API Documentation
|
661
|
+
#
|
662
|
+
class FileSource < Struct.new(
|
663
|
+
:byte_content,
|
664
|
+
:s3_location,
|
665
|
+
:source_type)
|
666
|
+
SENSITIVE = []
|
667
|
+
include Aws::Structure
|
668
|
+
end
|
669
|
+
|
517
670
|
# Specifies the name that the metadata attribute must match and the
|
518
671
|
# value to which to compare the value of the metadata attribute. For
|
519
672
|
# more information, see [Query configurations][1].
|
@@ -560,6 +713,165 @@ module Aws::BedrockAgentRuntime
|
|
560
713
|
include Aws::Structure
|
561
714
|
end
|
562
715
|
|
716
|
+
# Contains information about why a flow completed.
|
717
|
+
#
|
718
|
+
# This data type is used in the following API operations:
|
719
|
+
#
|
720
|
+
# * [InvokeFlow response][1]
|
721
|
+
#
|
722
|
+
# ^
|
723
|
+
#
|
724
|
+
#
|
725
|
+
#
|
726
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax
|
727
|
+
#
|
728
|
+
# @!attribute [rw] completion_reason
|
729
|
+
# The reason that the flow completed.
|
730
|
+
# @return [String]
|
731
|
+
#
|
732
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowCompletionEvent AWS API Documentation
|
733
|
+
#
|
734
|
+
class FlowCompletionEvent < Struct.new(
|
735
|
+
:completion_reason,
|
736
|
+
:event_type)
|
737
|
+
SENSITIVE = []
|
738
|
+
include Aws::Structure
|
739
|
+
end
|
740
|
+
|
741
|
+
# Contains information about an input into the prompt flow and where to
|
742
|
+
# send it.
|
743
|
+
#
|
744
|
+
# This data type is used in the following API operations:
|
745
|
+
#
|
746
|
+
# * [InvokeFlow request][1]
|
747
|
+
#
|
748
|
+
# ^
|
749
|
+
#
|
750
|
+
#
|
751
|
+
#
|
752
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax
|
753
|
+
#
|
754
|
+
# @!attribute [rw] content
|
755
|
+
# Contains information about an input into the prompt flow.
|
756
|
+
# @return [Types::FlowInputContent]
|
757
|
+
#
|
758
|
+
# @!attribute [rw] node_name
|
759
|
+
# The name of the flow input node that begins the prompt flow.
|
760
|
+
# @return [String]
|
761
|
+
#
|
762
|
+
# @!attribute [rw] node_output_name
|
763
|
+
# The name of the output from the flow input node that begins the
|
764
|
+
# prompt flow.
|
765
|
+
# @return [String]
|
766
|
+
#
|
767
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowInput AWS API Documentation
|
768
|
+
#
|
769
|
+
class FlowInput < Struct.new(
|
770
|
+
:content,
|
771
|
+
:node_name,
|
772
|
+
:node_output_name)
|
773
|
+
SENSITIVE = [:content]
|
774
|
+
include Aws::Structure
|
775
|
+
end
|
776
|
+
|
777
|
+
# Contains information about an input into the flow.
|
778
|
+
#
|
779
|
+
# This data type is used in the following API operations:
|
780
|
+
#
|
781
|
+
# * [InvokeFlow request][1]
|
782
|
+
#
|
783
|
+
# ^
|
784
|
+
#
|
785
|
+
#
|
786
|
+
#
|
787
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax
|
788
|
+
#
|
789
|
+
# @note FlowInputContent is a union - when making an API calls you must set exactly one of the members.
|
790
|
+
#
|
791
|
+
# @!attribute [rw] document
|
792
|
+
# The input to send to the prompt flow input node.
|
793
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
794
|
+
#
|
795
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowInputContent AWS API Documentation
|
796
|
+
#
|
797
|
+
class FlowInputContent < Struct.new(
|
798
|
+
:document,
|
799
|
+
:unknown)
|
800
|
+
SENSITIVE = []
|
801
|
+
include Aws::Structure
|
802
|
+
include Aws::Structure::Union
|
803
|
+
|
804
|
+
class Document < FlowInputContent; end
|
805
|
+
class Unknown < FlowInputContent; end
|
806
|
+
end
|
807
|
+
|
808
|
+
# Contains information about the content in an output from prompt flow
|
809
|
+
# invocation.
|
810
|
+
#
|
811
|
+
# This data type is used in the following API operations:
|
812
|
+
#
|
813
|
+
# * [InvokeFlow request][1]
|
814
|
+
#
|
815
|
+
# ^
|
816
|
+
#
|
817
|
+
#
|
818
|
+
#
|
819
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax
|
820
|
+
#
|
821
|
+
# @note FlowOutputContent is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FlowOutputContent corresponding to the set member.
|
822
|
+
#
|
823
|
+
# @!attribute [rw] document
|
824
|
+
# The content in the output.
|
825
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
826
|
+
#
|
827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowOutputContent AWS API Documentation
|
828
|
+
#
|
829
|
+
class FlowOutputContent < Struct.new(
|
830
|
+
:document,
|
831
|
+
:unknown)
|
832
|
+
SENSITIVE = []
|
833
|
+
include Aws::Structure
|
834
|
+
include Aws::Structure::Union
|
835
|
+
|
836
|
+
class Document < FlowOutputContent; end
|
837
|
+
class Unknown < FlowOutputContent; end
|
838
|
+
end
|
839
|
+
|
840
|
+
# Contains information about an output from prompt flow invoction.
|
841
|
+
#
|
842
|
+
# This data type is used in the following API operations:
|
843
|
+
#
|
844
|
+
# * [InvokeFlow response][1]
|
845
|
+
#
|
846
|
+
# ^
|
847
|
+
#
|
848
|
+
#
|
849
|
+
#
|
850
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax
|
851
|
+
#
|
852
|
+
# @!attribute [rw] content
|
853
|
+
# The content in the output.
|
854
|
+
# @return [Types::FlowOutputContent]
|
855
|
+
#
|
856
|
+
# @!attribute [rw] node_name
|
857
|
+
# The name of the flow output node that the output is from.
|
858
|
+
# @return [String]
|
859
|
+
#
|
860
|
+
# @!attribute [rw] node_type
|
861
|
+
# The type of the node that the output is from.
|
862
|
+
# @return [String]
|
863
|
+
#
|
864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowOutputEvent AWS API Documentation
|
865
|
+
#
|
866
|
+
class FlowOutputEvent < Struct.new(
|
867
|
+
:content,
|
868
|
+
:node_name,
|
869
|
+
:node_type,
|
870
|
+
:event_type)
|
871
|
+
SENSITIVE = []
|
872
|
+
include Aws::Structure
|
873
|
+
end
|
874
|
+
|
563
875
|
# Contains information about the function that the agent predicts should
|
564
876
|
# be called.
|
565
877
|
#
|
@@ -750,6 +1062,68 @@ module Aws::BedrockAgentRuntime
|
|
750
1062
|
include Aws::Structure
|
751
1063
|
end
|
752
1064
|
|
1065
|
+
# @!attribute [rw] agent_alias_id
|
1066
|
+
# The unique identifier of an alias of an agent.
|
1067
|
+
# @return [String]
|
1068
|
+
#
|
1069
|
+
# @!attribute [rw] agent_id
|
1070
|
+
# The unique identifier of the agent to which the alias belongs.
|
1071
|
+
# @return [String]
|
1072
|
+
#
|
1073
|
+
# @!attribute [rw] max_items
|
1074
|
+
# The maximum number of items to return in the response. If the total
|
1075
|
+
# number of results is greater than this value, use the token returned
|
1076
|
+
# in the response in the `nextToken` field when making another request
|
1077
|
+
# to return the next batch of results.
|
1078
|
+
# @return [Integer]
|
1079
|
+
#
|
1080
|
+
# @!attribute [rw] memory_id
|
1081
|
+
# The unique identifier of the memory.
|
1082
|
+
# @return [String]
|
1083
|
+
#
|
1084
|
+
# @!attribute [rw] memory_type
|
1085
|
+
# The type of memory.
|
1086
|
+
# @return [String]
|
1087
|
+
#
|
1088
|
+
# @!attribute [rw] next_token
|
1089
|
+
# If the total number of results is greater than the maxItems value
|
1090
|
+
# provided in the request, enter the token returned in the `nextToken`
|
1091
|
+
# field in the response in this field to return the next batch of
|
1092
|
+
# results.
|
1093
|
+
# @return [String]
|
1094
|
+
#
|
1095
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetAgentMemoryRequest AWS API Documentation
|
1096
|
+
#
|
1097
|
+
class GetAgentMemoryRequest < Struct.new(
|
1098
|
+
:agent_alias_id,
|
1099
|
+
:agent_id,
|
1100
|
+
:max_items,
|
1101
|
+
:memory_id,
|
1102
|
+
:memory_type,
|
1103
|
+
:next_token)
|
1104
|
+
SENSITIVE = []
|
1105
|
+
include Aws::Structure
|
1106
|
+
end
|
1107
|
+
|
1108
|
+
# @!attribute [rw] memory_contents
|
1109
|
+
# Contains details of the sessions stored in the memory
|
1110
|
+
# @return [Array<Types::Memory>]
|
1111
|
+
#
|
1112
|
+
# @!attribute [rw] next_token
|
1113
|
+
# If the total number of results is greater than the maxItems value
|
1114
|
+
# provided in the request, use this token when making another request
|
1115
|
+
# in the `nextToken` field to return the next batch of results.
|
1116
|
+
# @return [String]
|
1117
|
+
#
|
1118
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetAgentMemoryResponse AWS API Documentation
|
1119
|
+
#
|
1120
|
+
class GetAgentMemoryResponse < Struct.new(
|
1121
|
+
:memory_contents,
|
1122
|
+
:next_token)
|
1123
|
+
SENSITIVE = []
|
1124
|
+
include Aws::Structure
|
1125
|
+
end
|
1126
|
+
|
753
1127
|
# Assessment details of the content analyzed by Guardrails.
|
754
1128
|
#
|
755
1129
|
# @!attribute [rw] content_policy
|
@@ -1020,7 +1394,7 @@ module Aws::BedrockAgentRuntime
|
|
1020
1394
|
:input_assessments,
|
1021
1395
|
:output_assessments,
|
1022
1396
|
:trace_id)
|
1023
|
-
SENSITIVE = []
|
1397
|
+
SENSITIVE = [:input_assessments, :output_assessments]
|
1024
1398
|
include Aws::Structure
|
1025
1399
|
end
|
1026
1400
|
|
@@ -1100,7 +1474,7 @@ module Aws::BedrockAgentRuntime
|
|
1100
1474
|
# the following token at each point of generation. The value that you
|
1101
1475
|
# set for `Top P` determines the number of most-likely candidates from
|
1102
1476
|
# which the model chooses the next token in the sequence. For example,
|
1103
|
-
# if you set `topP` to
|
1477
|
+
# if you set `topP` to 0.8, the model only selects the next token from
|
1104
1478
|
# the top 80% of the probability distribution of next tokens.
|
1105
1479
|
# @return [Float]
|
1106
1480
|
#
|
@@ -1116,6 +1490,30 @@ module Aws::BedrockAgentRuntime
|
|
1116
1490
|
include Aws::Structure
|
1117
1491
|
end
|
1118
1492
|
|
1493
|
+
# Contains details of the source files.
|
1494
|
+
#
|
1495
|
+
# @!attribute [rw] name
|
1496
|
+
# The name of the source file.
|
1497
|
+
# @return [String]
|
1498
|
+
#
|
1499
|
+
# @!attribute [rw] source
|
1500
|
+
# Specifies where the files are located.
|
1501
|
+
# @return [Types::FileSource]
|
1502
|
+
#
|
1503
|
+
# @!attribute [rw] use_case
|
1504
|
+
# Specifies how the source files will be used by the code interpreter.
|
1505
|
+
# @return [String]
|
1506
|
+
#
|
1507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InputFile AWS API Documentation
|
1508
|
+
#
|
1509
|
+
class InputFile < Struct.new(
|
1510
|
+
:name,
|
1511
|
+
:source,
|
1512
|
+
:use_case)
|
1513
|
+
SENSITIVE = []
|
1514
|
+
include Aws::Structure
|
1515
|
+
end
|
1516
|
+
|
1119
1517
|
# An internal server error occurred. Retry your request.
|
1120
1518
|
#
|
1121
1519
|
# @!attribute [rw] message
|
@@ -1137,6 +1535,10 @@ module Aws::BedrockAgentRuntime
|
|
1137
1535
|
# Contains information about the action group to be invoked.
|
1138
1536
|
# @return [Types::ActionGroupInvocationInput]
|
1139
1537
|
#
|
1538
|
+
# @!attribute [rw] code_interpreter_invocation_input
|
1539
|
+
# Contains information about the code interpreter to be invoked.
|
1540
|
+
# @return [Types::CodeInterpreterInvocationInput]
|
1541
|
+
#
|
1140
1542
|
# @!attribute [rw] invocation_type
|
1141
1543
|
# Specifies whether the agent is invoking an action group or a
|
1142
1544
|
# knowledge base.
|
@@ -1155,6 +1557,7 @@ module Aws::BedrockAgentRuntime
|
|
1155
1557
|
#
|
1156
1558
|
class InvocationInput < Struct.new(
|
1157
1559
|
:action_group_invocation_input,
|
1560
|
+
:code_interpreter_invocation_input,
|
1158
1561
|
:invocation_type,
|
1159
1562
|
:knowledge_base_lookup_input,
|
1160
1563
|
:trace_id)
|
@@ -1273,6 +1676,10 @@ module Aws::BedrockAgentRuntime
|
|
1273
1676
|
# </note>
|
1274
1677
|
# @return [String]
|
1275
1678
|
#
|
1679
|
+
# @!attribute [rw] memory_id
|
1680
|
+
# The unique identifier of the agent memory.
|
1681
|
+
# @return [String]
|
1682
|
+
#
|
1276
1683
|
# @!attribute [rw] session_id
|
1277
1684
|
# The unique identifier of the session. Use the same value across
|
1278
1685
|
# requests to continue the same conversation.
|
@@ -1300,6 +1707,7 @@ module Aws::BedrockAgentRuntime
|
|
1300
1707
|
:enable_trace,
|
1301
1708
|
:end_session,
|
1302
1709
|
:input_text,
|
1710
|
+
:memory_id,
|
1303
1711
|
:session_id,
|
1304
1712
|
:session_state)
|
1305
1713
|
SENSITIVE = [:input_text]
|
@@ -1315,6 +1723,10 @@ module Aws::BedrockAgentRuntime
|
|
1315
1723
|
# `application/json`.
|
1316
1724
|
# @return [String]
|
1317
1725
|
#
|
1726
|
+
# @!attribute [rw] memory_id
|
1727
|
+
# The unique identifier of the agent memory.
|
1728
|
+
# @return [String]
|
1729
|
+
#
|
1318
1730
|
# @!attribute [rw] session_id
|
1319
1731
|
# The unique identifier of the session with the agent.
|
1320
1732
|
# @return [String]
|
@@ -1324,11 +1736,78 @@ module Aws::BedrockAgentRuntime
|
|
1324
1736
|
class InvokeAgentResponse < Struct.new(
|
1325
1737
|
:completion,
|
1326
1738
|
:content_type,
|
1739
|
+
:memory_id,
|
1327
1740
|
:session_id)
|
1328
1741
|
SENSITIVE = []
|
1329
1742
|
include Aws::Structure
|
1330
1743
|
end
|
1331
1744
|
|
1745
|
+
# @!attribute [rw] flow_alias_identifier
|
1746
|
+
# The unique identifier of the flow alias.
|
1747
|
+
# @return [String]
|
1748
|
+
#
|
1749
|
+
# @!attribute [rw] flow_identifier
|
1750
|
+
# The unique identifier of the flow.
|
1751
|
+
# @return [String]
|
1752
|
+
#
|
1753
|
+
# @!attribute [rw] inputs
|
1754
|
+
# A list of objects, each containing information about an input into
|
1755
|
+
# the flow.
|
1756
|
+
# @return [Array<Types::FlowInput>]
|
1757
|
+
#
|
1758
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InvokeFlowRequest AWS API Documentation
|
1759
|
+
#
|
1760
|
+
class InvokeFlowRequest < Struct.new(
|
1761
|
+
:flow_alias_identifier,
|
1762
|
+
:flow_identifier,
|
1763
|
+
:inputs)
|
1764
|
+
SENSITIVE = []
|
1765
|
+
include Aws::Structure
|
1766
|
+
end
|
1767
|
+
|
1768
|
+
# @!attribute [rw] response_stream
|
1769
|
+
# The output of the flow, returned as a stream. If there's an error,
|
1770
|
+
# the error is returned.
|
1771
|
+
# @return [Types::FlowResponseStream]
|
1772
|
+
#
|
1773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InvokeFlowResponse AWS API Documentation
|
1774
|
+
#
|
1775
|
+
class InvokeFlowResponse < Struct.new(
|
1776
|
+
:response_stream)
|
1777
|
+
SENSITIVE = []
|
1778
|
+
include Aws::Structure
|
1779
|
+
end
|
1780
|
+
|
1781
|
+
# Configurations to apply to a knowledge base attached to the agent
|
1782
|
+
# during query. For more information, see [Knowledge base retrieval
|
1783
|
+
# configurations][1].
|
1784
|
+
#
|
1785
|
+
#
|
1786
|
+
#
|
1787
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html#session-state-kb
|
1788
|
+
#
|
1789
|
+
# @!attribute [rw] knowledge_base_id
|
1790
|
+
# The unique identifier for a knowledge base attached to the agent.
|
1791
|
+
# @return [String]
|
1792
|
+
#
|
1793
|
+
# @!attribute [rw] retrieval_configuration
|
1794
|
+
# The configurations to apply to the knowledge base during query. For
|
1795
|
+
# more information, see [Query configurations][1].
|
1796
|
+
#
|
1797
|
+
#
|
1798
|
+
#
|
1799
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
|
1800
|
+
# @return [Types::KnowledgeBaseRetrievalConfiguration]
|
1801
|
+
#
|
1802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/KnowledgeBaseConfiguration AWS API Documentation
|
1803
|
+
#
|
1804
|
+
class KnowledgeBaseConfiguration < Struct.new(
|
1805
|
+
:knowledge_base_id,
|
1806
|
+
:retrieval_configuration)
|
1807
|
+
SENSITIVE = []
|
1808
|
+
include Aws::Structure
|
1809
|
+
end
|
1810
|
+
|
1332
1811
|
# Contains details about the knowledge base to look up and the query to
|
1333
1812
|
# be made.
|
1334
1813
|
#
|
@@ -1388,8 +1867,8 @@ module Aws::BedrockAgentRuntime
|
|
1388
1867
|
include Aws::Structure
|
1389
1868
|
end
|
1390
1869
|
|
1391
|
-
# Contains configurations for
|
1392
|
-
#
|
1870
|
+
# Contains configurations for knowledge base query. For more
|
1871
|
+
# information, see [Query configurations][1].
|
1393
1872
|
#
|
1394
1873
|
# This data type is used in the following API operations:
|
1395
1874
|
#
|
@@ -1481,7 +1960,7 @@ module Aws::BedrockAgentRuntime
|
|
1481
1960
|
#
|
1482
1961
|
# @!attribute [rw] generation_configuration
|
1483
1962
|
# Contains configurations for response generation based on the
|
1484
|
-
#
|
1963
|
+
# knowledge base query results.
|
1485
1964
|
# @return [Types::GenerationConfiguration]
|
1486
1965
|
#
|
1487
1966
|
# @!attribute [rw] knowledge_base_id
|
@@ -1493,6 +1972,11 @@ module Aws::BedrockAgentRuntime
|
|
1493
1972
|
# The ARN of the foundation model used to generate a response.
|
1494
1973
|
# @return [String]
|
1495
1974
|
#
|
1975
|
+
# @!attribute [rw] orchestration_configuration
|
1976
|
+
# Settings for how the model processes the prompt prior to retrieval
|
1977
|
+
# and generation.
|
1978
|
+
# @return [Types::OrchestrationConfiguration]
|
1979
|
+
#
|
1496
1980
|
# @!attribute [rw] retrieval_configuration
|
1497
1981
|
# Contains configurations for how to retrieve and return the knowledge
|
1498
1982
|
# base query.
|
@@ -1504,6 +1988,7 @@ module Aws::BedrockAgentRuntime
|
|
1504
1988
|
:generation_configuration,
|
1505
1989
|
:knowledge_base_id,
|
1506
1990
|
:model_arn,
|
1991
|
+
:orchestration_configuration,
|
1507
1992
|
:retrieval_configuration)
|
1508
1993
|
SENSITIVE = []
|
1509
1994
|
include Aws::Structure
|
@@ -1564,6 +2049,76 @@ module Aws::BedrockAgentRuntime
|
|
1564
2049
|
include Aws::Structure
|
1565
2050
|
end
|
1566
2051
|
|
2052
|
+
# Contains sessions summaries.
|
2053
|
+
#
|
2054
|
+
# @note Memory is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Memory corresponding to the set member.
|
2055
|
+
#
|
2056
|
+
# @!attribute [rw] session_summary
|
2057
|
+
# Contains summary of a session.
|
2058
|
+
# @return [Types::MemorySessionSummary]
|
2059
|
+
#
|
2060
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Memory AWS API Documentation
|
2061
|
+
#
|
2062
|
+
class Memory < Struct.new(
|
2063
|
+
:session_summary,
|
2064
|
+
:unknown)
|
2065
|
+
SENSITIVE = []
|
2066
|
+
include Aws::Structure
|
2067
|
+
include Aws::Structure::Union
|
2068
|
+
|
2069
|
+
class SessionSummary < Memory; end
|
2070
|
+
class Unknown < Memory; end
|
2071
|
+
end
|
2072
|
+
|
2073
|
+
# Contains details of a session summary.
|
2074
|
+
#
|
2075
|
+
# @!attribute [rw] memory_id
|
2076
|
+
# The unique identifier of the memory where the session summary is
|
2077
|
+
# stored.
|
2078
|
+
# @return [String]
|
2079
|
+
#
|
2080
|
+
# @!attribute [rw] session_expiry_time
|
2081
|
+
# The time when the memory duration for the session is set to end.
|
2082
|
+
# @return [Time]
|
2083
|
+
#
|
2084
|
+
# @!attribute [rw] session_id
|
2085
|
+
# The identifier for this session.
|
2086
|
+
# @return [String]
|
2087
|
+
#
|
2088
|
+
# @!attribute [rw] session_start_time
|
2089
|
+
# The start time for this session.
|
2090
|
+
# @return [Time]
|
2091
|
+
#
|
2092
|
+
# @!attribute [rw] summary_text
|
2093
|
+
# The summarized text for this session.
|
2094
|
+
# @return [String]
|
2095
|
+
#
|
2096
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/MemorySessionSummary AWS API Documentation
|
2097
|
+
#
|
2098
|
+
class MemorySessionSummary < Struct.new(
|
2099
|
+
:memory_id,
|
2100
|
+
:session_expiry_time,
|
2101
|
+
:session_id,
|
2102
|
+
:session_start_time,
|
2103
|
+
:summary_text)
|
2104
|
+
SENSITIVE = []
|
2105
|
+
include Aws::Structure
|
2106
|
+
end
|
2107
|
+
|
2108
|
+
# Provides details of the foundation model.
|
2109
|
+
#
|
2110
|
+
# @!attribute [rw] usage
|
2111
|
+
# Contains details of the foundation model usage.
|
2112
|
+
# @return [Types::Usage]
|
2113
|
+
#
|
2114
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Metadata AWS API Documentation
|
2115
|
+
#
|
2116
|
+
class Metadata < Struct.new(
|
2117
|
+
:usage)
|
2118
|
+
SENSITIVE = [:usage]
|
2119
|
+
include Aws::Structure
|
2120
|
+
end
|
2121
|
+
|
1567
2122
|
# The input for the pre-processing step.
|
1568
2123
|
#
|
1569
2124
|
# * The `type` matches the agent step.
|
@@ -1647,6 +2202,11 @@ module Aws::BedrockAgentRuntime
|
|
1647
2202
|
# the action group.
|
1648
2203
|
# @return [Types::ActionGroupInvocationOutput]
|
1649
2204
|
#
|
2205
|
+
# @!attribute [rw] code_interpreter_invocation_output
|
2206
|
+
# Contains the JSON-formatted string returned by the API invoked by
|
2207
|
+
# the code interpreter.
|
2208
|
+
# @return [Types::CodeInterpreterInvocationOutput]
|
2209
|
+
#
|
1650
2210
|
# @!attribute [rw] final_response
|
1651
2211
|
# Contains details about the response to the user.
|
1652
2212
|
# @return [Types::FinalResponse]
|
@@ -1686,6 +2246,7 @@ module Aws::BedrockAgentRuntime
|
|
1686
2246
|
#
|
1687
2247
|
class Observation < Struct.new(
|
1688
2248
|
:action_group_invocation_output,
|
2249
|
+
:code_interpreter_invocation_output,
|
1689
2250
|
:final_response,
|
1690
2251
|
:knowledge_base_lookup_output,
|
1691
2252
|
:reprompt_response,
|
@@ -1695,6 +2256,47 @@ module Aws::BedrockAgentRuntime
|
|
1695
2256
|
include Aws::Structure
|
1696
2257
|
end
|
1697
2258
|
|
2259
|
+
# Settings for how the model processes the prompt prior to retrieval and
|
2260
|
+
# generation.
|
2261
|
+
#
|
2262
|
+
# @!attribute [rw] query_transformation_configuration
|
2263
|
+
# To split up the prompt and retrieve multiple sources, set the
|
2264
|
+
# transformation type to `QUERY_DECOMPOSITION`.
|
2265
|
+
# @return [Types::QueryTransformationConfiguration]
|
2266
|
+
#
|
2267
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/OrchestrationConfiguration AWS API Documentation
|
2268
|
+
#
|
2269
|
+
class OrchestrationConfiguration < Struct.new(
|
2270
|
+
:query_transformation_configuration)
|
2271
|
+
SENSITIVE = []
|
2272
|
+
include Aws::Structure
|
2273
|
+
end
|
2274
|
+
|
2275
|
+
# The foundation model output from the orchestration step.
|
2276
|
+
#
|
2277
|
+
# @!attribute [rw] metadata
|
2278
|
+
# Contains information about the foundation model output.
|
2279
|
+
# @return [Types::Metadata]
|
2280
|
+
#
|
2281
|
+
# @!attribute [rw] raw_response
|
2282
|
+
# Contains details of the raw response from the foundation model
|
2283
|
+
# output.
|
2284
|
+
# @return [Types::RawResponse]
|
2285
|
+
#
|
2286
|
+
# @!attribute [rw] trace_id
|
2287
|
+
# The unique identifier of the trace.
|
2288
|
+
# @return [String]
|
2289
|
+
#
|
2290
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/OrchestrationModelInvocationOutput AWS API Documentation
|
2291
|
+
#
|
2292
|
+
class OrchestrationModelInvocationOutput < Struct.new(
|
2293
|
+
:metadata,
|
2294
|
+
:raw_response,
|
2295
|
+
:trace_id)
|
2296
|
+
SENSITIVE = [:metadata, :raw_response]
|
2297
|
+
include Aws::Structure
|
2298
|
+
end
|
2299
|
+
|
1698
2300
|
# Details about the orchestration step, in which the agent determines
|
1699
2301
|
# the order in which actions are executed and which knowledge bases are
|
1700
2302
|
# retrieved.
|
@@ -1722,6 +2324,11 @@ module Aws::BedrockAgentRuntime
|
|
1722
2324
|
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html
|
1723
2325
|
# @return [Types::ModelInvocationInput]
|
1724
2326
|
#
|
2327
|
+
# @!attribute [rw] model_invocation_output
|
2328
|
+
# Contains information pertaining to the output from the foundation
|
2329
|
+
# model that is being invoked.
|
2330
|
+
# @return [Types::OrchestrationModelInvocationOutput]
|
2331
|
+
#
|
1725
2332
|
# @!attribute [rw] observation
|
1726
2333
|
# Details about the observation (the output of the action group Lambda
|
1727
2334
|
# or knowledge base) made by the agent.
|
@@ -1738,20 +2345,47 @@ module Aws::BedrockAgentRuntime
|
|
1738
2345
|
class OrchestrationTrace < Struct.new(
|
1739
2346
|
:invocation_input,
|
1740
2347
|
:model_invocation_input,
|
2348
|
+
:model_invocation_output,
|
1741
2349
|
:observation,
|
1742
2350
|
:rationale,
|
1743
2351
|
:unknown)
|
1744
|
-
SENSITIVE = [:invocation_input, :model_invocation_input, :observation, :rationale]
|
2352
|
+
SENSITIVE = [:invocation_input, :model_invocation_input, :model_invocation_output, :observation, :rationale]
|
1745
2353
|
include Aws::Structure
|
1746
2354
|
include Aws::Structure::Union
|
1747
2355
|
|
1748
2356
|
class InvocationInput < OrchestrationTrace; end
|
1749
2357
|
class ModelInvocationInput < OrchestrationTrace; end
|
2358
|
+
class ModelInvocationOutput < OrchestrationTrace; end
|
1750
2359
|
class Observation < OrchestrationTrace; end
|
1751
2360
|
class Rationale < OrchestrationTrace; end
|
1752
2361
|
class Unknown < OrchestrationTrace; end
|
1753
2362
|
end
|
1754
2363
|
|
2364
|
+
# Contains details of the response from code interpreter.
|
2365
|
+
#
|
2366
|
+
# @!attribute [rw] bytes
|
2367
|
+
# The byte count of files that contains response from code
|
2368
|
+
# interpreter.
|
2369
|
+
# @return [String]
|
2370
|
+
#
|
2371
|
+
# @!attribute [rw] name
|
2372
|
+
# The name of the file containing response from code interpreter.
|
2373
|
+
# @return [String]
|
2374
|
+
#
|
2375
|
+
# @!attribute [rw] type
|
2376
|
+
# The type of file that contains response from the code interpreter.
|
2377
|
+
# @return [String]
|
2378
|
+
#
|
2379
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/OutputFile AWS API Documentation
|
2380
|
+
#
|
2381
|
+
class OutputFile < Struct.new(
|
2382
|
+
:bytes,
|
2383
|
+
:name,
|
2384
|
+
:type)
|
2385
|
+
SENSITIVE = [:bytes]
|
2386
|
+
include Aws::Structure
|
2387
|
+
end
|
2388
|
+
|
1755
2389
|
# A parameter for the API request or function.
|
1756
2390
|
#
|
1757
2391
|
# @!attribute [rw] name
|
@@ -2010,6 +2644,21 @@ module Aws::BedrockAgentRuntime
|
|
2010
2644
|
include Aws::Structure
|
2011
2645
|
end
|
2012
2646
|
|
2647
|
+
# To split up the prompt and retrieve multiple sources, set the
|
2648
|
+
# transformation type to `QUERY_DECOMPOSITION`.
|
2649
|
+
#
|
2650
|
+
# @!attribute [rw] type
|
2651
|
+
# The type of transformation to apply to the prompt.
|
2652
|
+
# @return [String]
|
2653
|
+
#
|
2654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/QueryTransformationConfiguration AWS API Documentation
|
2655
|
+
#
|
2656
|
+
class QueryTransformationConfiguration < Struct.new(
|
2657
|
+
:type)
|
2658
|
+
SENSITIVE = []
|
2659
|
+
include Aws::Structure
|
2660
|
+
end
|
2661
|
+
|
2013
2662
|
# Contains the reasoning, based on the input, that the agent uses to
|
2014
2663
|
# justify carrying out an action group or getting information from a
|
2015
2664
|
# knowledge base.
|
@@ -2031,6 +2680,20 @@ module Aws::BedrockAgentRuntime
|
|
2031
2680
|
include Aws::Structure
|
2032
2681
|
end
|
2033
2682
|
|
2683
|
+
# Contains the raw output from the foundation model.
|
2684
|
+
#
|
2685
|
+
# @!attribute [rw] content
|
2686
|
+
# The foundation model's raw output content.
|
2687
|
+
# @return [String]
|
2688
|
+
#
|
2689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RawResponse AWS API Documentation
|
2690
|
+
#
|
2691
|
+
class RawResponse < Struct.new(
|
2692
|
+
:content)
|
2693
|
+
SENSITIVE = []
|
2694
|
+
include Aws::Structure
|
2695
|
+
end
|
2696
|
+
|
2034
2697
|
# Contains details about the agent's response to reprompt the input.
|
2035
2698
|
#
|
2036
2699
|
# @!attribute [rw] source
|
@@ -2257,7 +2920,7 @@ module Aws::BedrockAgentRuntime
|
|
2257
2920
|
:starts_with,
|
2258
2921
|
:string_contains,
|
2259
2922
|
:unknown)
|
2260
|
-
SENSITIVE = []
|
2923
|
+
SENSITIVE = [:and_all, :or_all]
|
2261
2924
|
include Aws::Structure
|
2262
2925
|
include Aws::Structure::Union
|
2263
2926
|
|
@@ -2277,6 +2940,20 @@ module Aws::BedrockAgentRuntime
|
|
2277
2940
|
class Unknown < RetrievalFilter; end
|
2278
2941
|
end
|
2279
2942
|
|
2943
|
+
# The Confluence data source location.
|
2944
|
+
#
|
2945
|
+
# @!attribute [rw] url
|
2946
|
+
# The Confluence host URL for the data source location.
|
2947
|
+
# @return [String]
|
2948
|
+
#
|
2949
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalResultConfluenceLocation AWS API Documentation
|
2950
|
+
#
|
2951
|
+
class RetrievalResultConfluenceLocation < Struct.new(
|
2952
|
+
:url)
|
2953
|
+
SENSITIVE = []
|
2954
|
+
include Aws::Structure
|
2955
|
+
end
|
2956
|
+
|
2280
2957
|
# Contains the cited text from the data source.
|
2281
2958
|
#
|
2282
2959
|
# This data type is used in the following API operations:
|
@@ -2305,7 +2982,7 @@ module Aws::BedrockAgentRuntime
|
|
2305
2982
|
include Aws::Structure
|
2306
2983
|
end
|
2307
2984
|
|
2308
|
-
# Contains information about the
|
2985
|
+
# Contains information about the data source location.
|
2309
2986
|
#
|
2310
2987
|
# This data type is used in the following API operations:
|
2311
2988
|
#
|
@@ -2321,24 +2998,44 @@ module Aws::BedrockAgentRuntime
|
|
2321
2998
|
# [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_ResponseSyntax
|
2322
2999
|
# [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax
|
2323
3000
|
#
|
3001
|
+
# @!attribute [rw] confluence_location
|
3002
|
+
# The Confluence data source location.
|
3003
|
+
# @return [Types::RetrievalResultConfluenceLocation]
|
3004
|
+
#
|
2324
3005
|
# @!attribute [rw] s3_location
|
2325
|
-
#
|
3006
|
+
# The S3 data source location.
|
2326
3007
|
# @return [Types::RetrievalResultS3Location]
|
2327
3008
|
#
|
3009
|
+
# @!attribute [rw] salesforce_location
|
3010
|
+
# The Salesforce data source location.
|
3011
|
+
# @return [Types::RetrievalResultSalesforceLocation]
|
3012
|
+
#
|
3013
|
+
# @!attribute [rw] share_point_location
|
3014
|
+
# The SharePoint data source location.
|
3015
|
+
# @return [Types::RetrievalResultSharePointLocation]
|
3016
|
+
#
|
2328
3017
|
# @!attribute [rw] type
|
2329
|
-
# The type of
|
3018
|
+
# The type of data source location.
|
2330
3019
|
# @return [String]
|
2331
3020
|
#
|
3021
|
+
# @!attribute [rw] web_location
|
3022
|
+
# The web URL/URLs data source location.
|
3023
|
+
# @return [Types::RetrievalResultWebLocation]
|
3024
|
+
#
|
2332
3025
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalResultLocation AWS API Documentation
|
2333
3026
|
#
|
2334
3027
|
class RetrievalResultLocation < Struct.new(
|
3028
|
+
:confluence_location,
|
2335
3029
|
:s3_location,
|
2336
|
-
:
|
3030
|
+
:salesforce_location,
|
3031
|
+
:share_point_location,
|
3032
|
+
:type,
|
3033
|
+
:web_location)
|
2337
3034
|
SENSITIVE = []
|
2338
3035
|
include Aws::Structure
|
2339
3036
|
end
|
2340
3037
|
|
2341
|
-
#
|
3038
|
+
# The S3 data source location.
|
2342
3039
|
#
|
2343
3040
|
# This data type is used in the following API operations:
|
2344
3041
|
#
|
@@ -2355,7 +3052,7 @@ module Aws::BedrockAgentRuntime
|
|
2355
3052
|
# [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html#API_agent-runtime_InvokeAgent_ResponseSyntax
|
2356
3053
|
#
|
2357
3054
|
# @!attribute [rw] uri
|
2358
|
-
# The S3 URI
|
3055
|
+
# The S3 URI for the data source location.
|
2359
3056
|
# @return [String]
|
2360
3057
|
#
|
2361
3058
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalResultS3Location AWS API Documentation
|
@@ -2366,6 +3063,48 @@ module Aws::BedrockAgentRuntime
|
|
2366
3063
|
include Aws::Structure
|
2367
3064
|
end
|
2368
3065
|
|
3066
|
+
# The Salesforce data source location.
|
3067
|
+
#
|
3068
|
+
# @!attribute [rw] url
|
3069
|
+
# The Salesforce host URL for the data source location.
|
3070
|
+
# @return [String]
|
3071
|
+
#
|
3072
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalResultSalesforceLocation AWS API Documentation
|
3073
|
+
#
|
3074
|
+
class RetrievalResultSalesforceLocation < Struct.new(
|
3075
|
+
:url)
|
3076
|
+
SENSITIVE = []
|
3077
|
+
include Aws::Structure
|
3078
|
+
end
|
3079
|
+
|
3080
|
+
# The SharePoint data source location.
|
3081
|
+
#
|
3082
|
+
# @!attribute [rw] url
|
3083
|
+
# The SharePoint site URL for the data source location.
|
3084
|
+
# @return [String]
|
3085
|
+
#
|
3086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalResultSharePointLocation AWS API Documentation
|
3087
|
+
#
|
3088
|
+
class RetrievalResultSharePointLocation < Struct.new(
|
3089
|
+
:url)
|
3090
|
+
SENSITIVE = []
|
3091
|
+
include Aws::Structure
|
3092
|
+
end
|
3093
|
+
|
3094
|
+
# The web URL/URLs data source location.
|
3095
|
+
#
|
3096
|
+
# @!attribute [rw] url
|
3097
|
+
# The web URL/URLs for the data source location.
|
3098
|
+
# @return [String]
|
3099
|
+
#
|
3100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalResultWebLocation AWS API Documentation
|
3101
|
+
#
|
3102
|
+
class RetrievalResultWebLocation < Struct.new(
|
3103
|
+
:url)
|
3104
|
+
SENSITIVE = []
|
3105
|
+
include Aws::Structure
|
3106
|
+
end
|
3107
|
+
|
2369
3108
|
# Contains details about the resource being queried.
|
2370
3109
|
#
|
2371
3110
|
# This data type is used in the following API operations:
|
@@ -2468,8 +3207,12 @@ module Aws::BedrockAgentRuntime
|
|
2468
3207
|
# @return [Types::RetrieveAndGenerateSessionConfiguration]
|
2469
3208
|
#
|
2470
3209
|
# @!attribute [rw] session_id
|
2471
|
-
# The unique identifier of the session.
|
2472
|
-
#
|
3210
|
+
# The unique identifier of the session. When you first make a
|
3211
|
+
# `RetrieveAndGenerate` request, Amazon Bedrock automatically
|
3212
|
+
# generates this value. You must reuse this value for all subsequent
|
3213
|
+
# requests in the same conversational session. This value allows
|
3214
|
+
# Amazon Bedrock to maintain context and knowledge from previous
|
3215
|
+
# interactions. You can't explicitly set the `sessionId` yourself.
|
2473
3216
|
# @return [String]
|
2474
3217
|
#
|
2475
3218
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateRequest AWS API Documentation
|
@@ -2498,8 +3241,12 @@ module Aws::BedrockAgentRuntime
|
|
2498
3241
|
# @return [Types::RetrieveAndGenerateOutput]
|
2499
3242
|
#
|
2500
3243
|
# @!attribute [rw] session_id
|
2501
|
-
# The unique identifier of the session.
|
2502
|
-
#
|
3244
|
+
# The unique identifier of the session. When you first make a
|
3245
|
+
# `RetrieveAndGenerate` request, Amazon Bedrock automatically
|
3246
|
+
# generates this value. You must reuse this value for all subsequent
|
3247
|
+
# requests in the same conversational session. This value allows
|
3248
|
+
# Amazon Bedrock to maintain context and knowledge from previous
|
3249
|
+
# interactions. You can't explicitly set the `sessionId` yourself.
|
2503
3250
|
# @return [String]
|
2504
3251
|
#
|
2505
3252
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateResponse AWS API Documentation
|
@@ -2679,6 +3426,20 @@ module Aws::BedrockAgentRuntime
|
|
2679
3426
|
include Aws::Structure
|
2680
3427
|
end
|
2681
3428
|
|
3429
|
+
# Contains details of the s3 object where the source file is located.
|
3430
|
+
#
|
3431
|
+
# @!attribute [rw] uri
|
3432
|
+
# The uri of the s3 object.
|
3433
|
+
# @return [String]
|
3434
|
+
#
|
3435
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/S3ObjectFile AWS API Documentation
|
3436
|
+
#
|
3437
|
+
class S3ObjectFile < Struct.new(
|
3438
|
+
:uri)
|
3439
|
+
SENSITIVE = []
|
3440
|
+
include Aws::Structure
|
3441
|
+
end
|
3442
|
+
|
2682
3443
|
# The number of requests exceeds the service quota. Resubmit your
|
2683
3444
|
# request later.
|
2684
3445
|
#
|
@@ -2708,6 +3469,10 @@ module Aws::BedrockAgentRuntime
|
|
2708
3469
|
# [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
|
2709
3470
|
# [3]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html
|
2710
3471
|
#
|
3472
|
+
# @!attribute [rw] files
|
3473
|
+
# Contains information about the files used by code interpreter.
|
3474
|
+
# @return [Array<Types::InputFile>]
|
3475
|
+
#
|
2711
3476
|
# @!attribute [rw] invocation_id
|
2712
3477
|
# The identifier of the invocation of an action. This value must match
|
2713
3478
|
# the `invocationId` returned in the `InvokeAgent` response for the
|
@@ -2722,6 +3487,11 @@ module Aws::BedrockAgentRuntime
|
|
2722
3487
|
# [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html
|
2723
3488
|
# @return [String]
|
2724
3489
|
#
|
3490
|
+
# @!attribute [rw] knowledge_base_configurations
|
3491
|
+
# An array of configurations, each of which applies to a knowledge
|
3492
|
+
# base attached to the agent.
|
3493
|
+
# @return [Array<Types::KnowledgeBaseConfiguration>]
|
3494
|
+
#
|
2725
3495
|
# @!attribute [rw] prompt_session_attributes
|
2726
3496
|
# Contains attributes that persist across a prompt and the values of
|
2727
3497
|
# those attributes. These attributes replace the
|
@@ -2757,7 +3527,9 @@ module Aws::BedrockAgentRuntime
|
|
2757
3527
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/SessionState AWS API Documentation
|
2758
3528
|
#
|
2759
3529
|
class SessionState < Struct.new(
|
3530
|
+
:files,
|
2760
3531
|
:invocation_id,
|
3532
|
+
:knowledge_base_configurations,
|
2761
3533
|
:prompt_session_attributes,
|
2762
3534
|
:return_control_invocation_results,
|
2763
3535
|
:session_attributes)
|
@@ -3005,6 +3777,27 @@ module Aws::BedrockAgentRuntime
|
|
3005
3777
|
include Aws::Structure
|
3006
3778
|
end
|
3007
3779
|
|
3780
|
+
# Contains information of the usage of the foundation model.
|
3781
|
+
#
|
3782
|
+
# @!attribute [rw] input_tokens
|
3783
|
+
# Contains information about the input tokens from the foundation
|
3784
|
+
# model usage.
|
3785
|
+
# @return [Integer]
|
3786
|
+
#
|
3787
|
+
# @!attribute [rw] output_tokens
|
3788
|
+
# Contains information about the output tokens from the foundation
|
3789
|
+
# model usage.
|
3790
|
+
# @return [Integer]
|
3791
|
+
#
|
3792
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Usage AWS API Documentation
|
3793
|
+
#
|
3794
|
+
class Usage < Struct.new(
|
3795
|
+
:input_tokens,
|
3796
|
+
:output_tokens)
|
3797
|
+
SENSITIVE = []
|
3798
|
+
include Aws::Structure
|
3799
|
+
end
|
3800
|
+
|
3008
3801
|
# Input validation failed. Check your request parameters and retry the
|
3009
3802
|
# request.
|
3010
3803
|
#
|
@@ -3020,6 +3813,43 @@ module Aws::BedrockAgentRuntime
|
|
3020
3813
|
include Aws::Structure
|
3021
3814
|
end
|
3022
3815
|
|
3816
|
+
# The output of the flow.
|
3817
|
+
#
|
3818
|
+
# This data type is used in the following API operations:
|
3819
|
+
#
|
3820
|
+
# * [InvokeFlow response][1]
|
3821
|
+
#
|
3822
|
+
# ^
|
3823
|
+
#
|
3824
|
+
#
|
3825
|
+
#
|
3826
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax
|
3827
|
+
#
|
3828
|
+
# EventStream is an Enumerator of Events.
|
3829
|
+
# #event_types #=> Array, returns all modeled event types in the stream
|
3830
|
+
#
|
3831
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowResponseStream AWS API Documentation
|
3832
|
+
#
|
3833
|
+
class FlowResponseStream < Enumerator
|
3834
|
+
|
3835
|
+
def event_types
|
3836
|
+
[
|
3837
|
+
:access_denied_exception,
|
3838
|
+
:bad_gateway_exception,
|
3839
|
+
:conflict_exception,
|
3840
|
+
:dependency_failed_exception,
|
3841
|
+
:flow_completion_event,
|
3842
|
+
:flow_output_event,
|
3843
|
+
:internal_server_exception,
|
3844
|
+
:resource_not_found_exception,
|
3845
|
+
:service_quota_exceeded_exception,
|
3846
|
+
:throttling_exception,
|
3847
|
+
:validation_exception
|
3848
|
+
]
|
3849
|
+
end
|
3850
|
+
|
3851
|
+
end
|
3852
|
+
|
3023
3853
|
# The response from invoking the agent and associated citations and
|
3024
3854
|
# trace information.
|
3025
3855
|
#
|
@@ -3037,6 +3867,7 @@ module Aws::BedrockAgentRuntime
|
|
3037
3867
|
:chunk,
|
3038
3868
|
:conflict_exception,
|
3039
3869
|
:dependency_failed_exception,
|
3870
|
+
:files,
|
3040
3871
|
:internal_server_exception,
|
3041
3872
|
:resource_not_found_exception,
|
3042
3873
|
:return_control,
|