aws-sdk-bedrockruntime 1.61.0 → 1.63.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockruntime/async_client.rb +1 -1
- data/lib/aws-sdk-bedrockruntime/client.rb +37 -1
- data/lib/aws-sdk-bedrockruntime/client_api.rb +37 -0
- data/lib/aws-sdk-bedrockruntime/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-bedrockruntime/types.rb +226 -30
- data/lib/aws-sdk-bedrockruntime.rb +1 -1
- data/sig/client.rbs +30 -6
- data/sig/types.rbs +44 -0
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 1fe16e2649f933ef98cdc035603ca5f167ae32c71e88136a677aa824cd284e1c
|
|
4
|
+
data.tar.gz: '0289147ef1de7850c00b77fbe2fd98a739607bbb39223a3f0f134321cc691fa4'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3c5cfdc5e1e81b0c6a5e2a6ada0bc3d497e1f5d0a63177eef3570f36cb641eaa700ceec9e8d043044f80f5cf2026ab6536b3a54ef66c5ea102ca0eaaa1d16836
|
|
7
|
+
data.tar.gz: 94521450d807e8516e97de7e68d0a62de0a622b8f929d1b9aa394ca59a2f11318fd01adc8e7d1379cba1fc00e208b8c4d0ec58c4c3370113deebd81a9a8a47f9
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.63.0 (2025-10-29)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - Add support for system tool and web citation response.
|
|
8
|
+
|
|
9
|
+
1.62.0 (2025-10-28)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Update endpoint ruleset parameters casing
|
|
13
|
+
|
|
4
14
|
1.61.0 (2025-10-21)
|
|
5
15
|
------------------
|
|
6
16
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.63.0
|
|
@@ -980,6 +980,7 @@ module Aws::BedrockRuntime
|
|
|
980
980
|
# name: "ToolName", # required
|
|
981
981
|
# input: { # required
|
|
982
982
|
# },
|
|
983
|
+
# type: "server_tool_use", # accepts server_tool_use
|
|
983
984
|
# },
|
|
984
985
|
# tool_result: {
|
|
985
986
|
# tool_use_id: "ToolUseId", # required
|
|
@@ -1032,6 +1033,7 @@ module Aws::BedrockRuntime
|
|
|
1032
1033
|
# },
|
|
1033
1034
|
# ],
|
|
1034
1035
|
# status: "success", # accepts success, error
|
|
1036
|
+
# type: "String",
|
|
1035
1037
|
# },
|
|
1036
1038
|
# guard_content: {
|
|
1037
1039
|
# text: {
|
|
@@ -1070,6 +1072,10 @@ module Aws::BedrockRuntime
|
|
|
1070
1072
|
# },
|
|
1071
1073
|
# ],
|
|
1072
1074
|
# location: {
|
|
1075
|
+
# web: {
|
|
1076
|
+
# url: "String",
|
|
1077
|
+
# domain: "String",
|
|
1078
|
+
# },
|
|
1073
1079
|
# document_char: {
|
|
1074
1080
|
# document_index: 1,
|
|
1075
1081
|
# start: 1,
|
|
@@ -1130,6 +1136,9 @@ module Aws::BedrockRuntime
|
|
|
1130
1136
|
# },
|
|
1131
1137
|
# },
|
|
1132
1138
|
# },
|
|
1139
|
+
# system_tool: {
|
|
1140
|
+
# name: "ToolName", # required
|
|
1141
|
+
# },
|
|
1133
1142
|
# cache_point: {
|
|
1134
1143
|
# type: "default", # required, accepts default
|
|
1135
1144
|
# },
|
|
@@ -1191,6 +1200,7 @@ module Aws::BedrockRuntime
|
|
|
1191
1200
|
# resp.output.message.content[0].video.source.s3_location.bucket_owner #=> String
|
|
1192
1201
|
# resp.output.message.content[0].tool_use.tool_use_id #=> String
|
|
1193
1202
|
# resp.output.message.content[0].tool_use.name #=> String
|
|
1203
|
+
# resp.output.message.content[0].tool_use.type #=> String, one of "server_tool_use"
|
|
1194
1204
|
# resp.output.message.content[0].tool_result.tool_use_id #=> String
|
|
1195
1205
|
# resp.output.message.content[0].tool_result.content #=> Array
|
|
1196
1206
|
# resp.output.message.content[0].tool_result.content[0].text #=> String
|
|
@@ -1213,6 +1223,7 @@ module Aws::BedrockRuntime
|
|
|
1213
1223
|
# resp.output.message.content[0].tool_result.content[0].video.source.s3_location.uri #=> String
|
|
1214
1224
|
# resp.output.message.content[0].tool_result.content[0].video.source.s3_location.bucket_owner #=> String
|
|
1215
1225
|
# resp.output.message.content[0].tool_result.status #=> String, one of "success", "error"
|
|
1226
|
+
# resp.output.message.content[0].tool_result.type #=> String
|
|
1216
1227
|
# resp.output.message.content[0].guard_content.text.text #=> String
|
|
1217
1228
|
# resp.output.message.content[0].guard_content.text.qualifiers #=> Array
|
|
1218
1229
|
# resp.output.message.content[0].guard_content.text.qualifiers[0] #=> String, one of "grounding_source", "query", "guard_content"
|
|
@@ -1228,6 +1239,8 @@ module Aws::BedrockRuntime
|
|
|
1228
1239
|
# resp.output.message.content[0].citations_content.citations[0].title #=> String
|
|
1229
1240
|
# resp.output.message.content[0].citations_content.citations[0].source_content #=> Array
|
|
1230
1241
|
# resp.output.message.content[0].citations_content.citations[0].source_content[0].text #=> String
|
|
1242
|
+
# resp.output.message.content[0].citations_content.citations[0].location.web.url #=> String
|
|
1243
|
+
# resp.output.message.content[0].citations_content.citations[0].location.web.domain #=> String
|
|
1231
1244
|
# resp.output.message.content[0].citations_content.citations[0].location.document_char.document_index #=> Integer
|
|
1232
1245
|
# resp.output.message.content[0].citations_content.citations[0].location.document_char.start #=> Integer
|
|
1233
1246
|
# resp.output.message.content[0].citations_content.citations[0].location.document_char.end #=> Integer
|
|
@@ -2002,6 +2015,7 @@ module Aws::BedrockRuntime
|
|
|
2002
2015
|
# name: "ToolName", # required
|
|
2003
2016
|
# input: { # required
|
|
2004
2017
|
# },
|
|
2018
|
+
# type: "server_tool_use", # accepts server_tool_use
|
|
2005
2019
|
# },
|
|
2006
2020
|
# tool_result: {
|
|
2007
2021
|
# tool_use_id: "ToolUseId", # required
|
|
@@ -2054,6 +2068,7 @@ module Aws::BedrockRuntime
|
|
|
2054
2068
|
# },
|
|
2055
2069
|
# ],
|
|
2056
2070
|
# status: "success", # accepts success, error
|
|
2071
|
+
# type: "String",
|
|
2057
2072
|
# },
|
|
2058
2073
|
# guard_content: {
|
|
2059
2074
|
# text: {
|
|
@@ -2092,6 +2107,10 @@ module Aws::BedrockRuntime
|
|
|
2092
2107
|
# },
|
|
2093
2108
|
# ],
|
|
2094
2109
|
# location: {
|
|
2110
|
+
# web: {
|
|
2111
|
+
# url: "String",
|
|
2112
|
+
# domain: "String",
|
|
2113
|
+
# },
|
|
2095
2114
|
# document_char: {
|
|
2096
2115
|
# document_index: 1,
|
|
2097
2116
|
# start: 1,
|
|
@@ -2152,6 +2171,9 @@ module Aws::BedrockRuntime
|
|
|
2152
2171
|
# },
|
|
2153
2172
|
# },
|
|
2154
2173
|
# },
|
|
2174
|
+
# system_tool: {
|
|
2175
|
+
# name: "ToolName", # required
|
|
2176
|
+
# },
|
|
2155
2177
|
# cache_point: {
|
|
2156
2178
|
# type: "default", # required, accepts default
|
|
2157
2179
|
# },
|
|
@@ -2201,17 +2223,25 @@ module Aws::BedrockRuntime
|
|
|
2201
2223
|
# # For :content_block_start event available at #on_content_block_start_event callback and response eventstream enumerator:
|
|
2202
2224
|
# event.start.tool_use.tool_use_id #=> String
|
|
2203
2225
|
# event.start.tool_use.name #=> String
|
|
2226
|
+
# event.start.tool_use.type #=> String, one of "server_tool_use"
|
|
2227
|
+
# event.start.tool_result.tool_use_id #=> String
|
|
2228
|
+
# event.start.tool_result.type #=> String
|
|
2229
|
+
# event.start.tool_result.status #=> String, one of "success", "error"
|
|
2204
2230
|
# event.content_block_index #=> Integer
|
|
2205
2231
|
#
|
|
2206
2232
|
# # For :content_block_delta event available at #on_content_block_delta_event callback and response eventstream enumerator:
|
|
2207
2233
|
# event.delta.text #=> String
|
|
2208
2234
|
# event.delta.tool_use.input #=> String
|
|
2235
|
+
# event.delta.tool_result #=> Array
|
|
2236
|
+
# event.delta.tool_result[0].text #=> String
|
|
2209
2237
|
# event.delta.reasoning_content.text #=> String
|
|
2210
2238
|
# event.delta.reasoning_content.redacted_content #=> String
|
|
2211
2239
|
# event.delta.reasoning_content.signature #=> String
|
|
2212
2240
|
# event.delta.citation.title #=> String
|
|
2213
2241
|
# event.delta.citation.source_content #=> Array
|
|
2214
2242
|
# event.delta.citation.source_content[0].text #=> String
|
|
2243
|
+
# event.delta.citation.location.web.url #=> String
|
|
2244
|
+
# event.delta.citation.location.web.domain #=> String
|
|
2215
2245
|
# event.delta.citation.location.document_char.document_index #=> Integer
|
|
2216
2246
|
# event.delta.citation.location.document_char.start #=> Integer
|
|
2217
2247
|
# event.delta.citation.location.document_char.end #=> Integer
|
|
@@ -2726,6 +2756,7 @@ module Aws::BedrockRuntime
|
|
|
2726
2756
|
# name: "ToolName", # required
|
|
2727
2757
|
# input: { # required
|
|
2728
2758
|
# },
|
|
2759
|
+
# type: "server_tool_use", # accepts server_tool_use
|
|
2729
2760
|
# },
|
|
2730
2761
|
# tool_result: {
|
|
2731
2762
|
# tool_use_id: "ToolUseId", # required
|
|
@@ -2778,6 +2809,7 @@ module Aws::BedrockRuntime
|
|
|
2778
2809
|
# },
|
|
2779
2810
|
# ],
|
|
2780
2811
|
# status: "success", # accepts success, error
|
|
2812
|
+
# type: "String",
|
|
2781
2813
|
# },
|
|
2782
2814
|
# guard_content: {
|
|
2783
2815
|
# text: {
|
|
@@ -2816,6 +2848,10 @@ module Aws::BedrockRuntime
|
|
|
2816
2848
|
# },
|
|
2817
2849
|
# ],
|
|
2818
2850
|
# location: {
|
|
2851
|
+
# web: {
|
|
2852
|
+
# url: "String",
|
|
2853
|
+
# domain: "String",
|
|
2854
|
+
# },
|
|
2819
2855
|
# document_char: {
|
|
2820
2856
|
# document_index: 1,
|
|
2821
2857
|
# start: 1,
|
|
@@ -3574,7 +3610,7 @@ module Aws::BedrockRuntime
|
|
|
3574
3610
|
tracer: tracer
|
|
3575
3611
|
)
|
|
3576
3612
|
context[:gem_name] = 'aws-sdk-bedrockruntime'
|
|
3577
|
-
context[:gem_version] = '1.
|
|
3613
|
+
context[:gem_version] = '1.63.0'
|
|
3578
3614
|
Seahorse::Client::Request.new(handlers, context)
|
|
3579
3615
|
end
|
|
3580
3616
|
|
|
@@ -285,6 +285,7 @@ module Aws::BedrockRuntime
|
|
|
285
285
|
String = Shapes::StringShape.new(name: 'String')
|
|
286
286
|
SystemContentBlock = Shapes::UnionShape.new(name: 'SystemContentBlock')
|
|
287
287
|
SystemContentBlocks = Shapes::ListShape.new(name: 'SystemContentBlocks')
|
|
288
|
+
SystemTool = Shapes::StructureShape.new(name: 'SystemTool')
|
|
288
289
|
Tag = Shapes::StructureShape.new(name: 'Tag')
|
|
289
290
|
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
|
290
291
|
TagList = Shapes::ListShape.new(name: 'TagList')
|
|
@@ -306,6 +307,9 @@ module Aws::BedrockRuntime
|
|
|
306
307
|
ToolInputSchema = Shapes::UnionShape.new(name: 'ToolInputSchema')
|
|
307
308
|
ToolName = Shapes::StringShape.new(name: 'ToolName')
|
|
308
309
|
ToolResultBlock = Shapes::StructureShape.new(name: 'ToolResultBlock')
|
|
310
|
+
ToolResultBlockDelta = Shapes::UnionShape.new(name: 'ToolResultBlockDelta')
|
|
311
|
+
ToolResultBlockStart = Shapes::StructureShape.new(name: 'ToolResultBlockStart')
|
|
312
|
+
ToolResultBlocksDelta = Shapes::ListShape.new(name: 'ToolResultBlocksDelta')
|
|
309
313
|
ToolResultContentBlock = Shapes::UnionShape.new(name: 'ToolResultContentBlock')
|
|
310
314
|
ToolResultContentBlocks = Shapes::ListShape.new(name: 'ToolResultContentBlocks')
|
|
311
315
|
ToolResultStatus = Shapes::StringShape.new(name: 'ToolResultStatus')
|
|
@@ -314,12 +318,14 @@ module Aws::BedrockRuntime
|
|
|
314
318
|
ToolUseBlockDelta = Shapes::StructureShape.new(name: 'ToolUseBlockDelta')
|
|
315
319
|
ToolUseBlockStart = Shapes::StructureShape.new(name: 'ToolUseBlockStart')
|
|
316
320
|
ToolUseId = Shapes::StringShape.new(name: 'ToolUseId')
|
|
321
|
+
ToolUseType = Shapes::StringShape.new(name: 'ToolUseType')
|
|
317
322
|
Trace = Shapes::StringShape.new(name: 'Trace')
|
|
318
323
|
ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
|
|
319
324
|
VideoBlock = Shapes::StructureShape.new(name: 'VideoBlock')
|
|
320
325
|
VideoFormat = Shapes::StringShape.new(name: 'VideoFormat')
|
|
321
326
|
VideoSource = Shapes::UnionShape.new(name: 'VideoSource')
|
|
322
327
|
VideoSourceBytesBlob = Shapes::BlobShape.new(name: 'VideoSourceBytesBlob')
|
|
328
|
+
WebLocation = Shapes::StructureShape.new(name: 'WebLocation')
|
|
323
329
|
|
|
324
330
|
AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "message"))
|
|
325
331
|
AccessDeniedException.struct_class = Types::AccessDeniedException
|
|
@@ -389,10 +395,12 @@ module Aws::BedrockRuntime
|
|
|
389
395
|
|
|
390
396
|
CitationGeneratedContentList.member = Shapes::ShapeRef.new(shape: CitationGeneratedContent)
|
|
391
397
|
|
|
398
|
+
CitationLocation.add_member(:web, Shapes::ShapeRef.new(shape: WebLocation, location_name: "web"))
|
|
392
399
|
CitationLocation.add_member(:document_char, Shapes::ShapeRef.new(shape: DocumentCharLocation, location_name: "documentChar"))
|
|
393
400
|
CitationLocation.add_member(:document_page, Shapes::ShapeRef.new(shape: DocumentPageLocation, location_name: "documentPage"))
|
|
394
401
|
CitationLocation.add_member(:document_chunk, Shapes::ShapeRef.new(shape: DocumentChunkLocation, location_name: "documentChunk"))
|
|
395
402
|
CitationLocation.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
|
403
|
+
CitationLocation.add_member_subclass(:web, Types::CitationLocation::Web)
|
|
396
404
|
CitationLocation.add_member_subclass(:document_char, Types::CitationLocation::DocumentChar)
|
|
397
405
|
CitationLocation.add_member_subclass(:document_page, Types::CitationLocation::DocumentPage)
|
|
398
406
|
CitationLocation.add_member_subclass(:document_chunk, Types::CitationLocation::DocumentChunk)
|
|
@@ -455,11 +463,13 @@ module Aws::BedrockRuntime
|
|
|
455
463
|
|
|
456
464
|
ContentBlockDelta.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "text"))
|
|
457
465
|
ContentBlockDelta.add_member(:tool_use, Shapes::ShapeRef.new(shape: ToolUseBlockDelta, location_name: "toolUse"))
|
|
466
|
+
ContentBlockDelta.add_member(:tool_result, Shapes::ShapeRef.new(shape: ToolResultBlocksDelta, location_name: "toolResult"))
|
|
458
467
|
ContentBlockDelta.add_member(:reasoning_content, Shapes::ShapeRef.new(shape: ReasoningContentBlockDelta, location_name: "reasoningContent"))
|
|
459
468
|
ContentBlockDelta.add_member(:citation, Shapes::ShapeRef.new(shape: CitationsDelta, location_name: "citation"))
|
|
460
469
|
ContentBlockDelta.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
|
461
470
|
ContentBlockDelta.add_member_subclass(:text, Types::ContentBlockDelta::Text)
|
|
462
471
|
ContentBlockDelta.add_member_subclass(:tool_use, Types::ContentBlockDelta::ToolUse)
|
|
472
|
+
ContentBlockDelta.add_member_subclass(:tool_result, Types::ContentBlockDelta::ToolResult)
|
|
463
473
|
ContentBlockDelta.add_member_subclass(:reasoning_content, Types::ContentBlockDelta::ReasoningContent)
|
|
464
474
|
ContentBlockDelta.add_member_subclass(:citation, Types::ContentBlockDelta::Citation)
|
|
465
475
|
ContentBlockDelta.add_member_subclass(:unknown, Types::ContentBlockDelta::Unknown)
|
|
@@ -470,8 +480,10 @@ module Aws::BedrockRuntime
|
|
|
470
480
|
ContentBlockDeltaEvent.struct_class = Types::ContentBlockDeltaEvent
|
|
471
481
|
|
|
472
482
|
ContentBlockStart.add_member(:tool_use, Shapes::ShapeRef.new(shape: ToolUseBlockStart, location_name: "toolUse"))
|
|
483
|
+
ContentBlockStart.add_member(:tool_result, Shapes::ShapeRef.new(shape: ToolResultBlockStart, location_name: "toolResult"))
|
|
473
484
|
ContentBlockStart.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
|
474
485
|
ContentBlockStart.add_member_subclass(:tool_use, Types::ContentBlockStart::ToolUse)
|
|
486
|
+
ContentBlockStart.add_member_subclass(:tool_result, Types::ContentBlockStart::ToolResult)
|
|
475
487
|
ContentBlockStart.add_member_subclass(:unknown, Types::ContentBlockStart::Unknown)
|
|
476
488
|
ContentBlockStart.struct_class = Types::ContentBlockStart
|
|
477
489
|
|
|
@@ -1149,6 +1161,9 @@ module Aws::BedrockRuntime
|
|
|
1149
1161
|
|
|
1150
1162
|
SystemContentBlocks.member = Shapes::ShapeRef.new(shape: SystemContentBlock)
|
|
1151
1163
|
|
|
1164
|
+
SystemTool.add_member(:name, Shapes::ShapeRef.new(shape: ToolName, required: true, location_name: "name"))
|
|
1165
|
+
SystemTool.struct_class = Types::SystemTool
|
|
1166
|
+
|
|
1152
1167
|
Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, required: true, location_name: "key"))
|
|
1153
1168
|
Tag.add_member(:value, Shapes::ShapeRef.new(shape: TagValue, required: true, location_name: "value"))
|
|
1154
1169
|
Tag.struct_class = Types::Tag
|
|
@@ -1166,9 +1181,11 @@ module Aws::BedrockRuntime
|
|
|
1166
1181
|
TokenUsage.struct_class = Types::TokenUsage
|
|
1167
1182
|
|
|
1168
1183
|
Tool.add_member(:tool_spec, Shapes::ShapeRef.new(shape: ToolSpecification, location_name: "toolSpec"))
|
|
1184
|
+
Tool.add_member(:system_tool, Shapes::ShapeRef.new(shape: SystemTool, location_name: "systemTool"))
|
|
1169
1185
|
Tool.add_member(:cache_point, Shapes::ShapeRef.new(shape: CachePointBlock, location_name: "cachePoint"))
|
|
1170
1186
|
Tool.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
|
1171
1187
|
Tool.add_member_subclass(:tool_spec, Types::Tool::ToolSpec)
|
|
1188
|
+
Tool.add_member_subclass(:system_tool, Types::Tool::SystemTool)
|
|
1172
1189
|
Tool.add_member_subclass(:cache_point, Types::Tool::CachePoint)
|
|
1173
1190
|
Tool.add_member_subclass(:unknown, Types::Tool::Unknown)
|
|
1174
1191
|
Tool.struct_class = Types::Tool
|
|
@@ -1198,8 +1215,22 @@ module Aws::BedrockRuntime
|
|
|
1198
1215
|
ToolResultBlock.add_member(:tool_use_id, Shapes::ShapeRef.new(shape: ToolUseId, required: true, location_name: "toolUseId"))
|
|
1199
1216
|
ToolResultBlock.add_member(:content, Shapes::ShapeRef.new(shape: ToolResultContentBlocks, required: true, location_name: "content"))
|
|
1200
1217
|
ToolResultBlock.add_member(:status, Shapes::ShapeRef.new(shape: ToolResultStatus, location_name: "status"))
|
|
1218
|
+
ToolResultBlock.add_member(:type, Shapes::ShapeRef.new(shape: String, location_name: "type"))
|
|
1201
1219
|
ToolResultBlock.struct_class = Types::ToolResultBlock
|
|
1202
1220
|
|
|
1221
|
+
ToolResultBlockDelta.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "text"))
|
|
1222
|
+
ToolResultBlockDelta.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
|
1223
|
+
ToolResultBlockDelta.add_member_subclass(:text, Types::ToolResultBlockDelta::Text)
|
|
1224
|
+
ToolResultBlockDelta.add_member_subclass(:unknown, Types::ToolResultBlockDelta::Unknown)
|
|
1225
|
+
ToolResultBlockDelta.struct_class = Types::ToolResultBlockDelta
|
|
1226
|
+
|
|
1227
|
+
ToolResultBlockStart.add_member(:tool_use_id, Shapes::ShapeRef.new(shape: ToolUseId, required: true, location_name: "toolUseId"))
|
|
1228
|
+
ToolResultBlockStart.add_member(:type, Shapes::ShapeRef.new(shape: String, location_name: "type"))
|
|
1229
|
+
ToolResultBlockStart.add_member(:status, Shapes::ShapeRef.new(shape: ToolResultStatus, location_name: "status"))
|
|
1230
|
+
ToolResultBlockStart.struct_class = Types::ToolResultBlockStart
|
|
1231
|
+
|
|
1232
|
+
ToolResultBlocksDelta.member = Shapes::ShapeRef.new(shape: ToolResultBlockDelta)
|
|
1233
|
+
|
|
1203
1234
|
ToolResultContentBlock.add_member(:json, Shapes::ShapeRef.new(shape: Document, location_name: "json"))
|
|
1204
1235
|
ToolResultContentBlock.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "text"))
|
|
1205
1236
|
ToolResultContentBlock.add_member(:image, Shapes::ShapeRef.new(shape: ImageBlock, location_name: "image"))
|
|
@@ -1224,6 +1255,7 @@ module Aws::BedrockRuntime
|
|
|
1224
1255
|
ToolUseBlock.add_member(:tool_use_id, Shapes::ShapeRef.new(shape: ToolUseId, required: true, location_name: "toolUseId"))
|
|
1225
1256
|
ToolUseBlock.add_member(:name, Shapes::ShapeRef.new(shape: ToolName, required: true, location_name: "name"))
|
|
1226
1257
|
ToolUseBlock.add_member(:input, Shapes::ShapeRef.new(shape: Document, required: true, location_name: "input"))
|
|
1258
|
+
ToolUseBlock.add_member(:type, Shapes::ShapeRef.new(shape: ToolUseType, location_name: "type"))
|
|
1227
1259
|
ToolUseBlock.struct_class = Types::ToolUseBlock
|
|
1228
1260
|
|
|
1229
1261
|
ToolUseBlockDelta.add_member(:input, Shapes::ShapeRef.new(shape: String, required: true, location_name: "input"))
|
|
@@ -1231,6 +1263,7 @@ module Aws::BedrockRuntime
|
|
|
1231
1263
|
|
|
1232
1264
|
ToolUseBlockStart.add_member(:tool_use_id, Shapes::ShapeRef.new(shape: ToolUseId, required: true, location_name: "toolUseId"))
|
|
1233
1265
|
ToolUseBlockStart.add_member(:name, Shapes::ShapeRef.new(shape: ToolName, required: true, location_name: "name"))
|
|
1266
|
+
ToolUseBlockStart.add_member(:type, Shapes::ShapeRef.new(shape: ToolUseType, location_name: "type"))
|
|
1234
1267
|
ToolUseBlockStart.struct_class = Types::ToolUseBlockStart
|
|
1235
1268
|
|
|
1236
1269
|
ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "message"))
|
|
@@ -1248,6 +1281,10 @@ module Aws::BedrockRuntime
|
|
|
1248
1281
|
VideoSource.add_member_subclass(:unknown, Types::VideoSource::Unknown)
|
|
1249
1282
|
VideoSource.struct_class = Types::VideoSource
|
|
1250
1283
|
|
|
1284
|
+
WebLocation.add_member(:url, Shapes::ShapeRef.new(shape: String, location_name: "url"))
|
|
1285
|
+
WebLocation.add_member(:domain, Shapes::ShapeRef.new(shape: String, location_name: "domain"))
|
|
1286
|
+
WebLocation.struct_class = Types::WebLocation
|
|
1287
|
+
|
|
1251
1288
|
|
|
1252
1289
|
# @api private
|
|
1253
1290
|
API = Seahorse::Model::Api.new.tap do |api|
|
|
@@ -13,22 +13,22 @@ module Aws::BedrockRuntime
|
|
|
13
13
|
# @!attribute region
|
|
14
14
|
# The AWS region used to dispatch the request.
|
|
15
15
|
#
|
|
16
|
-
# @return [
|
|
16
|
+
# @return [string]
|
|
17
17
|
#
|
|
18
18
|
# @!attribute use_dual_stack
|
|
19
19
|
# When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
|
|
20
20
|
#
|
|
21
|
-
# @return [
|
|
21
|
+
# @return [boolean]
|
|
22
22
|
#
|
|
23
23
|
# @!attribute use_fips
|
|
24
24
|
# When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
|
|
25
25
|
#
|
|
26
|
-
# @return [
|
|
26
|
+
# @return [boolean]
|
|
27
27
|
#
|
|
28
28
|
# @!attribute endpoint
|
|
29
29
|
# Override the endpoint used to send this request
|
|
30
30
|
#
|
|
31
|
-
# @return [
|
|
31
|
+
# @return [string]
|
|
32
32
|
#
|
|
33
33
|
EndpointParameters = Struct.new(
|
|
34
34
|
:region,
|
|
@@ -30,7 +30,12 @@ module Aws::BedrockRuntime
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# The model must request at least one tool (no text is generated). For
|
|
33
|
-
# example, `{"any" : {}}`.
|
|
33
|
+
# example, `{"any" : {}}`. For more information, see [Call a tool with
|
|
34
|
+
# the Converse API][1] in the Amazon Bedrock User Guide.
|
|
35
|
+
#
|
|
36
|
+
#
|
|
37
|
+
#
|
|
38
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html
|
|
34
39
|
#
|
|
35
40
|
# @api private
|
|
36
41
|
#
|
|
@@ -217,7 +222,13 @@ module Aws::BedrockRuntime
|
|
|
217
222
|
end
|
|
218
223
|
|
|
219
224
|
# The Model automatically decides if a tool should be called or whether
|
|
220
|
-
# to generate text instead. For example, `{"auto" : {}}`.
|
|
225
|
+
# to generate text instead. For example, `{"auto" : {}}`. For more
|
|
226
|
+
# information, see [Call a tool with the Converse API][1] in the Amazon
|
|
227
|
+
# Bedrock User Guide
|
|
228
|
+
#
|
|
229
|
+
#
|
|
230
|
+
#
|
|
231
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html
|
|
221
232
|
#
|
|
222
233
|
# @api private
|
|
223
234
|
#
|
|
@@ -336,6 +347,10 @@ module Aws::BedrockRuntime
|
|
|
336
347
|
#
|
|
337
348
|
# @note CitationLocation is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of CitationLocation corresponding to the set member.
|
|
338
349
|
#
|
|
350
|
+
# @!attribute [rw] web
|
|
351
|
+
# The web URL that was cited for this reference.
|
|
352
|
+
# @return [Types::WebLocation]
|
|
353
|
+
#
|
|
339
354
|
# @!attribute [rw] document_char
|
|
340
355
|
# The character-level location within the document where the cited
|
|
341
356
|
# content is found.
|
|
@@ -355,6 +370,7 @@ module Aws::BedrockRuntime
|
|
|
355
370
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/CitationLocation AWS API Documentation
|
|
356
371
|
#
|
|
357
372
|
class CitationLocation < Struct.new(
|
|
373
|
+
:web,
|
|
358
374
|
:document_char,
|
|
359
375
|
:document_page,
|
|
360
376
|
:document_chunk,
|
|
@@ -363,6 +379,7 @@ module Aws::BedrockRuntime
|
|
|
363
379
|
include Aws::Structure
|
|
364
380
|
include Aws::Structure::Union
|
|
365
381
|
|
|
382
|
+
class Web < CitationLocation; end
|
|
366
383
|
class DocumentChar < CitationLocation; end
|
|
367
384
|
class DocumentPage < CitationLocation; end
|
|
368
385
|
class DocumentChunk < CitationLocation; end
|
|
@@ -416,10 +433,10 @@ module Aws::BedrockRuntime
|
|
|
416
433
|
# source documents.
|
|
417
434
|
#
|
|
418
435
|
# @!attribute [rw] enabled
|
|
419
|
-
# Specifies whether
|
|
420
|
-
# model's response. When set to true, the model can
|
|
421
|
-
# citations that reference the source documents used to
|
|
422
|
-
# response.
|
|
436
|
+
# Specifies whether citations from the selected document should be
|
|
437
|
+
# used in the model's response. When set to true, the model can
|
|
438
|
+
# generate citations that reference the source documents used to
|
|
439
|
+
# inform the response.
|
|
423
440
|
# @return [Boolean]
|
|
424
441
|
#
|
|
425
442
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/CitationsConfig AWS API Documentation
|
|
@@ -604,6 +621,10 @@ module Aws::BedrockRuntime
|
|
|
604
621
|
# Information about a tool that the model is requesting to use.
|
|
605
622
|
# @return [Types::ToolUseBlockDelta]
|
|
606
623
|
#
|
|
624
|
+
# @!attribute [rw] tool_result
|
|
625
|
+
# An incremental update that contains the results from a tool call.
|
|
626
|
+
# @return [Array<Types::ToolResultBlockDelta>]
|
|
627
|
+
#
|
|
607
628
|
# @!attribute [rw] reasoning_content
|
|
608
629
|
# Contains content regarding the reasoning that is carried out by the
|
|
609
630
|
# model. Reasoning refers to a Chain of Thought (CoT) that the model
|
|
@@ -620,6 +641,7 @@ module Aws::BedrockRuntime
|
|
|
620
641
|
class ContentBlockDelta < Struct.new(
|
|
621
642
|
:text,
|
|
622
643
|
:tool_use,
|
|
644
|
+
:tool_result,
|
|
623
645
|
:reasoning_content,
|
|
624
646
|
:citation,
|
|
625
647
|
:unknown)
|
|
@@ -629,6 +651,7 @@ module Aws::BedrockRuntime
|
|
|
629
651
|
|
|
630
652
|
class Text < ContentBlockDelta; end
|
|
631
653
|
class ToolUse < ContentBlockDelta; end
|
|
654
|
+
class ToolResult < ContentBlockDelta; end
|
|
632
655
|
class ReasoningContent < ContentBlockDelta; end
|
|
633
656
|
class Citation < ContentBlockDelta; end
|
|
634
657
|
class Unknown < ContentBlockDelta; end
|
|
@@ -662,16 +685,22 @@ module Aws::BedrockRuntime
|
|
|
662
685
|
# Information about a tool that the model is requesting to use.
|
|
663
686
|
# @return [Types::ToolUseBlockStart]
|
|
664
687
|
#
|
|
688
|
+
# @!attribute [rw] tool_result
|
|
689
|
+
# The
|
|
690
|
+
# @return [Types::ToolResultBlockStart]
|
|
691
|
+
#
|
|
665
692
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ContentBlockStart AWS API Documentation
|
|
666
693
|
#
|
|
667
694
|
class ContentBlockStart < Struct.new(
|
|
668
695
|
:tool_use,
|
|
696
|
+
:tool_result,
|
|
669
697
|
:unknown)
|
|
670
698
|
SENSITIVE = []
|
|
671
699
|
include Aws::Structure
|
|
672
700
|
include Aws::Structure::Union
|
|
673
701
|
|
|
674
702
|
class ToolUse < ContentBlockStart; end
|
|
703
|
+
class ToolResult < ContentBlockStart; end
|
|
675
704
|
class Unknown < ContentBlockStart; end
|
|
676
705
|
end
|
|
677
706
|
|
|
@@ -1144,8 +1173,7 @@ module Aws::BedrockRuntime
|
|
|
1144
1173
|
include Aws::Structure
|
|
1145
1174
|
end
|
|
1146
1175
|
|
|
1147
|
-
# The trace object in a response from [ConverseStream][1].
|
|
1148
|
-
# you can only trace guardrails.
|
|
1176
|
+
# The trace object in a response from [ConverseStream][1].
|
|
1149
1177
|
#
|
|
1150
1178
|
#
|
|
1151
1179
|
#
|
|
@@ -1194,8 +1222,7 @@ module Aws::BedrockRuntime
|
|
|
1194
1222
|
include Aws::Structure
|
|
1195
1223
|
end
|
|
1196
1224
|
|
|
1197
|
-
# The trace object in a response from [Converse][1].
|
|
1198
|
-
# only trace guardrails.
|
|
1225
|
+
# The trace object in a response from [Converse][1].
|
|
1199
1226
|
#
|
|
1200
1227
|
#
|
|
1201
1228
|
#
|
|
@@ -2263,7 +2290,12 @@ module Aws::BedrockRuntime
|
|
|
2263
2290
|
end
|
|
2264
2291
|
|
|
2265
2292
|
# A text block that contains text that you want to assess with a
|
|
2266
|
-
# guardrail. For more information, see
|
|
2293
|
+
# guardrail. For more information, see
|
|
2294
|
+
# [GuardrailConverseContentBlock][1].
|
|
2295
|
+
#
|
|
2296
|
+
#
|
|
2297
|
+
#
|
|
2298
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_GuardrailConverseContentBlock.html
|
|
2267
2299
|
#
|
|
2268
2300
|
# @!attribute [rw] text
|
|
2269
2301
|
# The text that you want to guard.
|
|
@@ -2527,7 +2559,7 @@ module Aws::BedrockRuntime
|
|
|
2527
2559
|
include Aws::Structure
|
|
2528
2560
|
end
|
|
2529
2561
|
|
|
2530
|
-
# The assessment for
|
|
2562
|
+
# The assessment for a Personally Identifiable Information (PII) policy.
|
|
2531
2563
|
#
|
|
2532
2564
|
# @!attribute [rw] pii_entities
|
|
2533
2565
|
# The PII entities in the assessment.
|
|
@@ -2547,7 +2579,11 @@ module Aws::BedrockRuntime
|
|
|
2547
2579
|
end
|
|
2548
2580
|
|
|
2549
2581
|
# Configuration information for a guardrail that you use with the
|
|
2550
|
-
# ConverseStream action.
|
|
2582
|
+
# [ConverseStream][1] action.
|
|
2583
|
+
#
|
|
2584
|
+
#
|
|
2585
|
+
#
|
|
2586
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html
|
|
2551
2587
|
#
|
|
2552
2588
|
# @!attribute [rw] guardrail_identifier
|
|
2553
2589
|
# The identifier for the guardrail.
|
|
@@ -2663,7 +2699,11 @@ module Aws::BedrockRuntime
|
|
|
2663
2699
|
end
|
|
2664
2700
|
|
|
2665
2701
|
# A Top level guardrail trace object. For more information, see
|
|
2666
|
-
# ConverseTrace.
|
|
2702
|
+
# [ConverseTrace][1].
|
|
2703
|
+
#
|
|
2704
|
+
#
|
|
2705
|
+
#
|
|
2706
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseTrace.html
|
|
2667
2707
|
#
|
|
2668
2708
|
# @!attribute [rw] model_output
|
|
2669
2709
|
# The output from the model.
|
|
@@ -3707,12 +3747,17 @@ module Aws::BedrockRuntime
|
|
|
3707
3747
|
end
|
|
3708
3748
|
|
|
3709
3749
|
# The model must request a specific tool. For example, `{"tool" :
|
|
3710
|
-
# {"name" : "Your tool name"}}`.
|
|
3750
|
+
# {"name" : "Your tool name"}}`. For more information, see [Call a tool
|
|
3751
|
+
# with the Converse API][1] in the Amazon Bedrock User Guide
|
|
3711
3752
|
#
|
|
3712
3753
|
# <note markdown="1"> This field is only supported by Anthropic Claude 3 models.
|
|
3713
3754
|
#
|
|
3714
3755
|
# </note>
|
|
3715
3756
|
#
|
|
3757
|
+
#
|
|
3758
|
+
#
|
|
3759
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html
|
|
3760
|
+
#
|
|
3716
3761
|
# @!attribute [rw] name
|
|
3717
3762
|
# The name of the tool that the model must request.
|
|
3718
3763
|
# @return [String]
|
|
@@ -3773,7 +3818,12 @@ module Aws::BedrockRuntime
|
|
|
3773
3818
|
include Aws::Structure
|
|
3774
3819
|
end
|
|
3775
3820
|
|
|
3776
|
-
#
|
|
3821
|
+
# Contains configurations for instructions to provide the model for how
|
|
3822
|
+
# to handle input. To learn more, see [Using the Converse API][1].
|
|
3823
|
+
#
|
|
3824
|
+
#
|
|
3825
|
+
#
|
|
3826
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-call.html
|
|
3777
3827
|
#
|
|
3778
3828
|
# @note SystemContentBlock is a union - when making an API calls you must set exactly one of the members.
|
|
3779
3829
|
#
|
|
@@ -3815,6 +3865,21 @@ module Aws::BedrockRuntime
|
|
|
3815
3865
|
class Unknown < SystemContentBlock; end
|
|
3816
3866
|
end
|
|
3817
3867
|
|
|
3868
|
+
# Specifies a system-defined tool for the model to use. *System-defined
|
|
3869
|
+
# tools* are tools that are created and provided by the model provider.
|
|
3870
|
+
#
|
|
3871
|
+
# @!attribute [rw] name
|
|
3872
|
+
# The name of the system-defined tool that you want to call.
|
|
3873
|
+
# @return [String]
|
|
3874
|
+
#
|
|
3875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/SystemTool AWS API Documentation
|
|
3876
|
+
#
|
|
3877
|
+
class SystemTool < Struct.new(
|
|
3878
|
+
:name)
|
|
3879
|
+
SENSITIVE = []
|
|
3880
|
+
include Aws::Structure
|
|
3881
|
+
end
|
|
3882
|
+
|
|
3818
3883
|
# A tag.
|
|
3819
3884
|
#
|
|
3820
3885
|
# @!attribute [rw] key
|
|
@@ -3889,8 +3954,8 @@ module Aws::BedrockRuntime
|
|
|
3889
3954
|
end
|
|
3890
3955
|
|
|
3891
3956
|
# Information about a tool that you can use with the Converse API. For
|
|
3892
|
-
# more information, see [
|
|
3893
|
-
# Bedrock User Guide.
|
|
3957
|
+
# more information, see [Call a tool with the Converse API][1] in the
|
|
3958
|
+
# Amazon Bedrock User Guide.
|
|
3894
3959
|
#
|
|
3895
3960
|
#
|
|
3896
3961
|
#
|
|
@@ -3902,6 +3967,10 @@ module Aws::BedrockRuntime
|
|
|
3902
3967
|
# The specfication for the tool.
|
|
3903
3968
|
# @return [Types::ToolSpecification]
|
|
3904
3969
|
#
|
|
3970
|
+
# @!attribute [rw] system_tool
|
|
3971
|
+
# Specifies the system-defined tool that you want use.
|
|
3972
|
+
# @return [Types::SystemTool]
|
|
3973
|
+
#
|
|
3905
3974
|
# @!attribute [rw] cache_point
|
|
3906
3975
|
# CachePoint to include in the tool configuration.
|
|
3907
3976
|
# @return [Types::CachePointBlock]
|
|
@@ -3910,6 +3979,7 @@ module Aws::BedrockRuntime
|
|
|
3910
3979
|
#
|
|
3911
3980
|
class Tool < Struct.new(
|
|
3912
3981
|
:tool_spec,
|
|
3982
|
+
:system_tool,
|
|
3913
3983
|
:cache_point,
|
|
3914
3984
|
:unknown)
|
|
3915
3985
|
SENSITIVE = []
|
|
@@ -3917,13 +3987,18 @@ module Aws::BedrockRuntime
|
|
|
3917
3987
|
include Aws::Structure::Union
|
|
3918
3988
|
|
|
3919
3989
|
class ToolSpec < Tool; end
|
|
3990
|
+
class SystemTool < Tool; end
|
|
3920
3991
|
class CachePoint < Tool; end
|
|
3921
3992
|
class Unknown < Tool; end
|
|
3922
3993
|
end
|
|
3923
3994
|
|
|
3924
3995
|
# Determines which tools the model should request in a call to
|
|
3925
|
-
# `Converse` or `ConverseStream`.
|
|
3926
|
-
#
|
|
3996
|
+
# `Converse` or `ConverseStream`. For more information, see [Call a tool
|
|
3997
|
+
# with the Converse API][1] in the Amazon Bedrock User Guide.
|
|
3998
|
+
#
|
|
3999
|
+
#
|
|
4000
|
+
#
|
|
4001
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html
|
|
3927
4002
|
#
|
|
3928
4003
|
# @note ToolChoice is a union - when making an API calls you must set exactly one of the members.
|
|
3929
4004
|
#
|
|
@@ -3938,7 +4013,7 @@ module Aws::BedrockRuntime
|
|
|
3938
4013
|
#
|
|
3939
4014
|
# @!attribute [rw] tool
|
|
3940
4015
|
# The Model must request the specified tool. Only supported by
|
|
3941
|
-
# Anthropic Claude 3 models.
|
|
4016
|
+
# Anthropic Claude 3 and Amazon Nova models.
|
|
3942
4017
|
# @return [Types::SpecificToolChoice]
|
|
3943
4018
|
#
|
|
3944
4019
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ToolChoice AWS API Documentation
|
|
@@ -3984,6 +4059,12 @@ module Aws::BedrockRuntime
|
|
|
3984
4059
|
end
|
|
3985
4060
|
|
|
3986
4061
|
# The schema for the tool. The top level schema type must be `object`.
|
|
4062
|
+
# For more information, see [Call a tool with the Converse API][1] in
|
|
4063
|
+
# the Amazon Bedrock User Guide.
|
|
4064
|
+
#
|
|
4065
|
+
#
|
|
4066
|
+
#
|
|
4067
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html
|
|
3987
4068
|
#
|
|
3988
4069
|
# @note ToolInputSchema is a union - when making an API calls you must set exactly one of the members.
|
|
3989
4070
|
#
|
|
@@ -4010,7 +4091,12 @@ module Aws::BedrockRuntime
|
|
|
4010
4091
|
end
|
|
4011
4092
|
|
|
4012
4093
|
# A tool result block that contains the results for a tool request that
|
|
4013
|
-
# the model previously made.
|
|
4094
|
+
# the model previously made. For more information, see [Call a tool with
|
|
4095
|
+
# the Converse API][1] in the Amazon Bedrock User Guide.
|
|
4096
|
+
#
|
|
4097
|
+
#
|
|
4098
|
+
#
|
|
4099
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html
|
|
4014
4100
|
#
|
|
4015
4101
|
# @!attribute [rw] tool_use_id
|
|
4016
4102
|
# The ID of the tool request that this is the result for.
|
|
@@ -4023,22 +4109,86 @@ module Aws::BedrockRuntime
|
|
|
4023
4109
|
# @!attribute [rw] status
|
|
4024
4110
|
# The status for the tool result content block.
|
|
4025
4111
|
#
|
|
4026
|
-
# <note markdown="1"> This field is only supported Anthropic Claude 3
|
|
4112
|
+
# <note markdown="1"> This field is only supported by Amazon Nova and Anthropic Claude 3
|
|
4113
|
+
# and 4 models.
|
|
4027
4114
|
#
|
|
4028
4115
|
# </note>
|
|
4029
4116
|
# @return [String]
|
|
4030
4117
|
#
|
|
4118
|
+
# @!attribute [rw] type
|
|
4119
|
+
# The type for the tool result content block.
|
|
4120
|
+
# @return [String]
|
|
4121
|
+
#
|
|
4031
4122
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ToolResultBlock AWS API Documentation
|
|
4032
4123
|
#
|
|
4033
4124
|
class ToolResultBlock < Struct.new(
|
|
4034
4125
|
:tool_use_id,
|
|
4035
4126
|
:content,
|
|
4127
|
+
:status,
|
|
4128
|
+
:type)
|
|
4129
|
+
SENSITIVE = []
|
|
4130
|
+
include Aws::Structure
|
|
4131
|
+
end
|
|
4132
|
+
|
|
4133
|
+
# Contains incremental updates to tool results information during
|
|
4134
|
+
# streaming responses. This allows clients to build up tool results data
|
|
4135
|
+
# progressively as the response is generated.
|
|
4136
|
+
#
|
|
4137
|
+
# @note ToolResultBlockDelta is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ToolResultBlockDelta corresponding to the set member.
|
|
4138
|
+
#
|
|
4139
|
+
# @!attribute [rw] text
|
|
4140
|
+
# The reasoning the model used to return the output.
|
|
4141
|
+
# @return [String]
|
|
4142
|
+
#
|
|
4143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ToolResultBlockDelta AWS API Documentation
|
|
4144
|
+
#
|
|
4145
|
+
class ToolResultBlockDelta < Struct.new(
|
|
4146
|
+
:text,
|
|
4147
|
+
:unknown)
|
|
4148
|
+
SENSITIVE = []
|
|
4149
|
+
include Aws::Structure
|
|
4150
|
+
include Aws::Structure::Union
|
|
4151
|
+
|
|
4152
|
+
class Text < ToolResultBlockDelta; end
|
|
4153
|
+
class Unknown < ToolResultBlockDelta; end
|
|
4154
|
+
end
|
|
4155
|
+
|
|
4156
|
+
# The start of a tool result block. For more information, see [Call a
|
|
4157
|
+
# tool with the Converse API][1] in the Amazon Bedrock User Guide.
|
|
4158
|
+
#
|
|
4159
|
+
#
|
|
4160
|
+
#
|
|
4161
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html
|
|
4162
|
+
#
|
|
4163
|
+
# @!attribute [rw] tool_use_id
|
|
4164
|
+
# The ID of the tool that was used to generate this tool result block.
|
|
4165
|
+
# @return [String]
|
|
4166
|
+
#
|
|
4167
|
+
# @!attribute [rw] type
|
|
4168
|
+
# The type for the tool that was used to generate this tool result
|
|
4169
|
+
# block.
|
|
4170
|
+
# @return [String]
|
|
4171
|
+
#
|
|
4172
|
+
# @!attribute [rw] status
|
|
4173
|
+
# The status of the tool result block.
|
|
4174
|
+
# @return [String]
|
|
4175
|
+
#
|
|
4176
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ToolResultBlockStart AWS API Documentation
|
|
4177
|
+
#
|
|
4178
|
+
class ToolResultBlockStart < Struct.new(
|
|
4179
|
+
:tool_use_id,
|
|
4180
|
+
:type,
|
|
4036
4181
|
:status)
|
|
4037
4182
|
SENSITIVE = []
|
|
4038
4183
|
include Aws::Structure
|
|
4039
4184
|
end
|
|
4040
4185
|
|
|
4041
|
-
# The tool result content block.
|
|
4186
|
+
# The tool result content block. For more information, see [Call a tool
|
|
4187
|
+
# with the Converse API][1] in the Amazon Bedrock User Guide.
|
|
4188
|
+
#
|
|
4189
|
+
#
|
|
4190
|
+
#
|
|
4191
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html
|
|
4042
4192
|
#
|
|
4043
4193
|
# @note ToolResultContentBlock is a union - when making an API calls you must set exactly one of the members.
|
|
4044
4194
|
#
|
|
@@ -4055,7 +4205,8 @@ module Aws::BedrockRuntime
|
|
|
4055
4205
|
# @!attribute [rw] image
|
|
4056
4206
|
# A tool result that is an image.
|
|
4057
4207
|
#
|
|
4058
|
-
# <note markdown="1"> This field is only supported by Anthropic Claude 3
|
|
4208
|
+
# <note markdown="1"> This field is only supported by Amazon Nova and Anthropic Claude 3
|
|
4209
|
+
# and 4 models.
|
|
4059
4210
|
#
|
|
4060
4211
|
# </note>
|
|
4061
4212
|
# @return [Types::ImageBlock]
|
|
@@ -4089,7 +4240,12 @@ module Aws::BedrockRuntime
|
|
|
4089
4240
|
class Unknown < ToolResultContentBlock; end
|
|
4090
4241
|
end
|
|
4091
4242
|
|
|
4092
|
-
# The specification for the tool.
|
|
4243
|
+
# The specification for the tool. For more information, see [Call a tool
|
|
4244
|
+
# with the Converse API][1] in the Amazon Bedrock User Guide.
|
|
4245
|
+
#
|
|
4246
|
+
#
|
|
4247
|
+
#
|
|
4248
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html
|
|
4093
4249
|
#
|
|
4094
4250
|
# @!attribute [rw] name
|
|
4095
4251
|
# The name for the tool.
|
|
@@ -4115,7 +4271,12 @@ module Aws::BedrockRuntime
|
|
|
4115
4271
|
|
|
4116
4272
|
# A tool use content block. Contains information about a tool that the
|
|
4117
4273
|
# model is requesting be run., The model uses the result from the tool
|
|
4118
|
-
# to generate a response.
|
|
4274
|
+
# to generate a response. For more information, see [Call a tool with
|
|
4275
|
+
# the Converse API][1] in the Amazon Bedrock User Guide.
|
|
4276
|
+
#
|
|
4277
|
+
#
|
|
4278
|
+
#
|
|
4279
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html
|
|
4119
4280
|
#
|
|
4120
4281
|
# @!attribute [rw] tool_use_id
|
|
4121
4282
|
# The ID for the tool request.
|
|
@@ -4129,12 +4290,17 @@ module Aws::BedrockRuntime
|
|
|
4129
4290
|
# The input to pass to the tool.
|
|
4130
4291
|
# @return [Hash,Array,String,Numeric,Boolean]
|
|
4131
4292
|
#
|
|
4293
|
+
# @!attribute [rw] type
|
|
4294
|
+
# The type for the tool request.
|
|
4295
|
+
# @return [String]
|
|
4296
|
+
#
|
|
4132
4297
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ToolUseBlock AWS API Documentation
|
|
4133
4298
|
#
|
|
4134
4299
|
class ToolUseBlock < Struct.new(
|
|
4135
4300
|
:tool_use_id,
|
|
4136
4301
|
:name,
|
|
4137
|
-
:input
|
|
4302
|
+
:input,
|
|
4303
|
+
:type)
|
|
4138
4304
|
SENSITIVE = []
|
|
4139
4305
|
include Aws::Structure
|
|
4140
4306
|
end
|
|
@@ -4153,7 +4319,12 @@ module Aws::BedrockRuntime
|
|
|
4153
4319
|
include Aws::Structure
|
|
4154
4320
|
end
|
|
4155
4321
|
|
|
4156
|
-
# The start of a tool use block.
|
|
4322
|
+
# The start of a tool use block. For more information, see [Call a tool
|
|
4323
|
+
# with the Converse API][1] in the Amazon Bedrock User Guide.
|
|
4324
|
+
#
|
|
4325
|
+
#
|
|
4326
|
+
#
|
|
4327
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html
|
|
4157
4328
|
#
|
|
4158
4329
|
# @!attribute [rw] tool_use_id
|
|
4159
4330
|
# The ID for the tool request.
|
|
@@ -4163,11 +4334,16 @@ module Aws::BedrockRuntime
|
|
|
4163
4334
|
# The name of the tool that the model is requesting to use.
|
|
4164
4335
|
# @return [String]
|
|
4165
4336
|
#
|
|
4337
|
+
# @!attribute [rw] type
|
|
4338
|
+
# The type for the tool request.
|
|
4339
|
+
# @return [String]
|
|
4340
|
+
#
|
|
4166
4341
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ToolUseBlockStart AWS API Documentation
|
|
4167
4342
|
#
|
|
4168
4343
|
class ToolUseBlockStart < Struct.new(
|
|
4169
4344
|
:tool_use_id,
|
|
4170
|
-
:name
|
|
4345
|
+
:name,
|
|
4346
|
+
:type)
|
|
4171
4347
|
SENSITIVE = []
|
|
4172
4348
|
include Aws::Structure
|
|
4173
4349
|
end
|
|
@@ -4248,6 +4424,26 @@ module Aws::BedrockRuntime
|
|
|
4248
4424
|
class Unknown < VideoSource; end
|
|
4249
4425
|
end
|
|
4250
4426
|
|
|
4427
|
+
# Provides the URL and domain information for the website that was cited
|
|
4428
|
+
# when performing a web search.
|
|
4429
|
+
#
|
|
4430
|
+
# @!attribute [rw] url
|
|
4431
|
+
# The URL that was cited when performing a web search.
|
|
4432
|
+
# @return [String]
|
|
4433
|
+
#
|
|
4434
|
+
# @!attribute [rw] domain
|
|
4435
|
+
# The domain that was cited when performing a web search.
|
|
4436
|
+
# @return [String]
|
|
4437
|
+
#
|
|
4438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/WebLocation AWS API Documentation
|
|
4439
|
+
#
|
|
4440
|
+
class WebLocation < Struct.new(
|
|
4441
|
+
:url,
|
|
4442
|
+
:domain)
|
|
4443
|
+
SENSITIVE = []
|
|
4444
|
+
include Aws::Structure
|
|
4445
|
+
end
|
|
4446
|
+
|
|
4251
4447
|
# The messages output stream
|
|
4252
4448
|
#
|
|
4253
4449
|
# EventStream is an Enumerator of Events.
|
data/sig/client.rbs
CHANGED
|
@@ -177,7 +177,8 @@ module Aws
|
|
|
177
177
|
tool_use_id: ::String,
|
|
178
178
|
name: ::String,
|
|
179
179
|
input: {
|
|
180
|
-
}
|
|
180
|
+
},
|
|
181
|
+
type: ("server_tool_use")?
|
|
181
182
|
}?,
|
|
182
183
|
tool_result: {
|
|
183
184
|
tool_use_id: ::String,
|
|
@@ -229,7 +230,8 @@ module Aws
|
|
|
229
230
|
}?
|
|
230
231
|
},
|
|
231
232
|
],
|
|
232
|
-
status: ("success" | "error")
|
|
233
|
+
status: ("success" | "error")?,
|
|
234
|
+
type: ::String?
|
|
233
235
|
}?,
|
|
234
236
|
guard_content: {
|
|
235
237
|
text: {
|
|
@@ -268,6 +270,10 @@ module Aws
|
|
|
268
270
|
},
|
|
269
271
|
]?,
|
|
270
272
|
location: {
|
|
273
|
+
web: {
|
|
274
|
+
url: ::String?,
|
|
275
|
+
domain: ::String?
|
|
276
|
+
}?,
|
|
271
277
|
document_char: {
|
|
272
278
|
document_index: ::Integer?,
|
|
273
279
|
start: ::Integer?,
|
|
@@ -328,6 +334,9 @@ module Aws
|
|
|
328
334
|
}?
|
|
329
335
|
}
|
|
330
336
|
}?,
|
|
337
|
+
system_tool: {
|
|
338
|
+
name: ::String
|
|
339
|
+
}?,
|
|
331
340
|
cache_point: {
|
|
332
341
|
type: ("default")
|
|
333
342
|
}?
|
|
@@ -419,7 +428,8 @@ module Aws
|
|
|
419
428
|
tool_use_id: ::String,
|
|
420
429
|
name: ::String,
|
|
421
430
|
input: {
|
|
422
|
-
}
|
|
431
|
+
},
|
|
432
|
+
type: ("server_tool_use")?
|
|
423
433
|
}?,
|
|
424
434
|
tool_result: {
|
|
425
435
|
tool_use_id: ::String,
|
|
@@ -471,7 +481,8 @@ module Aws
|
|
|
471
481
|
}?
|
|
472
482
|
},
|
|
473
483
|
],
|
|
474
|
-
status: ("success" | "error")
|
|
484
|
+
status: ("success" | "error")?,
|
|
485
|
+
type: ::String?
|
|
475
486
|
}?,
|
|
476
487
|
guard_content: {
|
|
477
488
|
text: {
|
|
@@ -510,6 +521,10 @@ module Aws
|
|
|
510
521
|
},
|
|
511
522
|
]?,
|
|
512
523
|
location: {
|
|
524
|
+
web: {
|
|
525
|
+
url: ::String?,
|
|
526
|
+
domain: ::String?
|
|
527
|
+
}?,
|
|
513
528
|
document_char: {
|
|
514
529
|
document_index: ::Integer?,
|
|
515
530
|
start: ::Integer?,
|
|
@@ -570,6 +585,9 @@ module Aws
|
|
|
570
585
|
}?
|
|
571
586
|
}
|
|
572
587
|
}?,
|
|
588
|
+
system_tool: {
|
|
589
|
+
name: ::String
|
|
590
|
+
}?,
|
|
573
591
|
cache_point: {
|
|
574
592
|
type: ("default")
|
|
575
593
|
}?
|
|
@@ -667,7 +685,8 @@ module Aws
|
|
|
667
685
|
tool_use_id: ::String,
|
|
668
686
|
name: ::String,
|
|
669
687
|
input: {
|
|
670
|
-
}
|
|
688
|
+
},
|
|
689
|
+
type: ("server_tool_use")?
|
|
671
690
|
}?,
|
|
672
691
|
tool_result: {
|
|
673
692
|
tool_use_id: ::String,
|
|
@@ -719,7 +738,8 @@ module Aws
|
|
|
719
738
|
}?
|
|
720
739
|
},
|
|
721
740
|
],
|
|
722
|
-
status: ("success" | "error")
|
|
741
|
+
status: ("success" | "error")?,
|
|
742
|
+
type: ::String?
|
|
723
743
|
}?,
|
|
724
744
|
guard_content: {
|
|
725
745
|
text: {
|
|
@@ -758,6 +778,10 @@ module Aws
|
|
|
758
778
|
},
|
|
759
779
|
]?,
|
|
760
780
|
location: {
|
|
781
|
+
web: {
|
|
782
|
+
url: ::String?,
|
|
783
|
+
domain: ::String?
|
|
784
|
+
}?,
|
|
761
785
|
document_char: {
|
|
762
786
|
document_index: ::Integer?,
|
|
763
787
|
start: ::Integer?,
|
data/sig/types.rbs
CHANGED
|
@@ -105,12 +105,15 @@ module Aws::BedrockRuntime
|
|
|
105
105
|
end
|
|
106
106
|
|
|
107
107
|
class CitationLocation
|
|
108
|
+
attr_accessor web: Types::WebLocation
|
|
108
109
|
attr_accessor document_char: Types::DocumentCharLocation
|
|
109
110
|
attr_accessor document_page: Types::DocumentPageLocation
|
|
110
111
|
attr_accessor document_chunk: Types::DocumentChunkLocation
|
|
111
112
|
attr_accessor unknown: untyped
|
|
112
113
|
SENSITIVE: []
|
|
113
114
|
|
|
115
|
+
class Web < CitationLocation
|
|
116
|
+
end
|
|
114
117
|
class DocumentChar < CitationLocation
|
|
115
118
|
end
|
|
116
119
|
class DocumentPage < CitationLocation
|
|
@@ -201,6 +204,7 @@ module Aws::BedrockRuntime
|
|
|
201
204
|
class ContentBlockDelta
|
|
202
205
|
attr_accessor text: ::String
|
|
203
206
|
attr_accessor tool_use: Types::ToolUseBlockDelta
|
|
207
|
+
attr_accessor tool_result: ::Array[Types::ToolResultBlockDelta]
|
|
204
208
|
attr_accessor reasoning_content: Types::ReasoningContentBlockDelta
|
|
205
209
|
attr_accessor citation: Types::CitationsDelta
|
|
206
210
|
attr_accessor unknown: untyped
|
|
@@ -210,6 +214,8 @@ module Aws::BedrockRuntime
|
|
|
210
214
|
end
|
|
211
215
|
class ToolUse < ContentBlockDelta
|
|
212
216
|
end
|
|
217
|
+
class ToolResult < ContentBlockDelta
|
|
218
|
+
end
|
|
213
219
|
class ReasoningContent < ContentBlockDelta
|
|
214
220
|
end
|
|
215
221
|
class Citation < ContentBlockDelta
|
|
@@ -227,11 +233,14 @@ module Aws::BedrockRuntime
|
|
|
227
233
|
|
|
228
234
|
class ContentBlockStart
|
|
229
235
|
attr_accessor tool_use: Types::ToolUseBlockStart
|
|
236
|
+
attr_accessor tool_result: Types::ToolResultBlockStart
|
|
230
237
|
attr_accessor unknown: untyped
|
|
231
238
|
SENSITIVE: []
|
|
232
239
|
|
|
233
240
|
class ToolUse < ContentBlockStart
|
|
234
241
|
end
|
|
242
|
+
class ToolResult < ContentBlockStart
|
|
243
|
+
end
|
|
235
244
|
class Unknown < ContentBlockStart
|
|
236
245
|
end
|
|
237
246
|
end
|
|
@@ -1074,6 +1083,11 @@ module Aws::BedrockRuntime
|
|
|
1074
1083
|
end
|
|
1075
1084
|
end
|
|
1076
1085
|
|
|
1086
|
+
class SystemTool
|
|
1087
|
+
attr_accessor name: ::String
|
|
1088
|
+
SENSITIVE: []
|
|
1089
|
+
end
|
|
1090
|
+
|
|
1077
1091
|
class Tag
|
|
1078
1092
|
attr_accessor key: ::String
|
|
1079
1093
|
attr_accessor value: ::String
|
|
@@ -1097,12 +1111,15 @@ module Aws::BedrockRuntime
|
|
|
1097
1111
|
|
|
1098
1112
|
class Tool
|
|
1099
1113
|
attr_accessor tool_spec: Types::ToolSpecification
|
|
1114
|
+
attr_accessor system_tool: Types::SystemTool
|
|
1100
1115
|
attr_accessor cache_point: Types::CachePointBlock
|
|
1101
1116
|
attr_accessor unknown: untyped
|
|
1102
1117
|
SENSITIVE: []
|
|
1103
1118
|
|
|
1104
1119
|
class ToolSpec < Tool
|
|
1105
1120
|
end
|
|
1121
|
+
class SystemTool < Tool
|
|
1122
|
+
end
|
|
1106
1123
|
class CachePoint < Tool
|
|
1107
1124
|
end
|
|
1108
1125
|
class Unknown < Tool
|
|
@@ -1147,6 +1164,25 @@ module Aws::BedrockRuntime
|
|
|
1147
1164
|
attr_accessor tool_use_id: ::String
|
|
1148
1165
|
attr_accessor content: ::Array[Types::ToolResultContentBlock]
|
|
1149
1166
|
attr_accessor status: ("success" | "error")
|
|
1167
|
+
attr_accessor type: ::String
|
|
1168
|
+
SENSITIVE: []
|
|
1169
|
+
end
|
|
1170
|
+
|
|
1171
|
+
class ToolResultBlockDelta
|
|
1172
|
+
attr_accessor text: ::String
|
|
1173
|
+
attr_accessor unknown: untyped
|
|
1174
|
+
SENSITIVE: []
|
|
1175
|
+
|
|
1176
|
+
class Text < ToolResultBlockDelta
|
|
1177
|
+
end
|
|
1178
|
+
class Unknown < ToolResultBlockDelta
|
|
1179
|
+
end
|
|
1180
|
+
end
|
|
1181
|
+
|
|
1182
|
+
class ToolResultBlockStart
|
|
1183
|
+
attr_accessor tool_use_id: ::String
|
|
1184
|
+
attr_accessor type: ::String
|
|
1185
|
+
attr_accessor status: ("success" | "error")
|
|
1150
1186
|
SENSITIVE: []
|
|
1151
1187
|
end
|
|
1152
1188
|
|
|
@@ -1184,6 +1220,7 @@ module Aws::BedrockRuntime
|
|
|
1184
1220
|
attr_accessor tool_use_id: ::String
|
|
1185
1221
|
attr_accessor name: ::String
|
|
1186
1222
|
attr_accessor input: untyped
|
|
1223
|
+
attr_accessor type: ("server_tool_use")
|
|
1187
1224
|
SENSITIVE: []
|
|
1188
1225
|
end
|
|
1189
1226
|
|
|
@@ -1195,6 +1232,7 @@ module Aws::BedrockRuntime
|
|
|
1195
1232
|
class ToolUseBlockStart
|
|
1196
1233
|
attr_accessor tool_use_id: ::String
|
|
1197
1234
|
attr_accessor name: ::String
|
|
1235
|
+
attr_accessor type: ("server_tool_use")
|
|
1198
1236
|
SENSITIVE: []
|
|
1199
1237
|
end
|
|
1200
1238
|
|
|
@@ -1224,6 +1262,12 @@ module Aws::BedrockRuntime
|
|
|
1224
1262
|
end
|
|
1225
1263
|
end
|
|
1226
1264
|
|
|
1265
|
+
class WebLocation
|
|
1266
|
+
attr_accessor url: ::String
|
|
1267
|
+
attr_accessor domain: ::String
|
|
1268
|
+
SENSITIVE: []
|
|
1269
|
+
end
|
|
1270
|
+
|
|
1227
1271
|
class ConverseStreamOutput < Enumerator[untyped, untyped]
|
|
1228
1272
|
def event_types: () -> [:message_start, :content_block_start, :content_block_delta, :content_block_stop, :message_stop, :metadata, :internal_server_exception, :model_stream_error_exception, :validation_exception, :throttling_exception, :service_unavailable_exception]
|
|
1229
1273
|
end
|