aws-sdk-bedrockruntime 1.63.0 → 1.71.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +40 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockruntime/async_client.rb +1 -1
- data/lib/aws-sdk-bedrockruntime/client.rb +274 -7
- data/lib/aws-sdk-bedrockruntime/client_api.rb +105 -4
- data/lib/aws-sdk-bedrockruntime/types.rb +390 -10
- data/lib/aws-sdk-bedrockruntime.rb +17 -1
- data/sig/client.rbs +203 -14
- data/sig/types.rbs +108 -2
- metadata +3 -3
|
@@ -43,6 +43,46 @@ module Aws::BedrockRuntime
|
|
|
43
43
|
#
|
|
44
44
|
class AnyToolChoice < Aws::EmptyStructure; end
|
|
45
45
|
|
|
46
|
+
# Details about the specific guardrail that was applied during this
|
|
47
|
+
# assessment, including its identifier, version, ARN, origin, and
|
|
48
|
+
# ownership information.
|
|
49
|
+
#
|
|
50
|
+
# @!attribute [rw] guardrail_id
|
|
51
|
+
# The unique ID of the guardrail that was applied.
|
|
52
|
+
# @return [String]
|
|
53
|
+
#
|
|
54
|
+
# @!attribute [rw] guardrail_version
|
|
55
|
+
# The version of the guardrail that was applied.
|
|
56
|
+
# @return [String]
|
|
57
|
+
#
|
|
58
|
+
# @!attribute [rw] guardrail_arn
|
|
59
|
+
# The ARN of the guardrail that was applied.
|
|
60
|
+
# @return [String]
|
|
61
|
+
#
|
|
62
|
+
# @!attribute [rw] guardrail_origin
|
|
63
|
+
# The origin of how the guardrail was applied. This can be either
|
|
64
|
+
# requested at the API level or enforced at the account or
|
|
65
|
+
# organization level as a default guardrail.
|
|
66
|
+
# @return [Array<String>]
|
|
67
|
+
#
|
|
68
|
+
# @!attribute [rw] guardrail_ownership
|
|
69
|
+
# The ownership type of the guardrail, indicating whether it is owned
|
|
70
|
+
# by the requesting account or is a cross-account guardrail shared
|
|
71
|
+
# from another AWS account.
|
|
72
|
+
# @return [String]
|
|
73
|
+
#
|
|
74
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/AppliedGuardrailDetails AWS API Documentation
|
|
75
|
+
#
|
|
76
|
+
class AppliedGuardrailDetails < Struct.new(
|
|
77
|
+
:guardrail_id,
|
|
78
|
+
:guardrail_version,
|
|
79
|
+
:guardrail_arn,
|
|
80
|
+
:guardrail_origin,
|
|
81
|
+
:guardrail_ownership)
|
|
82
|
+
SENSITIVE = []
|
|
83
|
+
include Aws::Structure
|
|
84
|
+
end
|
|
85
|
+
|
|
46
86
|
# @!attribute [rw] guardrail_identifier
|
|
47
87
|
# The guardrail identifier used in the request to apply the guardrail.
|
|
48
88
|
# @return [String]
|
|
@@ -221,6 +261,70 @@ module Aws::BedrockRuntime
|
|
|
221
261
|
include Aws::Structure
|
|
222
262
|
end
|
|
223
263
|
|
|
264
|
+
# An audio content block that contains audio data in various supported
|
|
265
|
+
# formats.
|
|
266
|
+
#
|
|
267
|
+
# @!attribute [rw] format
|
|
268
|
+
# The format of the audio data, such as MP3, WAV, FLAC, or other
|
|
269
|
+
# supported audio formats.
|
|
270
|
+
# @return [String]
|
|
271
|
+
#
|
|
272
|
+
# @!attribute [rw] source
|
|
273
|
+
# The source of the audio data, which can be provided as raw bytes or
|
|
274
|
+
# an S3 location.
|
|
275
|
+
# @return [Types::AudioSource]
|
|
276
|
+
#
|
|
277
|
+
# @!attribute [rw] error
|
|
278
|
+
# Error information if the audio block could not be processed or
|
|
279
|
+
# contains invalid data.
|
|
280
|
+
# @return [Types::ErrorBlock]
|
|
281
|
+
#
|
|
282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/AudioBlock AWS API Documentation
|
|
283
|
+
#
|
|
284
|
+
class AudioBlock < Struct.new(
|
|
285
|
+
:format,
|
|
286
|
+
:source,
|
|
287
|
+
:error)
|
|
288
|
+
SENSITIVE = [:source, :error]
|
|
289
|
+
include Aws::Structure
|
|
290
|
+
end
|
|
291
|
+
|
|
292
|
+
# The source of audio data, which can be provided either as raw bytes or
|
|
293
|
+
# a reference to an S3 location.
|
|
294
|
+
#
|
|
295
|
+
# @note AudioSource is a union - when making an API calls you must set exactly one of the members.
|
|
296
|
+
#
|
|
297
|
+
# @note AudioSource is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of AudioSource corresponding to the set member.
|
|
298
|
+
#
|
|
299
|
+
# @!attribute [rw] bytes
|
|
300
|
+
# Audio data encoded in base64.
|
|
301
|
+
# @return [String]
|
|
302
|
+
#
|
|
303
|
+
# @!attribute [rw] s3_location
|
|
304
|
+
# A reference to audio data stored in an Amazon S3 bucket. To see
|
|
305
|
+
# which models support S3 uploads, see [Supported models and features
|
|
306
|
+
# for Converse][1].
|
|
307
|
+
#
|
|
308
|
+
#
|
|
309
|
+
#
|
|
310
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-supported-models-features.html
|
|
311
|
+
# @return [Types::S3Location]
|
|
312
|
+
#
|
|
313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/AudioSource AWS API Documentation
|
|
314
|
+
#
|
|
315
|
+
class AudioSource < Struct.new(
|
|
316
|
+
:bytes,
|
|
317
|
+
:s3_location,
|
|
318
|
+
:unknown)
|
|
319
|
+
SENSITIVE = []
|
|
320
|
+
include Aws::Structure
|
|
321
|
+
include Aws::Structure::Union
|
|
322
|
+
|
|
323
|
+
class Bytes < AudioSource; end
|
|
324
|
+
class S3Location < AudioSource; end
|
|
325
|
+
class Unknown < AudioSource; end
|
|
326
|
+
end
|
|
327
|
+
|
|
224
328
|
# The Model automatically decides if a tool should be called or whether
|
|
225
329
|
# to generate text instead. For example, `{"auto" : {}}`. For more
|
|
226
330
|
# information, see [Call a tool with the Converse API][1] in the Amazon
|
|
@@ -292,6 +396,11 @@ module Aws::BedrockRuntime
|
|
|
292
396
|
# The title or identifier of the source document being cited.
|
|
293
397
|
# @return [String]
|
|
294
398
|
#
|
|
399
|
+
# @!attribute [rw] source
|
|
400
|
+
# The source from the original search result that provided the cited
|
|
401
|
+
# content.
|
|
402
|
+
# @return [String]
|
|
403
|
+
#
|
|
295
404
|
# @!attribute [rw] source_content
|
|
296
405
|
# The specific content from the source document that was referenced or
|
|
297
406
|
# cited in the generated response.
|
|
@@ -307,6 +416,7 @@ module Aws::BedrockRuntime
|
|
|
307
416
|
#
|
|
308
417
|
class Citation < Struct.new(
|
|
309
418
|
:title,
|
|
419
|
+
:source,
|
|
310
420
|
:source_content,
|
|
311
421
|
:location)
|
|
312
422
|
SENSITIVE = []
|
|
@@ -367,6 +477,12 @@ module Aws::BedrockRuntime
|
|
|
367
477
|
# logical chunks.
|
|
368
478
|
# @return [Types::DocumentChunkLocation]
|
|
369
479
|
#
|
|
480
|
+
# @!attribute [rw] search_result_location
|
|
481
|
+
# The search result location where the cited content is found,
|
|
482
|
+
# including the search result index and block positions within the
|
|
483
|
+
# content array.
|
|
484
|
+
# @return [Types::SearchResultLocation]
|
|
485
|
+
#
|
|
370
486
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/CitationLocation AWS API Documentation
|
|
371
487
|
#
|
|
372
488
|
class CitationLocation < Struct.new(
|
|
@@ -374,6 +490,7 @@ module Aws::BedrockRuntime
|
|
|
374
490
|
:document_char,
|
|
375
491
|
:document_page,
|
|
376
492
|
:document_chunk,
|
|
493
|
+
:search_result_location,
|
|
377
494
|
:unknown)
|
|
378
495
|
SENSITIVE = []
|
|
379
496
|
include Aws::Structure
|
|
@@ -383,6 +500,7 @@ module Aws::BedrockRuntime
|
|
|
383
500
|
class DocumentChar < CitationLocation; end
|
|
384
501
|
class DocumentPage < CitationLocation; end
|
|
385
502
|
class DocumentChunk < CitationLocation; end
|
|
503
|
+
class SearchResultLocation < CitationLocation; end
|
|
386
504
|
class Unknown < CitationLocation; end
|
|
387
505
|
end
|
|
388
506
|
|
|
@@ -478,6 +596,11 @@ module Aws::BedrockRuntime
|
|
|
478
596
|
# The title or identifier of the source document being cited.
|
|
479
597
|
# @return [String]
|
|
480
598
|
#
|
|
599
|
+
# @!attribute [rw] source
|
|
600
|
+
# The source from the original search result that provided the cited
|
|
601
|
+
# content.
|
|
602
|
+
# @return [String]
|
|
603
|
+
#
|
|
481
604
|
# @!attribute [rw] source_content
|
|
482
605
|
# The specific content from the source document that was referenced or
|
|
483
606
|
# cited in the generated response.
|
|
@@ -494,6 +617,7 @@ module Aws::BedrockRuntime
|
|
|
494
617
|
#
|
|
495
618
|
class CitationsDelta < Struct.new(
|
|
496
619
|
:title,
|
|
620
|
+
:source,
|
|
497
621
|
:source_content,
|
|
498
622
|
:location)
|
|
499
623
|
SENSITIVE = []
|
|
@@ -545,6 +669,10 @@ module Aws::BedrockRuntime
|
|
|
545
669
|
# Video to include in the message.
|
|
546
670
|
# @return [Types::VideoBlock]
|
|
547
671
|
#
|
|
672
|
+
# @!attribute [rw] audio
|
|
673
|
+
# An audio content block containing audio data in the conversation.
|
|
674
|
+
# @return [Types::AudioBlock]
|
|
675
|
+
#
|
|
548
676
|
# @!attribute [rw] tool_use
|
|
549
677
|
# Information about a tool use request from a model.
|
|
550
678
|
# @return [Types::ToolUseBlock]
|
|
@@ -578,6 +706,10 @@ module Aws::BedrockRuntime
|
|
|
578
706
|
# and source documents.
|
|
579
707
|
# @return [Types::CitationsContentBlock]
|
|
580
708
|
#
|
|
709
|
+
# @!attribute [rw] search_result
|
|
710
|
+
# Search result to include in the message.
|
|
711
|
+
# @return [Types::SearchResultBlock]
|
|
712
|
+
#
|
|
581
713
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ContentBlock AWS API Documentation
|
|
582
714
|
#
|
|
583
715
|
class ContentBlock < Struct.new(
|
|
@@ -585,12 +717,14 @@ module Aws::BedrockRuntime
|
|
|
585
717
|
:image,
|
|
586
718
|
:document,
|
|
587
719
|
:video,
|
|
720
|
+
:audio,
|
|
588
721
|
:tool_use,
|
|
589
722
|
:tool_result,
|
|
590
723
|
:guard_content,
|
|
591
724
|
:cache_point,
|
|
592
725
|
:reasoning_content,
|
|
593
726
|
:citations_content,
|
|
727
|
+
:search_result,
|
|
594
728
|
:unknown)
|
|
595
729
|
SENSITIVE = [:reasoning_content]
|
|
596
730
|
include Aws::Structure
|
|
@@ -600,12 +734,14 @@ module Aws::BedrockRuntime
|
|
|
600
734
|
class Image < ContentBlock; end
|
|
601
735
|
class Document < ContentBlock; end
|
|
602
736
|
class Video < ContentBlock; end
|
|
737
|
+
class Audio < ContentBlock; end
|
|
603
738
|
class ToolUse < ContentBlock; end
|
|
604
739
|
class ToolResult < ContentBlock; end
|
|
605
740
|
class GuardContent < ContentBlock; end
|
|
606
741
|
class CachePoint < ContentBlock; end
|
|
607
742
|
class ReasoningContent < ContentBlock; end
|
|
608
743
|
class CitationsContent < ContentBlock; end
|
|
744
|
+
class SearchResult < ContentBlock; end
|
|
609
745
|
class Unknown < ContentBlock; end
|
|
610
746
|
end
|
|
611
747
|
|
|
@@ -636,6 +772,10 @@ module Aws::BedrockRuntime
|
|
|
636
772
|
# response generation process.
|
|
637
773
|
# @return [Types::CitationsDelta]
|
|
638
774
|
#
|
|
775
|
+
# @!attribute [rw] image
|
|
776
|
+
# A streaming delta event containing incremental image data.
|
|
777
|
+
# @return [Types::ImageBlockDelta]
|
|
778
|
+
#
|
|
639
779
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ContentBlockDelta AWS API Documentation
|
|
640
780
|
#
|
|
641
781
|
class ContentBlockDelta < Struct.new(
|
|
@@ -644,6 +784,7 @@ module Aws::BedrockRuntime
|
|
|
644
784
|
:tool_result,
|
|
645
785
|
:reasoning_content,
|
|
646
786
|
:citation,
|
|
787
|
+
:image,
|
|
647
788
|
:unknown)
|
|
648
789
|
SENSITIVE = [:reasoning_content]
|
|
649
790
|
include Aws::Structure
|
|
@@ -654,6 +795,7 @@ module Aws::BedrockRuntime
|
|
|
654
795
|
class ToolResult < ContentBlockDelta; end
|
|
655
796
|
class ReasoningContent < ContentBlockDelta; end
|
|
656
797
|
class Citation < ContentBlockDelta; end
|
|
798
|
+
class Image < ContentBlockDelta; end
|
|
657
799
|
class Unknown < ContentBlockDelta; end
|
|
658
800
|
end
|
|
659
801
|
|
|
@@ -689,11 +831,16 @@ module Aws::BedrockRuntime
|
|
|
689
831
|
# The
|
|
690
832
|
# @return [Types::ToolResultBlockStart]
|
|
691
833
|
#
|
|
834
|
+
# @!attribute [rw] image
|
|
835
|
+
# The initial event indicating the start of a streaming image block.
|
|
836
|
+
# @return [Types::ImageBlockStart]
|
|
837
|
+
#
|
|
692
838
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ContentBlockStart AWS API Documentation
|
|
693
839
|
#
|
|
694
840
|
class ContentBlockStart < Struct.new(
|
|
695
841
|
:tool_use,
|
|
696
842
|
:tool_result,
|
|
843
|
+
:image,
|
|
697
844
|
:unknown)
|
|
698
845
|
SENSITIVE = []
|
|
699
846
|
include Aws::Structure
|
|
@@ -701,6 +848,7 @@ module Aws::BedrockRuntime
|
|
|
701
848
|
|
|
702
849
|
class ToolUse < ContentBlockStart; end
|
|
703
850
|
class ToolResult < ContentBlockStart; end
|
|
851
|
+
class Image < ContentBlockStart; end
|
|
704
852
|
class Unknown < ContentBlockStart; end
|
|
705
853
|
end
|
|
706
854
|
|
|
@@ -906,6 +1054,11 @@ module Aws::BedrockRuntime
|
|
|
906
1054
|
# Model performance settings for the request.
|
|
907
1055
|
# @return [Types::PerformanceConfiguration]
|
|
908
1056
|
#
|
|
1057
|
+
# @!attribute [rw] service_tier
|
|
1058
|
+
# Specifies the processing tier configuration used for serving the
|
|
1059
|
+
# request.
|
|
1060
|
+
# @return [Types::ServiceTier]
|
|
1061
|
+
#
|
|
909
1062
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseRequest AWS API Documentation
|
|
910
1063
|
#
|
|
911
1064
|
class ConverseRequest < Struct.new(
|
|
@@ -919,7 +1072,8 @@ module Aws::BedrockRuntime
|
|
|
919
1072
|
:prompt_variables,
|
|
920
1073
|
:additional_model_response_field_paths,
|
|
921
1074
|
:request_metadata,
|
|
922
|
-
:performance_config
|
|
1075
|
+
:performance_config,
|
|
1076
|
+
:service_tier)
|
|
923
1077
|
SENSITIVE = [:prompt_variables, :request_metadata]
|
|
924
1078
|
include Aws::Structure
|
|
925
1079
|
end
|
|
@@ -955,6 +1109,11 @@ module Aws::BedrockRuntime
|
|
|
955
1109
|
# Model performance settings for the request.
|
|
956
1110
|
# @return [Types::PerformanceConfiguration]
|
|
957
1111
|
#
|
|
1112
|
+
# @!attribute [rw] service_tier
|
|
1113
|
+
# Specifies the processing tier configuration used for serving the
|
|
1114
|
+
# request.
|
|
1115
|
+
# @return [Types::ServiceTier]
|
|
1116
|
+
#
|
|
958
1117
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseResponse AWS API Documentation
|
|
959
1118
|
#
|
|
960
1119
|
class ConverseResponse < Struct.new(
|
|
@@ -964,7 +1123,8 @@ module Aws::BedrockRuntime
|
|
|
964
1123
|
:metrics,
|
|
965
1124
|
:additional_model_response_fields,
|
|
966
1125
|
:trace,
|
|
967
|
-
:performance_config
|
|
1126
|
+
:performance_config,
|
|
1127
|
+
:service_tier)
|
|
968
1128
|
SENSITIVE = []
|
|
969
1129
|
include Aws::Structure
|
|
970
1130
|
end
|
|
@@ -993,6 +1153,11 @@ module Aws::BedrockRuntime
|
|
|
993
1153
|
# event.
|
|
994
1154
|
# @return [Types::PerformanceConfiguration]
|
|
995
1155
|
#
|
|
1156
|
+
# @!attribute [rw] service_tier
|
|
1157
|
+
# Specifies the processing tier configuration used for serving the
|
|
1158
|
+
# request.
|
|
1159
|
+
# @return [Types::ServiceTier]
|
|
1160
|
+
#
|
|
996
1161
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseStreamMetadataEvent AWS API Documentation
|
|
997
1162
|
#
|
|
998
1163
|
class ConverseStreamMetadataEvent < Struct.new(
|
|
@@ -1000,6 +1165,7 @@ module Aws::BedrockRuntime
|
|
|
1000
1165
|
:metrics,
|
|
1001
1166
|
:trace,
|
|
1002
1167
|
:performance_config,
|
|
1168
|
+
:service_tier,
|
|
1003
1169
|
:event_type)
|
|
1004
1170
|
SENSITIVE = []
|
|
1005
1171
|
include Aws::Structure
|
|
@@ -1143,6 +1309,11 @@ module Aws::BedrockRuntime
|
|
|
1143
1309
|
# Model performance settings for the request.
|
|
1144
1310
|
# @return [Types::PerformanceConfiguration]
|
|
1145
1311
|
#
|
|
1312
|
+
# @!attribute [rw] service_tier
|
|
1313
|
+
# Specifies the processing tier configuration used for serving the
|
|
1314
|
+
# request.
|
|
1315
|
+
# @return [Types::ServiceTier]
|
|
1316
|
+
#
|
|
1146
1317
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseStreamRequest AWS API Documentation
|
|
1147
1318
|
#
|
|
1148
1319
|
class ConverseStreamRequest < Struct.new(
|
|
@@ -1156,7 +1327,8 @@ module Aws::BedrockRuntime
|
|
|
1156
1327
|
:prompt_variables,
|
|
1157
1328
|
:additional_model_response_field_paths,
|
|
1158
1329
|
:request_metadata,
|
|
1159
|
-
:performance_config
|
|
1330
|
+
:performance_config,
|
|
1331
|
+
:service_tier)
|
|
1160
1332
|
SENSITIVE = [:prompt_variables, :request_metadata]
|
|
1161
1333
|
include Aws::Structure
|
|
1162
1334
|
end
|
|
@@ -1213,11 +1385,25 @@ module Aws::BedrockRuntime
|
|
|
1213
1385
|
# provided.
|
|
1214
1386
|
# @return [Array<Types::SystemContentBlock>]
|
|
1215
1387
|
#
|
|
1388
|
+
# @!attribute [rw] tool_config
|
|
1389
|
+
# The toolConfig of Converse input request to count tokens for.
|
|
1390
|
+
# Configuration information for the tools that the model can use when
|
|
1391
|
+
# generating a response.
|
|
1392
|
+
# @return [Types::ToolConfiguration]
|
|
1393
|
+
#
|
|
1394
|
+
# @!attribute [rw] additional_model_request_fields
|
|
1395
|
+
# The additionalModelRequestFields of Converse input request to count
|
|
1396
|
+
# tokens for. Use this field when you want to pass additional
|
|
1397
|
+
# parameters that the model supports.
|
|
1398
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
1399
|
+
#
|
|
1216
1400
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseTokensRequest AWS API Documentation
|
|
1217
1401
|
#
|
|
1218
1402
|
class ConverseTokensRequest < Struct.new(
|
|
1219
1403
|
:messages,
|
|
1220
|
-
:system
|
|
1404
|
+
:system,
|
|
1405
|
+
:tool_config,
|
|
1406
|
+
:additional_model_request_fields)
|
|
1221
1407
|
SENSITIVE = []
|
|
1222
1408
|
include Aws::Structure
|
|
1223
1409
|
end
|
|
@@ -1535,6 +1721,21 @@ module Aws::BedrockRuntime
|
|
|
1535
1721
|
class Unknown < DocumentSource; end
|
|
1536
1722
|
end
|
|
1537
1723
|
|
|
1724
|
+
# A block containing error information when content processing fails.
|
|
1725
|
+
#
|
|
1726
|
+
# @!attribute [rw] message
|
|
1727
|
+
# A human-readable error message describing what went wrong during
|
|
1728
|
+
# content processing.
|
|
1729
|
+
# @return [String]
|
|
1730
|
+
#
|
|
1731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ErrorBlock AWS API Documentation
|
|
1732
|
+
#
|
|
1733
|
+
class ErrorBlock < Struct.new(
|
|
1734
|
+
:message)
|
|
1735
|
+
SENSITIVE = []
|
|
1736
|
+
include Aws::Structure
|
|
1737
|
+
end
|
|
1738
|
+
|
|
1538
1739
|
# @!attribute [rw] invocation_arn
|
|
1539
1740
|
# The invocation's ARN.
|
|
1540
1741
|
# @return [String]
|
|
@@ -1631,6 +1832,12 @@ module Aws::BedrockRuntime
|
|
|
1631
1832
|
# The invocation metrics for the guardrail assessment.
|
|
1632
1833
|
# @return [Types::GuardrailInvocationMetrics]
|
|
1633
1834
|
#
|
|
1835
|
+
# @!attribute [rw] applied_guardrail_details
|
|
1836
|
+
# Details about the specific guardrail that was applied during this
|
|
1837
|
+
# assessment, including its identifier, version, ARN, origin, and
|
|
1838
|
+
# ownership information.
|
|
1839
|
+
# @return [Types::AppliedGuardrailDetails]
|
|
1840
|
+
#
|
|
1634
1841
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/GuardrailAssessment AWS API Documentation
|
|
1635
1842
|
#
|
|
1636
1843
|
class GuardrailAssessment < Struct.new(
|
|
@@ -1640,7 +1847,8 @@ module Aws::BedrockRuntime
|
|
|
1640
1847
|
:sensitive_information_policy,
|
|
1641
1848
|
:contextual_grounding_policy,
|
|
1642
1849
|
:automated_reasoning_policy,
|
|
1643
|
-
:invocation_metrics
|
|
1850
|
+
:invocation_metrics,
|
|
1851
|
+
:applied_guardrail_details)
|
|
1644
1852
|
SENSITIVE = []
|
|
1645
1853
|
include Aws::Structure
|
|
1646
1854
|
end
|
|
@@ -2819,11 +3027,53 @@ module Aws::BedrockRuntime
|
|
|
2819
3027
|
# The source for the image.
|
|
2820
3028
|
# @return [Types::ImageSource]
|
|
2821
3029
|
#
|
|
3030
|
+
# @!attribute [rw] error
|
|
3031
|
+
# Error information if the image block could not be processed or
|
|
3032
|
+
# contains invalid data.
|
|
3033
|
+
# @return [Types::ErrorBlock]
|
|
3034
|
+
#
|
|
2822
3035
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ImageBlock AWS API Documentation
|
|
2823
3036
|
#
|
|
2824
3037
|
class ImageBlock < Struct.new(
|
|
2825
3038
|
:format,
|
|
2826
|
-
:source
|
|
3039
|
+
:source,
|
|
3040
|
+
:error)
|
|
3041
|
+
SENSITIVE = [:source, :error]
|
|
3042
|
+
include Aws::Structure
|
|
3043
|
+
end
|
|
3044
|
+
|
|
3045
|
+
# A streaming delta event that contains incremental image data during
|
|
3046
|
+
# streaming responses.
|
|
3047
|
+
#
|
|
3048
|
+
# @!attribute [rw] source
|
|
3049
|
+
# The incremental image source data for this delta event.
|
|
3050
|
+
# @return [Types::ImageSource]
|
|
3051
|
+
#
|
|
3052
|
+
# @!attribute [rw] error
|
|
3053
|
+
# Error information if this image delta could not be processed.
|
|
3054
|
+
# @return [Types::ErrorBlock]
|
|
3055
|
+
#
|
|
3056
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ImageBlockDelta AWS API Documentation
|
|
3057
|
+
#
|
|
3058
|
+
class ImageBlockDelta < Struct.new(
|
|
3059
|
+
:source,
|
|
3060
|
+
:error)
|
|
3061
|
+
SENSITIVE = [:source, :error]
|
|
3062
|
+
include Aws::Structure
|
|
3063
|
+
end
|
|
3064
|
+
|
|
3065
|
+
# The initial event in a streaming image block that indicates the start
|
|
3066
|
+
# of image content.
|
|
3067
|
+
#
|
|
3068
|
+
# @!attribute [rw] format
|
|
3069
|
+
# The format of the image data that will be streamed in subsequent
|
|
3070
|
+
# delta events.
|
|
3071
|
+
# @return [String]
|
|
3072
|
+
#
|
|
3073
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ImageBlockStart AWS API Documentation
|
|
3074
|
+
#
|
|
3075
|
+
class ImageBlockStart < Struct.new(
|
|
3076
|
+
:format)
|
|
2827
3077
|
SENSITIVE = []
|
|
2828
3078
|
include Aws::Structure
|
|
2829
3079
|
end
|
|
@@ -3047,6 +3297,10 @@ module Aws::BedrockRuntime
|
|
|
3047
3297
|
# Model performance settings for the request.
|
|
3048
3298
|
# @return [String]
|
|
3049
3299
|
#
|
|
3300
|
+
# @!attribute [rw] service_tier
|
|
3301
|
+
# Specifies the processing tier type used for serving the request.
|
|
3302
|
+
# @return [String]
|
|
3303
|
+
#
|
|
3050
3304
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/InvokeModelRequest AWS API Documentation
|
|
3051
3305
|
#
|
|
3052
3306
|
class InvokeModelRequest < Struct.new(
|
|
@@ -3057,7 +3311,8 @@ module Aws::BedrockRuntime
|
|
|
3057
3311
|
:trace,
|
|
3058
3312
|
:guardrail_identifier,
|
|
3059
3313
|
:guardrail_version,
|
|
3060
|
-
:performance_config_latency
|
|
3314
|
+
:performance_config_latency,
|
|
3315
|
+
:service_tier)
|
|
3061
3316
|
SENSITIVE = [:body]
|
|
3062
3317
|
include Aws::Structure
|
|
3063
3318
|
end
|
|
@@ -3081,12 +3336,17 @@ module Aws::BedrockRuntime
|
|
|
3081
3336
|
# Model performance settings for the request.
|
|
3082
3337
|
# @return [String]
|
|
3083
3338
|
#
|
|
3339
|
+
# @!attribute [rw] service_tier
|
|
3340
|
+
# Specifies the processing tier type used for serving the request.
|
|
3341
|
+
# @return [String]
|
|
3342
|
+
#
|
|
3084
3343
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/InvokeModelResponse AWS API Documentation
|
|
3085
3344
|
#
|
|
3086
3345
|
class InvokeModelResponse < Struct.new(
|
|
3087
3346
|
:body,
|
|
3088
3347
|
:content_type,
|
|
3089
|
-
:performance_config_latency
|
|
3348
|
+
:performance_config_latency,
|
|
3349
|
+
:service_tier)
|
|
3090
3350
|
SENSITIVE = [:body]
|
|
3091
3351
|
include Aws::Structure
|
|
3092
3352
|
end
|
|
@@ -3246,6 +3506,10 @@ module Aws::BedrockRuntime
|
|
|
3246
3506
|
# Model performance settings for the request.
|
|
3247
3507
|
# @return [String]
|
|
3248
3508
|
#
|
|
3509
|
+
# @!attribute [rw] service_tier
|
|
3510
|
+
# Specifies the processing tier type used for serving the request.
|
|
3511
|
+
# @return [String]
|
|
3512
|
+
#
|
|
3249
3513
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/InvokeModelWithResponseStreamRequest AWS API Documentation
|
|
3250
3514
|
#
|
|
3251
3515
|
class InvokeModelWithResponseStreamRequest < Struct.new(
|
|
@@ -3256,7 +3520,8 @@ module Aws::BedrockRuntime
|
|
|
3256
3520
|
:trace,
|
|
3257
3521
|
:guardrail_identifier,
|
|
3258
3522
|
:guardrail_version,
|
|
3259
|
-
:performance_config_latency
|
|
3523
|
+
:performance_config_latency,
|
|
3524
|
+
:service_tier)
|
|
3260
3525
|
SENSITIVE = [:body]
|
|
3261
3526
|
include Aws::Structure
|
|
3262
3527
|
end
|
|
@@ -3279,12 +3544,17 @@ module Aws::BedrockRuntime
|
|
|
3279
3544
|
# Model performance settings for the request.
|
|
3280
3545
|
# @return [String]
|
|
3281
3546
|
#
|
|
3547
|
+
# @!attribute [rw] service_tier
|
|
3548
|
+
# Specifies the processing tier type used for serving the request.
|
|
3549
|
+
# @return [String]
|
|
3550
|
+
#
|
|
3282
3551
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/InvokeModelWithResponseStreamResponse AWS API Documentation
|
|
3283
3552
|
#
|
|
3284
3553
|
class InvokeModelWithResponseStreamResponse < Struct.new(
|
|
3285
3554
|
:body,
|
|
3286
3555
|
:content_type,
|
|
3287
|
-
:performance_config_latency
|
|
3556
|
+
:performance_config_latency,
|
|
3557
|
+
:service_tier)
|
|
3288
3558
|
SENSITIVE = []
|
|
3289
3559
|
include Aws::Structure
|
|
3290
3560
|
end
|
|
@@ -3708,6 +3978,84 @@ module Aws::BedrockRuntime
|
|
|
3708
3978
|
include Aws::Structure
|
|
3709
3979
|
end
|
|
3710
3980
|
|
|
3981
|
+
# A search result block that enables natural citations with proper
|
|
3982
|
+
# source attribution for retrieved content.
|
|
3983
|
+
#
|
|
3984
|
+
# <note markdown="1"> This field is only supported by Anthropic Claude Opus 4.1, Opus 4,
|
|
3985
|
+
# Sonnet 4.5, Sonnet 4, Sonnet 3.7, and 3.5 Haiku models.
|
|
3986
|
+
#
|
|
3987
|
+
# </note>
|
|
3988
|
+
#
|
|
3989
|
+
# @!attribute [rw] source
|
|
3990
|
+
# The source URL or identifier for the content.
|
|
3991
|
+
# @return [String]
|
|
3992
|
+
#
|
|
3993
|
+
# @!attribute [rw] title
|
|
3994
|
+
# A descriptive title for the search result.
|
|
3995
|
+
# @return [String]
|
|
3996
|
+
#
|
|
3997
|
+
# @!attribute [rw] content
|
|
3998
|
+
# An array of search result content block.
|
|
3999
|
+
# @return [Array<Types::SearchResultContentBlock>]
|
|
4000
|
+
#
|
|
4001
|
+
# @!attribute [rw] citations
|
|
4002
|
+
# Configuration setting for citations
|
|
4003
|
+
# @return [Types::CitationsConfig]
|
|
4004
|
+
#
|
|
4005
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/SearchResultBlock AWS API Documentation
|
|
4006
|
+
#
|
|
4007
|
+
class SearchResultBlock < Struct.new(
|
|
4008
|
+
:source,
|
|
4009
|
+
:title,
|
|
4010
|
+
:content,
|
|
4011
|
+
:citations)
|
|
4012
|
+
SENSITIVE = []
|
|
4013
|
+
include Aws::Structure
|
|
4014
|
+
end
|
|
4015
|
+
|
|
4016
|
+
# A block within a search result that contains the content.
|
|
4017
|
+
#
|
|
4018
|
+
# @!attribute [rw] text
|
|
4019
|
+
# The actual text content
|
|
4020
|
+
# @return [String]
|
|
4021
|
+
#
|
|
4022
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/SearchResultContentBlock AWS API Documentation
|
|
4023
|
+
#
|
|
4024
|
+
class SearchResultContentBlock < Struct.new(
|
|
4025
|
+
:text)
|
|
4026
|
+
SENSITIVE = []
|
|
4027
|
+
include Aws::Structure
|
|
4028
|
+
end
|
|
4029
|
+
|
|
4030
|
+
# Specifies a search result location within the content array, providing
|
|
4031
|
+
# positioning information for cited content using search result index
|
|
4032
|
+
# and block positions.
|
|
4033
|
+
#
|
|
4034
|
+
# @!attribute [rw] search_result_index
|
|
4035
|
+
# The index of the search result content block where the cited content
|
|
4036
|
+
# is found.
|
|
4037
|
+
# @return [Integer]
|
|
4038
|
+
#
|
|
4039
|
+
# @!attribute [rw] start
|
|
4040
|
+
# The starting position in the content array where the cited content
|
|
4041
|
+
# begins.
|
|
4042
|
+
# @return [Integer]
|
|
4043
|
+
#
|
|
4044
|
+
# @!attribute [rw] end
|
|
4045
|
+
# The ending position in the content array where the cited content
|
|
4046
|
+
# ends.
|
|
4047
|
+
# @return [Integer]
|
|
4048
|
+
#
|
|
4049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/SearchResultLocation AWS API Documentation
|
|
4050
|
+
#
|
|
4051
|
+
class SearchResultLocation < Struct.new(
|
|
4052
|
+
:search_result_index,
|
|
4053
|
+
:start,
|
|
4054
|
+
:end)
|
|
4055
|
+
SENSITIVE = []
|
|
4056
|
+
include Aws::Structure
|
|
4057
|
+
end
|
|
4058
|
+
|
|
3711
4059
|
# Your request exceeds the service quota for your account. You can view
|
|
3712
4060
|
# your quotas at [Viewing service quotas][1]. You can resubmit your
|
|
3713
4061
|
# request later.
|
|
@@ -3727,6 +4075,21 @@ module Aws::BedrockRuntime
|
|
|
3727
4075
|
include Aws::Structure
|
|
3728
4076
|
end
|
|
3729
4077
|
|
|
4078
|
+
# Specifies the processing tier configuration used for serving the
|
|
4079
|
+
# request.
|
|
4080
|
+
#
|
|
4081
|
+
# @!attribute [rw] type
|
|
4082
|
+
# Specifies the processing tier type used for serving the request.
|
|
4083
|
+
# @return [String]
|
|
4084
|
+
#
|
|
4085
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ServiceTier AWS API Documentation
|
|
4086
|
+
#
|
|
4087
|
+
class ServiceTier < Struct.new(
|
|
4088
|
+
:type)
|
|
4089
|
+
SENSITIVE = []
|
|
4090
|
+
include Aws::Structure
|
|
4091
|
+
end
|
|
4092
|
+
|
|
3730
4093
|
# The service isn't currently available. For troubleshooting this
|
|
3731
4094
|
# error, see [ServiceUnavailable][1] in the Amazon Bedrock User Guide
|
|
3732
4095
|
#
|
|
@@ -4140,16 +4503,27 @@ module Aws::BedrockRuntime
|
|
|
4140
4503
|
# The reasoning the model used to return the output.
|
|
4141
4504
|
# @return [String]
|
|
4142
4505
|
#
|
|
4506
|
+
# @!attribute [rw] json
|
|
4507
|
+
# The JSON schema for the tool result content block. see [JSON Schema
|
|
4508
|
+
# Reference][1].
|
|
4509
|
+
#
|
|
4510
|
+
#
|
|
4511
|
+
#
|
|
4512
|
+
# [1]: https://json-schema.org/understanding-json-schema/reference
|
|
4513
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
|
4514
|
+
#
|
|
4143
4515
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ToolResultBlockDelta AWS API Documentation
|
|
4144
4516
|
#
|
|
4145
4517
|
class ToolResultBlockDelta < Struct.new(
|
|
4146
4518
|
:text,
|
|
4519
|
+
:json,
|
|
4147
4520
|
:unknown)
|
|
4148
4521
|
SENSITIVE = []
|
|
4149
4522
|
include Aws::Structure
|
|
4150
4523
|
include Aws::Structure::Union
|
|
4151
4524
|
|
|
4152
4525
|
class Text < ToolResultBlockDelta; end
|
|
4526
|
+
class Json < ToolResultBlockDelta; end
|
|
4153
4527
|
class Unknown < ToolResultBlockDelta; end
|
|
4154
4528
|
end
|
|
4155
4529
|
|
|
@@ -4219,6 +4593,10 @@ module Aws::BedrockRuntime
|
|
|
4219
4593
|
# A tool result that is video.
|
|
4220
4594
|
# @return [Types::VideoBlock]
|
|
4221
4595
|
#
|
|
4596
|
+
# @!attribute [rw] search_result
|
|
4597
|
+
# A tool result that is a search result.
|
|
4598
|
+
# @return [Types::SearchResultBlock]
|
|
4599
|
+
#
|
|
4222
4600
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ToolResultContentBlock AWS API Documentation
|
|
4223
4601
|
#
|
|
4224
4602
|
class ToolResultContentBlock < Struct.new(
|
|
@@ -4227,6 +4605,7 @@ module Aws::BedrockRuntime
|
|
|
4227
4605
|
:image,
|
|
4228
4606
|
:document,
|
|
4229
4607
|
:video,
|
|
4608
|
+
:search_result,
|
|
4230
4609
|
:unknown)
|
|
4231
4610
|
SENSITIVE = []
|
|
4232
4611
|
include Aws::Structure
|
|
@@ -4237,6 +4616,7 @@ module Aws::BedrockRuntime
|
|
|
4237
4616
|
class Image < ToolResultContentBlock; end
|
|
4238
4617
|
class Document < ToolResultContentBlock; end
|
|
4239
4618
|
class Video < ToolResultContentBlock; end
|
|
4619
|
+
class SearchResult < ToolResultContentBlock; end
|
|
4240
4620
|
class Unknown < ToolResultContentBlock; end
|
|
4241
4621
|
end
|
|
4242
4622
|
|