aws-sdk-bedrockagentruntime 1.36.0 → 1.38.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockagentruntime/client.rb +208 -11
- data/lib/aws-sdk-bedrockagentruntime/client_api.rb +114 -1
- data/lib/aws-sdk-bedrockagentruntime/errors.rb +16 -0
- data/lib/aws-sdk-bedrockagentruntime/event_streams.rb +5 -0
- data/lib/aws-sdk-bedrockagentruntime/types.rb +335 -7
- data/lib/aws-sdk-bedrockagentruntime.rb +1 -1
- data/sig/client.rbs +58 -2
- data/sig/errors.rbs +3 -0
- data/sig/types.rbs +97 -2
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a3323daf396d959bf599aedd3f4dee67814f29364cbab9070823ee323a873c00
|
4
|
+
data.tar.gz: 7f819442dab59ad29bb9d48b7b86935d455f8be7370a5145813c6dc076b20750
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e9ea1dd1dd7bdf57b36c787d0c654734db53e4c5ecfe1e4fd783125a24ce94c9fe0e58b5b724de27fc617cb7958e09c052b0302d65fdc6a8aba00a171a0c85c5
|
7
|
+
data.tar.gz: eee5a49504ad9003a0ac5a1986efba79ceac207778fed32b406dbee0b2624d745d3f4509f1f2133b54d09fd2239da211a04f3bc96bb7844bd7b400d0f19d221e
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.38.0 (2024-12-20)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - bedrock agents now supports long term memory and performance configs. Invokeflow supports performance configs. RetrieveAndGenerate performance configs
|
8
|
+
|
9
|
+
1.37.0 (2024-12-04)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release introduces the ability to generate SQL using natural language, through a new GenerateQuery API (with native integration into Knowledge Bases); ability to ingest and retrieve images through Bedrock Data Automation; and ability to create a Knowledge Base backed by Kendra GenAI Index.
|
13
|
+
|
4
14
|
1.36.0 (2024-12-03)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.38.0
|
@@ -469,6 +469,9 @@ module Aws::BedrockAgentRuntime
|
|
469
469
|
# @option params [String] :memory_id
|
470
470
|
# The unique identifier of the memory.
|
471
471
|
#
|
472
|
+
# @option params [String] :session_id
|
473
|
+
# The unique session identifier of the memory.
|
474
|
+
#
|
472
475
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
473
476
|
#
|
474
477
|
# @example Request syntax with placeholder values
|
@@ -477,6 +480,7 @@ module Aws::BedrockAgentRuntime
|
|
477
480
|
# agent_alias_id: "AgentAliasId", # required
|
478
481
|
# agent_id: "AgentId", # required
|
479
482
|
# memory_id: "MemoryId",
|
483
|
+
# session_id: "SessionId",
|
480
484
|
# })
|
481
485
|
#
|
482
486
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/DeleteAgentMemory AWS API Documentation
|
@@ -488,6 +492,59 @@ module Aws::BedrockAgentRuntime
|
|
488
492
|
req.send_request(options)
|
489
493
|
end
|
490
494
|
|
495
|
+
# Generates an SQL query from a natural language query. For more
|
496
|
+
# information, see [Generate a query for structured data][1] in the
|
497
|
+
# Amazon Bedrock User Guide.
|
498
|
+
#
|
499
|
+
#
|
500
|
+
#
|
501
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-generate-query.html
|
502
|
+
#
|
503
|
+
# @option params [required, Types::QueryGenerationInput] :query_generation_input
|
504
|
+
# Specifies information about a natural language query to transform into
|
505
|
+
# SQL.
|
506
|
+
#
|
507
|
+
# @option params [required, Types::TransformationConfiguration] :transformation_configuration
|
508
|
+
# Specifies configurations for transforming the natural language query
|
509
|
+
# into SQL.
|
510
|
+
#
|
511
|
+
# @return [Types::GenerateQueryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
512
|
+
#
|
513
|
+
# * {Types::GenerateQueryResponse#queries #queries} => Array<Types::GeneratedQuery>
|
514
|
+
#
|
515
|
+
# @example Request syntax with placeholder values
|
516
|
+
#
|
517
|
+
# resp = client.generate_query({
|
518
|
+
# query_generation_input: { # required
|
519
|
+
# text: "QueryGenerationInputTextString", # required
|
520
|
+
# type: "TEXT", # required, accepts TEXT
|
521
|
+
# },
|
522
|
+
# transformation_configuration: { # required
|
523
|
+
# mode: "TEXT_TO_SQL", # required, accepts TEXT_TO_SQL
|
524
|
+
# text_to_sql_configuration: {
|
525
|
+
# knowledge_base_configuration: {
|
526
|
+
# knowledge_base_arn: "KnowledgeBaseArn", # required
|
527
|
+
# },
|
528
|
+
# type: "KNOWLEDGE_BASE", # required, accepts KNOWLEDGE_BASE
|
529
|
+
# },
|
530
|
+
# },
|
531
|
+
# })
|
532
|
+
#
|
533
|
+
# @example Response structure
|
534
|
+
#
|
535
|
+
# resp.queries #=> Array
|
536
|
+
# resp.queries[0].sql #=> String
|
537
|
+
# resp.queries[0].type #=> String, one of "REDSHIFT_SQL"
|
538
|
+
#
|
539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GenerateQuery AWS API Documentation
|
540
|
+
#
|
541
|
+
# @overload generate_query(params = {})
|
542
|
+
# @param [Hash] params ({})
|
543
|
+
def generate_query(params = {}, options = {})
|
544
|
+
req = build_request(:generate_query, params)
|
545
|
+
req.send_request(options)
|
546
|
+
end
|
547
|
+
|
491
548
|
# Gets the sessions stored in the memory of the agent.
|
492
549
|
#
|
493
550
|
# @option params [required, String] :agent_alias_id
|
@@ -568,6 +625,15 @@ module Aws::BedrockAgentRuntime
|
|
568
625
|
# final result it yielded. For more information, see [Trace
|
569
626
|
# enablement][1].
|
570
627
|
#
|
628
|
+
# * To stream agent responses, make sure that only orchestration prompt
|
629
|
+
# is enabled. Agent streaming is not supported for the following
|
630
|
+
# steps:
|
631
|
+
#
|
632
|
+
# * `Pre-processing`
|
633
|
+
#
|
634
|
+
# * `Post-processing`
|
635
|
+
#
|
636
|
+
# * Agent with 1 Knowledge base and `User Input` not enabled
|
571
637
|
# * End a conversation by setting `endSession` to `true`.
|
572
638
|
#
|
573
639
|
# * In the `sessionState` object, you can include attributes for the
|
@@ -598,6 +664,9 @@ module Aws::BedrockAgentRuntime
|
|
598
664
|
# @option params [required, String] :agent_id
|
599
665
|
# The unique identifier of the agent to use.
|
600
666
|
#
|
667
|
+
# @option params [Types::BedrockModelConfigurations] :bedrock_model_configurations
|
668
|
+
# Model performance settings for the request.
|
669
|
+
#
|
601
670
|
# @option params [Boolean] :enable_trace
|
602
671
|
# Specifies whether to turn on the trace or not to track the agent's
|
603
672
|
# reasoning process. For more information, see [Trace enablement][1].
|
@@ -643,6 +712,11 @@ module Aws::BedrockAgentRuntime
|
|
643
712
|
# @option params [Types::StreamingConfigurations] :streaming_configurations
|
644
713
|
# Specifies the configurations for streaming.
|
645
714
|
#
|
715
|
+
# <note markdown="1"> To use agent streaming, you need permissions to perform the
|
716
|
+
# `bedrock:InvokeModelWithResponseStream` action.
|
717
|
+
#
|
718
|
+
# </note>
|
719
|
+
#
|
646
720
|
# @return [Types::InvokeAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
647
721
|
#
|
648
722
|
# * {Types::InvokeAgentResponse#completion #completion} => Types::ResponseStream
|
@@ -714,6 +788,9 @@ module Aws::BedrockAgentRuntime
|
|
714
788
|
# handler.on_internal_server_exception_event do |event|
|
715
789
|
# event # => Aws::BedrockAgentRuntime::Types::internalServerException
|
716
790
|
# end
|
791
|
+
# handler.on_model_not_ready_exception_event do |event|
|
792
|
+
# event # => Aws::BedrockAgentRuntime::Types::modelNotReadyException
|
793
|
+
# end
|
717
794
|
# handler.on_resource_not_found_exception_event do |event|
|
718
795
|
# event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
|
719
796
|
# end
|
@@ -760,6 +837,9 @@ module Aws::BedrockAgentRuntime
|
|
760
837
|
# stream.on_internal_server_exception_event do |event|
|
761
838
|
# event # => Aws::BedrockAgentRuntime::Types::internalServerException
|
762
839
|
# end
|
840
|
+
# stream.on_model_not_ready_exception_event do |event|
|
841
|
+
# event # => Aws::BedrockAgentRuntime::Types::modelNotReadyException
|
842
|
+
# end
|
763
843
|
# stream.on_resource_not_found_exception_event do |event|
|
764
844
|
# event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
|
765
845
|
# end
|
@@ -806,6 +886,9 @@ module Aws::BedrockAgentRuntime
|
|
806
886
|
# handler.on_internal_server_exception_event do |event|
|
807
887
|
# event # => Aws::BedrockAgentRuntime::Types::internalServerException
|
808
888
|
# end
|
889
|
+
# handler.on_model_not_ready_exception_event do |event|
|
890
|
+
# event # => Aws::BedrockAgentRuntime::Types::modelNotReadyException
|
891
|
+
# end
|
809
892
|
# handler.on_resource_not_found_exception_event do |event|
|
810
893
|
# event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
|
811
894
|
# end
|
@@ -846,6 +929,11 @@ module Aws::BedrockAgentRuntime
|
|
846
929
|
# resp = client.invoke_agent({
|
847
930
|
# agent_alias_id: "AgentAliasId", # required
|
848
931
|
# agent_id: "AgentId", # required
|
932
|
+
# bedrock_model_configurations: {
|
933
|
+
# performance_config: {
|
934
|
+
# latency: "standard", # accepts standard, optimized
|
935
|
+
# },
|
936
|
+
# },
|
849
937
|
# enable_trace: false,
|
850
938
|
# end_session: false,
|
851
939
|
# input_text: "InputText",
|
@@ -1045,7 +1133,7 @@ module Aws::BedrockAgentRuntime
|
|
1045
1133
|
#
|
1046
1134
|
# All events are available at resp.completion:
|
1047
1135
|
# resp.completion #=> Enumerator
|
1048
|
-
# resp.completion.event_types #=> [:access_denied_exception, :bad_gateway_exception, :chunk, :conflict_exception, :dependency_failed_exception, :files, :internal_server_exception, :resource_not_found_exception, :return_control, :service_quota_exceeded_exception, :throttling_exception, :trace, :validation_exception]
|
1136
|
+
# resp.completion.event_types #=> [:access_denied_exception, :bad_gateway_exception, :chunk, :conflict_exception, :dependency_failed_exception, :files, :internal_server_exception, :model_not_ready_exception, :resource_not_found_exception, :return_control, :service_quota_exceeded_exception, :throttling_exception, :trace, :validation_exception]
|
1049
1137
|
#
|
1050
1138
|
# For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
|
1051
1139
|
# event.message #=> String
|
@@ -1060,13 +1148,21 @@ module Aws::BedrockAgentRuntime
|
|
1060
1148
|
# event.attribution.citations[0].generated_response_part.text_response_part.span.start #=> Integer
|
1061
1149
|
# event.attribution.citations[0].generated_response_part.text_response_part.text #=> String
|
1062
1150
|
# event.attribution.citations[0].retrieved_references #=> Array
|
1151
|
+
# event.attribution.citations[0].retrieved_references[0].content.byte_content #=> String
|
1152
|
+
# event.attribution.citations[0].retrieved_references[0].content.row #=> Array
|
1153
|
+
# event.attribution.citations[0].retrieved_references[0].content.row[0].column_name #=> String
|
1154
|
+
# event.attribution.citations[0].retrieved_references[0].content.row[0].column_value #=> String
|
1155
|
+
# event.attribution.citations[0].retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
|
1063
1156
|
# event.attribution.citations[0].retrieved_references[0].content.text #=> String
|
1157
|
+
# event.attribution.citations[0].retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
|
1064
1158
|
# event.attribution.citations[0].retrieved_references[0].location.confluence_location.url #=> String
|
1065
1159
|
# event.attribution.citations[0].retrieved_references[0].location.custom_document_location.id #=> String
|
1160
|
+
# event.attribution.citations[0].retrieved_references[0].location.kendra_document_location.uri #=> String
|
1066
1161
|
# event.attribution.citations[0].retrieved_references[0].location.s3_location.uri #=> String
|
1067
1162
|
# event.attribution.citations[0].retrieved_references[0].location.salesforce_location.url #=> String
|
1068
1163
|
# event.attribution.citations[0].retrieved_references[0].location.share_point_location.url #=> String
|
1069
|
-
# event.attribution.citations[0].retrieved_references[0].location.
|
1164
|
+
# event.attribution.citations[0].retrieved_references[0].location.sql_location.query #=> String
|
1165
|
+
# event.attribution.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
1070
1166
|
# event.attribution.citations[0].retrieved_references[0].location.web_location.url #=> String
|
1071
1167
|
# event.attribution.citations[0].retrieved_references[0].metadata #=> Hash
|
1072
1168
|
# event.bytes #=> String
|
@@ -1087,6 +1183,9 @@ module Aws::BedrockAgentRuntime
|
|
1087
1183
|
# For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
|
1088
1184
|
# event.message #=> String
|
1089
1185
|
#
|
1186
|
+
# For :model_not_ready_exception event available at #on_model_not_ready_exception_event callback and response eventstream enumerator:
|
1187
|
+
# event.message #=> String
|
1188
|
+
#
|
1090
1189
|
# For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
|
1091
1190
|
# event.message #=> String
|
1092
1191
|
#
|
@@ -1287,13 +1386,21 @@ module Aws::BedrockAgentRuntime
|
|
1287
1386
|
# event.trace.orchestration_trace.observation.code_interpreter_invocation_output.files[0] #=> String
|
1288
1387
|
# event.trace.orchestration_trace.observation.final_response.text #=> String
|
1289
1388
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references #=> Array
|
1389
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.byte_content #=> String
|
1390
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row #=> Array
|
1391
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_name #=> String
|
1392
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_value #=> String
|
1393
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
|
1290
1394
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.text #=> String
|
1395
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
|
1291
1396
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
1292
1397
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
1398
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
|
1293
1399
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
1294
1400
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
1295
1401
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
1296
|
-
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.
|
1402
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
|
1403
|
+
# 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"
|
1297
1404
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
1298
1405
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
1299
1406
|
# event.trace.orchestration_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
@@ -1438,13 +1545,21 @@ module Aws::BedrockAgentRuntime
|
|
1438
1545
|
# event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.files[0] #=> String
|
1439
1546
|
# event.trace.routing_classifier_trace.observation.final_response.text #=> String
|
1440
1547
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references #=> Array
|
1548
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.byte_content #=> String
|
1549
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row #=> Array
|
1550
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_name #=> String
|
1551
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_value #=> String
|
1552
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
|
1441
1553
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.text #=> String
|
1554
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
|
1442
1555
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
1443
1556
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
1557
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
|
1444
1558
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
1445
1559
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
1446
1560
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
1447
|
-
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.
|
1561
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
|
1562
|
+
# 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"
|
1448
1563
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
1449
1564
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
1450
1565
|
# event.trace.routing_classifier_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
@@ -1521,6 +1636,9 @@ module Aws::BedrockAgentRuntime
|
|
1521
1636
|
# A list of objects, each containing information about an input into the
|
1522
1637
|
# flow.
|
1523
1638
|
#
|
1639
|
+
# @option params [Types::ModelPerformanceConfiguration] :model_performance_configuration
|
1640
|
+
# Model performance settings for the request.
|
1641
|
+
#
|
1524
1642
|
# @return [Types::InvokeFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1525
1643
|
#
|
1526
1644
|
# * {Types::InvokeFlowResponse#response_stream #response_stream} => Types::FlowResponseStream
|
@@ -1723,6 +1841,11 @@ module Aws::BedrockAgentRuntime
|
|
1723
1841
|
# node_output_name: "NodeOutputName", # required
|
1724
1842
|
# },
|
1725
1843
|
# ],
|
1844
|
+
# model_performance_configuration: {
|
1845
|
+
# performance_config: {
|
1846
|
+
# latency: "standard", # accepts standard, optimized
|
1847
|
+
# },
|
1848
|
+
# },
|
1726
1849
|
# })
|
1727
1850
|
#
|
1728
1851
|
# @example Response structure
|
@@ -1841,6 +1964,9 @@ module Aws::BedrockAgentRuntime
|
|
1841
1964
|
# A list of action groups with each action group defining the action the
|
1842
1965
|
# inline agent needs to carry out.
|
1843
1966
|
#
|
1967
|
+
# @option params [Types::InlineBedrockModelConfigurations] :bedrock_model_configurations
|
1968
|
+
# Model settings for the request.
|
1969
|
+
#
|
1844
1970
|
# @option params [String] :customer_encryption_key_arn
|
1845
1971
|
# The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to
|
1846
1972
|
# use to encrypt your inline agent.
|
@@ -2153,6 +2279,11 @@ module Aws::BedrockAgentRuntime
|
|
2153
2279
|
# parent_action_group_signature: "AMAZON.UserInput", # accepts AMAZON.UserInput, AMAZON.CodeInterpreter
|
2154
2280
|
# },
|
2155
2281
|
# ],
|
2282
|
+
# bedrock_model_configurations: {
|
2283
|
+
# performance_config: {
|
2284
|
+
# latency: "standard", # accepts standard, optimized
|
2285
|
+
# },
|
2286
|
+
# },
|
2156
2287
|
# customer_encryption_key_arn: "KmsKeyArn",
|
2157
2288
|
# enable_trace: false,
|
2158
2289
|
# end_session: false,
|
@@ -2377,13 +2508,21 @@ module Aws::BedrockAgentRuntime
|
|
2377
2508
|
# event.attribution.citations[0].generated_response_part.text_response_part.span.start #=> Integer
|
2378
2509
|
# event.attribution.citations[0].generated_response_part.text_response_part.text #=> String
|
2379
2510
|
# event.attribution.citations[0].retrieved_references #=> Array
|
2511
|
+
# event.attribution.citations[0].retrieved_references[0].content.byte_content #=> String
|
2512
|
+
# event.attribution.citations[0].retrieved_references[0].content.row #=> Array
|
2513
|
+
# event.attribution.citations[0].retrieved_references[0].content.row[0].column_name #=> String
|
2514
|
+
# event.attribution.citations[0].retrieved_references[0].content.row[0].column_value #=> String
|
2515
|
+
# event.attribution.citations[0].retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
|
2380
2516
|
# event.attribution.citations[0].retrieved_references[0].content.text #=> String
|
2517
|
+
# event.attribution.citations[0].retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
|
2381
2518
|
# event.attribution.citations[0].retrieved_references[0].location.confluence_location.url #=> String
|
2382
2519
|
# event.attribution.citations[0].retrieved_references[0].location.custom_document_location.id #=> String
|
2520
|
+
# event.attribution.citations[0].retrieved_references[0].location.kendra_document_location.uri #=> String
|
2383
2521
|
# event.attribution.citations[0].retrieved_references[0].location.s3_location.uri #=> String
|
2384
2522
|
# event.attribution.citations[0].retrieved_references[0].location.salesforce_location.url #=> String
|
2385
2523
|
# event.attribution.citations[0].retrieved_references[0].location.share_point_location.url #=> String
|
2386
|
-
# event.attribution.citations[0].retrieved_references[0].location.
|
2524
|
+
# event.attribution.citations[0].retrieved_references[0].location.sql_location.query #=> String
|
2525
|
+
# event.attribution.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
2387
2526
|
# event.attribution.citations[0].retrieved_references[0].location.web_location.url #=> String
|
2388
2527
|
# event.attribution.citations[0].retrieved_references[0].metadata #=> Hash
|
2389
2528
|
# event.bytes #=> String
|
@@ -2598,13 +2737,21 @@ module Aws::BedrockAgentRuntime
|
|
2598
2737
|
# event.trace.orchestration_trace.observation.code_interpreter_invocation_output.files[0] #=> String
|
2599
2738
|
# event.trace.orchestration_trace.observation.final_response.text #=> String
|
2600
2739
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references #=> Array
|
2740
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.byte_content #=> String
|
2741
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row #=> Array
|
2742
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_name #=> String
|
2743
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_value #=> String
|
2744
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
|
2601
2745
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.text #=> String
|
2746
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
|
2602
2747
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
2603
2748
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
2749
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
|
2604
2750
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
2605
2751
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
2606
2752
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
2607
|
-
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.
|
2753
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
|
2754
|
+
# 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"
|
2608
2755
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
2609
2756
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
2610
2757
|
# event.trace.orchestration_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
@@ -2749,13 +2896,21 @@ module Aws::BedrockAgentRuntime
|
|
2749
2896
|
# event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.files[0] #=> String
|
2750
2897
|
# event.trace.routing_classifier_trace.observation.final_response.text #=> String
|
2751
2898
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references #=> Array
|
2899
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.byte_content #=> String
|
2900
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row #=> Array
|
2901
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_name #=> String
|
2902
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_value #=> String
|
2903
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
|
2752
2904
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.text #=> String
|
2905
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
|
2753
2906
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
2754
2907
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
2908
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
|
2755
2909
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
2756
2910
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
2757
2911
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
2758
|
-
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.
|
2912
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
|
2913
|
+
# 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"
|
2759
2914
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
2760
2915
|
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
2761
2916
|
# event.trace.routing_classifier_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
@@ -3283,13 +3438,21 @@ module Aws::BedrockAgentRuntime
|
|
3283
3438
|
# resp.guardrail_action #=> String, one of "INTERVENED", "NONE"
|
3284
3439
|
# resp.next_token #=> String
|
3285
3440
|
# resp.retrieval_results #=> Array
|
3441
|
+
# resp.retrieval_results[0].content.byte_content #=> String
|
3442
|
+
# resp.retrieval_results[0].content.row #=> Array
|
3443
|
+
# resp.retrieval_results[0].content.row[0].column_name #=> String
|
3444
|
+
# resp.retrieval_results[0].content.row[0].column_value #=> String
|
3445
|
+
# resp.retrieval_results[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
|
3286
3446
|
# resp.retrieval_results[0].content.text #=> String
|
3447
|
+
# resp.retrieval_results[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
|
3287
3448
|
# resp.retrieval_results[0].location.confluence_location.url #=> String
|
3288
3449
|
# resp.retrieval_results[0].location.custom_document_location.id #=> String
|
3450
|
+
# resp.retrieval_results[0].location.kendra_document_location.uri #=> String
|
3289
3451
|
# resp.retrieval_results[0].location.s3_location.uri #=> String
|
3290
3452
|
# resp.retrieval_results[0].location.salesforce_location.url #=> String
|
3291
3453
|
# resp.retrieval_results[0].location.share_point_location.url #=> String
|
3292
|
-
# resp.retrieval_results[0].location.
|
3454
|
+
# resp.retrieval_results[0].location.sql_location.query #=> String
|
3455
|
+
# resp.retrieval_results[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
3293
3456
|
# resp.retrieval_results[0].location.web_location.url #=> String
|
3294
3457
|
# resp.retrieval_results[0].metadata #=> Hash
|
3295
3458
|
# resp.retrieval_results[0].score #=> Float
|
@@ -3366,6 +3529,9 @@ module Aws::BedrockAgentRuntime
|
|
3366
3529
|
# top_p: 1.0,
|
3367
3530
|
# },
|
3368
3531
|
# },
|
3532
|
+
# performance_config: {
|
3533
|
+
# latency: "standard", # accepts standard, optimized
|
3534
|
+
# },
|
3369
3535
|
# prompt_template: {
|
3370
3536
|
# text_prompt_template: "TextPromptTemplate",
|
3371
3537
|
# },
|
@@ -3403,6 +3569,9 @@ module Aws::BedrockAgentRuntime
|
|
3403
3569
|
# top_p: 1.0,
|
3404
3570
|
# },
|
3405
3571
|
# },
|
3572
|
+
# performance_config: {
|
3573
|
+
# latency: "standard", # accepts standard, optimized
|
3574
|
+
# },
|
3406
3575
|
# prompt_template: {
|
3407
3576
|
# text_prompt_template: "TextPromptTemplate",
|
3408
3577
|
# },
|
@@ -3422,6 +3591,9 @@ module Aws::BedrockAgentRuntime
|
|
3422
3591
|
# top_p: 1.0,
|
3423
3592
|
# },
|
3424
3593
|
# },
|
3594
|
+
# performance_config: {
|
3595
|
+
# latency: "standard", # accepts standard, optimized
|
3596
|
+
# },
|
3425
3597
|
# prompt_template: {
|
3426
3598
|
# text_prompt_template: "TextPromptTemplate",
|
3427
3599
|
# },
|
@@ -3556,13 +3728,21 @@ module Aws::BedrockAgentRuntime
|
|
3556
3728
|
# resp.citations[0].generated_response_part.text_response_part.span.start #=> Integer
|
3557
3729
|
# resp.citations[0].generated_response_part.text_response_part.text #=> String
|
3558
3730
|
# resp.citations[0].retrieved_references #=> Array
|
3731
|
+
# resp.citations[0].retrieved_references[0].content.byte_content #=> String
|
3732
|
+
# resp.citations[0].retrieved_references[0].content.row #=> Array
|
3733
|
+
# resp.citations[0].retrieved_references[0].content.row[0].column_name #=> String
|
3734
|
+
# resp.citations[0].retrieved_references[0].content.row[0].column_value #=> String
|
3735
|
+
# resp.citations[0].retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
|
3559
3736
|
# resp.citations[0].retrieved_references[0].content.text #=> String
|
3737
|
+
# resp.citations[0].retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
|
3560
3738
|
# resp.citations[0].retrieved_references[0].location.confluence_location.url #=> String
|
3561
3739
|
# resp.citations[0].retrieved_references[0].location.custom_document_location.id #=> String
|
3740
|
+
# resp.citations[0].retrieved_references[0].location.kendra_document_location.uri #=> String
|
3562
3741
|
# resp.citations[0].retrieved_references[0].location.s3_location.uri #=> String
|
3563
3742
|
# resp.citations[0].retrieved_references[0].location.salesforce_location.url #=> String
|
3564
3743
|
# resp.citations[0].retrieved_references[0].location.share_point_location.url #=> String
|
3565
|
-
# resp.citations[0].retrieved_references[0].location.
|
3744
|
+
# resp.citations[0].retrieved_references[0].location.sql_location.query #=> String
|
3745
|
+
# resp.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
3566
3746
|
# resp.citations[0].retrieved_references[0].location.web_location.url #=> String
|
3567
3747
|
# resp.citations[0].retrieved_references[0].metadata #=> Hash
|
3568
3748
|
# resp.guardrail_action #=> String, one of "INTERVENED", "NONE"
|
@@ -3820,6 +4000,9 @@ module Aws::BedrockAgentRuntime
|
|
3820
4000
|
# top_p: 1.0,
|
3821
4001
|
# },
|
3822
4002
|
# },
|
4003
|
+
# performance_config: {
|
4004
|
+
# latency: "standard", # accepts standard, optimized
|
4005
|
+
# },
|
3823
4006
|
# prompt_template: {
|
3824
4007
|
# text_prompt_template: "TextPromptTemplate",
|
3825
4008
|
# },
|
@@ -3857,6 +4040,9 @@ module Aws::BedrockAgentRuntime
|
|
3857
4040
|
# top_p: 1.0,
|
3858
4041
|
# },
|
3859
4042
|
# },
|
4043
|
+
# performance_config: {
|
4044
|
+
# latency: "standard", # accepts standard, optimized
|
4045
|
+
# },
|
3860
4046
|
# prompt_template: {
|
3861
4047
|
# text_prompt_template: "TextPromptTemplate",
|
3862
4048
|
# },
|
@@ -3876,6 +4062,9 @@ module Aws::BedrockAgentRuntime
|
|
3876
4062
|
# top_p: 1.0,
|
3877
4063
|
# },
|
3878
4064
|
# },
|
4065
|
+
# performance_config: {
|
4066
|
+
# latency: "standard", # accepts standard, optimized
|
4067
|
+
# },
|
3879
4068
|
# prompt_template: {
|
3880
4069
|
# text_prompt_template: "TextPromptTemplate",
|
3881
4070
|
# },
|
@@ -4022,13 +4211,21 @@ module Aws::BedrockAgentRuntime
|
|
4022
4211
|
# event.citation.generated_response_part.text_response_part.span.start #=> Integer
|
4023
4212
|
# event.citation.generated_response_part.text_response_part.text #=> String
|
4024
4213
|
# event.citation.retrieved_references #=> Array
|
4214
|
+
# event.citation.retrieved_references[0].content.byte_content #=> String
|
4215
|
+
# event.citation.retrieved_references[0].content.row #=> Array
|
4216
|
+
# event.citation.retrieved_references[0].content.row[0].column_name #=> String
|
4217
|
+
# event.citation.retrieved_references[0].content.row[0].column_value #=> String
|
4218
|
+
# event.citation.retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
|
4025
4219
|
# event.citation.retrieved_references[0].content.text #=> String
|
4220
|
+
# event.citation.retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
|
4026
4221
|
# event.citation.retrieved_references[0].location.confluence_location.url #=> String
|
4027
4222
|
# event.citation.retrieved_references[0].location.custom_document_location.id #=> String
|
4223
|
+
# event.citation.retrieved_references[0].location.kendra_document_location.uri #=> String
|
4028
4224
|
# event.citation.retrieved_references[0].location.s3_location.uri #=> String
|
4029
4225
|
# event.citation.retrieved_references[0].location.salesforce_location.url #=> String
|
4030
4226
|
# event.citation.retrieved_references[0].location.share_point_location.url #=> String
|
4031
|
-
# event.citation.retrieved_references[0].location.
|
4227
|
+
# event.citation.retrieved_references[0].location.sql_location.query #=> String
|
4228
|
+
# event.citation.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
|
4032
4229
|
# event.citation.retrieved_references[0].location.web_location.url #=> String
|
4033
4230
|
# event.citation.retrieved_references[0].metadata #=> Hash
|
4034
4231
|
#
|
@@ -4105,7 +4302,7 @@ module Aws::BedrockAgentRuntime
|
|
4105
4302
|
tracer: tracer
|
4106
4303
|
)
|
4107
4304
|
context[:gem_name] = 'aws-sdk-bedrockagentruntime'
|
4108
|
-
context[:gem_version] = '1.
|
4305
|
+
context[:gem_version] = '1.38.0'
|
4109
4306
|
Seahorse::Client::Request.new(handlers, context)
|
4110
4307
|
end
|
4111
4308
|
|