aws-sdk-bedrockruntime 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '018cc360f160c622096a32202404eaabe2ad23115886e6089f5fc96325ca39d9'
-  data.tar.gz: af955e1589a328c30bf3512f568bda00a7accd21c15fe2ff98bb89513e24b37e
+  metadata.gz: f590891a9fca80d3c4d905c4f212fb714fd8955351f7a4c7c0960117fcb28753
+  data.tar.gz: 66a18b65f050fb8b108420e7975b8a75589b42700867b5a7a7fe88d940054fa3
 SHA512:
-  metadata.gz: fbfb7db5193408a5c0ac3cc9ef06e11bb52fce61eb8fd13f5b63463043c57865a1a19fb197449bd73636b6a290846e3ced50dc32476f9ae9532b2be6a3206808
-  data.tar.gz: 81e0f4d90de18e7852b34b389a7c34f65a670844c944422942932e14da7dd7f88d5a7d00788f4edd08a9661e68898eab2b615198ed2ec311a4fd46c5a049fb8e
+  metadata.gz: e38f14601aeb0fe29fd426d7bc39c7225576cd965d9e12c3223fdfcfa390983e5f424b481c05a54c53d5abd69ea0afb768ad227911200ba3d6a611ffb8af4f83
+  data.tar.gz: 79ac35dda4056de19937e014f057940d6d24f735830a32e8a7715dc1aa6db6f3917bbd98e15a3078fa68c5c27fb6d4453ee8d2ce961ee1cd764017c9e91da9ed

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.12.0 (2024-06-20)
+------------------
+
+* Feature - This release adds document support to Converse and ConverseStream APIs
+
 1.11.0 (2024-06-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.11.0
+1.12.0

data/lib/aws-sdk-bedrockruntime/client.rb

@@ -551,6 +551,13 @@ module Aws::BedrockRuntime
     #                 bytes: "data",
     #               },
     #             },
+    #             document: {
+    #               format: "pdf", # required, accepts pdf, csv, doc, docx, xls, xlsx, html, txt, md
+    #               name: "DocumentBlockNameString", # required
+    #               source: { # required
+    #                 bytes: "data",
+    #               },
+    #             },
     #             tool_use: {
     #               tool_use_id: "ToolUseId", # required
     #               name: "ToolName", # required
@@ -570,6 +577,13 @@ module Aws::BedrockRuntime
     #                       bytes: "data",
     #                     },
     #                   },
+    #                   document: {
+    #                     format: "pdf", # required, accepts pdf, csv, doc, docx, xls, xlsx, html, txt, md
+    #                     name: "DocumentBlockNameString", # required
+    #                     source: { # required
+    #                       bytes: "data",
+    #                     },
+    #                   },
     #                 },
     #               ],
     #               status: "success", # accepts success, error
@@ -639,6 +653,9 @@ module Aws::BedrockRuntime
     #   resp.output.message.content[0].text #=> String
     #   resp.output.message.content[0].image.format #=> String, one of "png", "jpeg", "gif", "webp"
     #   resp.output.message.content[0].image.source.bytes #=> String
+    #   resp.output.message.content[0].document.format #=> String, one of "pdf", "csv", "doc", "docx", "xls", "xlsx", "html", "txt", "md"
+    #   resp.output.message.content[0].document.name #=> String
+    #   resp.output.message.content[0].document.source.bytes #=> String
     #   resp.output.message.content[0].tool_use.tool_use_id #=> String
     #   resp.output.message.content[0].tool_use.name #=> String
     #   resp.output.message.content[0].tool_result.tool_use_id #=> String
@@ -646,6 +663,9 @@ module Aws::BedrockRuntime
     #   resp.output.message.content[0].tool_result.content[0].text #=> String
     #   resp.output.message.content[0].tool_result.content[0].image.format #=> String, one of "png", "jpeg", "gif", "webp"
     #   resp.output.message.content[0].tool_result.content[0].image.source.bytes #=> String
+    #   resp.output.message.content[0].tool_result.content[0].document.format #=> String, one of "pdf", "csv", "doc", "docx", "xls", "xlsx", "html", "txt", "md"
+    #   resp.output.message.content[0].tool_result.content[0].document.name #=> String
+    #   resp.output.message.content[0].tool_result.content[0].document.source.bytes #=> String
     #   resp.output.message.content[0].tool_result.status #=> String, one of "success", "error"
     #   resp.output.message.content[0].guard_content.text.text #=> String
     #   resp.stop_reason #=> String, one of "end_turn", "tool_use", "max_tokens", "stop_sequence", "guardrail_intervened", "content_filtered"
@@ -1005,6 +1025,13 @@ module Aws::BedrockRuntime
     #                 bytes: "data",
     #               },
     #             },
+    #             document: {
+    #               format: "pdf", # required, accepts pdf, csv, doc, docx, xls, xlsx, html, txt, md
+    #               name: "DocumentBlockNameString", # required
+    #               source: { # required
+    #                 bytes: "data",
+    #               },
+    #             },
     #             tool_use: {
     #               tool_use_id: "ToolUseId", # required
     #               name: "ToolName", # required
@@ -1024,6 +1051,13 @@ module Aws::BedrockRuntime
     #                       bytes: "data",
     #                     },
     #                   },
+    #                   document: {
+    #                     format: "pdf", # required, accepts pdf, csv, doc, docx, xls, xlsx, html, txt, md
+    #                     name: "DocumentBlockNameString", # required
+    #                     source: { # required
+    #                       bytes: "data",
+    #                     },
+    #                   },
     #                 },
     #               ],
     #               status: "success", # accepts success, error
@@ -1619,7 +1653,7 @@ module Aws::BedrockRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-bedrockruntime'
-      context[:gem_version] = '1.11.0'
+      context[:gem_version] = '1.12.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-bedrockruntime/client_api.rb

@@ -42,6 +42,11 @@ module Aws::BedrockRuntime
     ConverseStreamTrace = Shapes::StructureShape.new(name: 'ConverseStreamTrace')
     ConverseTrace = Shapes::StructureShape.new(name: 'ConverseTrace')
     Document = Shapes::DocumentShape.new(name: 'Document', document: true)
+    DocumentBlock = Shapes::StructureShape.new(name: 'DocumentBlock')
+    DocumentBlockNameString = Shapes::StringShape.new(name: 'DocumentBlockNameString')
+    DocumentFormat = Shapes::StringShape.new(name: 'DocumentFormat')
+    DocumentSource = Shapes::UnionShape.new(name: 'DocumentSource')
+    DocumentSourceBytesBlob = Shapes::BlobShape.new(name: 'DocumentSourceBytesBlob')
     GuardrailAssessment = Shapes::StructureShape.new(name: 'GuardrailAssessment')
     GuardrailAssessmentList = Shapes::ListShape.new(name: 'GuardrailAssessmentList')
     GuardrailAssessmentListMap = Shapes::MapShape.new(name: 'GuardrailAssessmentListMap')
@@ -153,12 +158,14 @@ module Aws::BedrockRuntime
 
     ContentBlock.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "text"))
     ContentBlock.add_member(:image, Shapes::ShapeRef.new(shape: ImageBlock, location_name: "image"))
+    ContentBlock.add_member(:document, Shapes::ShapeRef.new(shape: DocumentBlock, location_name: "document"))
     ContentBlock.add_member(:tool_use, Shapes::ShapeRef.new(shape: ToolUseBlock, location_name: "toolUse"))
     ContentBlock.add_member(:tool_result, Shapes::ShapeRef.new(shape: ToolResultBlock, location_name: "toolResult"))
     ContentBlock.add_member(:guard_content, Shapes::ShapeRef.new(shape: GuardrailConverseContentBlock, location_name: "guardContent"))
     ContentBlock.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
     ContentBlock.add_member_subclass(:text, Types::ContentBlock::Text)
     ContentBlock.add_member_subclass(:image, Types::ContentBlock::Image)
+    ContentBlock.add_member_subclass(:document, Types::ContentBlock::Document)
     ContentBlock.add_member_subclass(:tool_use, Types::ContentBlock::ToolUse)
     ContentBlock.add_member_subclass(:tool_result, Types::ContentBlock::ToolResult)
     ContentBlock.add_member_subclass(:guard_content, Types::ContentBlock::GuardContent)
@@ -264,6 +271,17 @@ module Aws::BedrockRuntime
     ConverseTrace.add_member(:guardrail, Shapes::ShapeRef.new(shape: GuardrailTraceAssessment, location_name: "guardrail"))
     ConverseTrace.struct_class = Types::ConverseTrace
 
+    DocumentBlock.add_member(:format, Shapes::ShapeRef.new(shape: DocumentFormat, required: true, location_name: "format"))
+    DocumentBlock.add_member(:name, Shapes::ShapeRef.new(shape: DocumentBlockNameString, required: true, location_name: "name"))
+    DocumentBlock.add_member(:source, Shapes::ShapeRef.new(shape: DocumentSource, required: true, location_name: "source"))
+    DocumentBlock.struct_class = Types::DocumentBlock
+
+    DocumentSource.add_member(:bytes, Shapes::ShapeRef.new(shape: DocumentSourceBytesBlob, location_name: "bytes"))
+    DocumentSource.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
+    DocumentSource.add_member_subclass(:bytes, Types::DocumentSource::Bytes)
+    DocumentSource.add_member_subclass(:unknown, Types::DocumentSource::Unknown)
+    DocumentSource.struct_class = Types::DocumentSource
+
     GuardrailAssessment.add_member(:topic_policy, Shapes::ShapeRef.new(shape: GuardrailTopicPolicyAssessment, location_name: "topicPolicy"))
     GuardrailAssessment.add_member(:content_policy, Shapes::ShapeRef.new(shape: GuardrailContentPolicyAssessment, location_name: "contentPolicy"))
     GuardrailAssessment.add_member(:word_policy, Shapes::ShapeRef.new(shape: GuardrailWordPolicyAssessment, location_name: "wordPolicy"))
@@ -519,10 +537,12 @@ module Aws::BedrockRuntime
     ToolResultContentBlock.add_member(:json, Shapes::ShapeRef.new(shape: Document, location_name: "json"))
     ToolResultContentBlock.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "text"))
     ToolResultContentBlock.add_member(:image, Shapes::ShapeRef.new(shape: ImageBlock, location_name: "image"))
+    ToolResultContentBlock.add_member(:document, Shapes::ShapeRef.new(shape: DocumentBlock, location_name: "document"))
     ToolResultContentBlock.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
     ToolResultContentBlock.add_member_subclass(:json, Types::ToolResultContentBlock::Json)
     ToolResultContentBlock.add_member_subclass(:text, Types::ToolResultContentBlock::Text)
     ToolResultContentBlock.add_member_subclass(:image, Types::ToolResultContentBlock::Image)
+    ToolResultContentBlock.add_member_subclass(:document, Types::ToolResultContentBlock::Document)
     ToolResultContentBlock.add_member_subclass(:unknown, Types::ToolResultContentBlock::Unknown)
     ToolResultContentBlock.struct_class = Types::ToolResultContentBlock
 

data/lib/aws-sdk-bedrockruntime/types.rb

@@ -60,6 +60,10 @@ module Aws::BedrockRuntime
     #    </note>
     #   @return [Types::ImageBlock]
     #
+    # @!attribute [rw] document
+    #   A document to include in the message.
+    #   @return [Types::DocumentBlock]
+    #
     # @!attribute [rw] tool_use
     #   Information about a tool use request from a model.
     #   @return [Types::ToolUseBlock]
@@ -82,6 +86,7 @@ module Aws::BedrockRuntime
     class ContentBlock < Struct.new(
       :text,
       :image,
+      :document,
       :tool_use,
       :tool_result,
       :guard_content,
@@ -92,6 +97,7 @@ module Aws::BedrockRuntime
 
       class Text < ContentBlock; end
       class Image < ContentBlock; end
+      class Document < ContentBlock; end
       class ToolUse < ContentBlock; end
       class ToolResult < ContentBlock; end
       class GuardContent < ContentBlock; end
@@ -564,6 +570,68 @@ module Aws::BedrockRuntime
       include Aws::Structure
     end
 
+    # A document to include in a message when sending a [Converse][1] or
+    # [ConverseStream][2] request. You can include up to 5 documents in a
+    # request. The maximum document size is 50 MB.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html
+    #
+    # @!attribute [rw] format
+    #   The format of a document, or its extension.
+    #   @return [String]
+    #
+    # @!attribute [rw] name
+    #   A name for the document.
+    #   @return [String]
+    #
+    # @!attribute [rw] source
+    #   Contains the content of the document.
+    #   @return [Types::DocumentSource]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/DocumentBlock AWS API Documentation
+    #
+    class DocumentBlock < Struct.new(
+      :format,
+      :name,
+      :source)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Contains the content of the document included in a message when
+    # sending a [Converse][1] or [ConverseStream][2] request or in the
+    # response.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html
+    #
+    # @note DocumentSource is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @note DocumentSource is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DocumentSource corresponding to the set member.
+    #
+    # @!attribute [rw] bytes
+    #   A base64-encoded string of a UTF-8 encoded file, that is the
+    #   document to include in the message.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/DocumentSource AWS API Documentation
+    #
+    class DocumentSource < Struct.new(
+      :bytes,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class Bytes < DocumentSource; end
+      class Unknown < DocumentSource; end
+    end
+
     # A behavior assessment of the guardrail policies used in a call to the
     # Converse API.
     #
@@ -1704,12 +1772,17 @@ module Aws::BedrockRuntime
     #    </note>
     #   @return [Types::ImageBlock]
     #
+    # @!attribute [rw] document
+    #   A tool result that is a document.
+    #   @return [Types::DocumentBlock]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ToolResultContentBlock AWS API Documentation
     #
     class ToolResultContentBlock < Struct.new(
       :json,
       :text,
       :image,
+      :document,
       :unknown)
       SENSITIVE = []
       include Aws::Structure
@@ -1718,6 +1791,7 @@ module Aws::BedrockRuntime
       class Json < ToolResultContentBlock; end
       class Text < ToolResultContentBlock; end
       class Image < ToolResultContentBlock; end
+      class Document < ToolResultContentBlock; end
       class Unknown < ToolResultContentBlock; end
     end
 

data/lib/aws-sdk-bedrockruntime.rb

@@ -54,6 +54,6 @@ require_relative 'aws-sdk-bedrockruntime/event_streams'
 # @!group service
 module Aws::BedrockRuntime
 
-  GEM_VERSION = '1.11.0'
+  GEM_VERSION = '1.12.0'
 
 end

data/sig/client.rbs

@@ -99,6 +99,13 @@ module Aws
                                   bytes: ::String?
                                 }
                               }?,
+                              document: {
+                                format: ("pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md"),
+                                name: ::String,
+                                source: {
+                                  bytes: ::String?
+                                }
+                              }?,
                               tool_use: {
                                 tool_use_id: ::String,
                                 name: ::String,
@@ -117,6 +124,13 @@ module Aws
                                       source: {
                                         bytes: ::String?
                                       }
+                                    }?,
+                                    document: {
+                                      format: ("pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md"),
+                                      name: ::String,
+                                      source: {
+                                        bytes: ::String?
+                                      }
                                     }?
                                   },
                                 ],
@@ -200,6 +214,13 @@ module Aws
                                          bytes: ::String?
                                        }
                                      }?,
+                                     document: {
+                                       format: ("pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md"),
+                                       name: ::String,
+                                       source: {
+                                         bytes: ::String?
+                                       }
+                                     }?,
                                      tool_use: {
                                        tool_use_id: ::String,
                                        name: ::String,
@@ -218,6 +239,13 @@ module Aws
                                              source: {
                                                bytes: ::String?
                                              }
+                                           }?,
+                                           document: {
+                                             format: ("pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md"),
+                                             name: ::String,
+                                             source: {
+                                               bytes: ::String?
+                                             }
                                            }?
                                          },
                                        ],

data/sig/types.rbs

@@ -22,6 +22,7 @@ module Aws::BedrockRuntime
     class ContentBlock
       attr_accessor text: ::String
       attr_accessor image: Types::ImageBlock
+      attr_accessor document: Types::DocumentBlock
       attr_accessor tool_use: Types::ToolUseBlock
       attr_accessor tool_result: Types::ToolResultBlock
       attr_accessor guard_content: Types::GuardrailConverseContentBlock
@@ -32,6 +33,8 @@ module Aws::BedrockRuntime
       end
       class Image < ContentBlock
       end
+      class Document < ContentBlock
+      end
       class ToolUse < ContentBlock
       end
       class ToolResult < ContentBlock
@@ -165,6 +168,24 @@ module Aws::BedrockRuntime
       SENSITIVE: []
     end
 
+    class DocumentBlock
+      attr_accessor format: ("pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md")
+      attr_accessor name: ::String
+      attr_accessor source: Types::DocumentSource
+      SENSITIVE: []
+    end
+
+    class DocumentSource
+      attr_accessor bytes: ::String
+      attr_accessor unknown: untyped
+      SENSITIVE: []
+
+      class Bytes < DocumentSource
+      end
+      class Unknown < DocumentSource
+      end
+    end
+
     class GuardrailAssessment
       attr_accessor topic_policy: Types::GuardrailTopicPolicyAssessment
       attr_accessor content_policy: Types::GuardrailContentPolicyAssessment
@@ -489,6 +510,7 @@ module Aws::BedrockRuntime
       attr_accessor json: untyped
       attr_accessor text: ::String
       attr_accessor image: Types::ImageBlock
+      attr_accessor document: Types::DocumentBlock
       attr_accessor unknown: untyped
       SENSITIVE: []
 
@@ -498,6 +520,8 @@ module Aws::BedrockRuntime
       end
       class Image < ToolResultContentBlock
       end
+      class Document < ToolResultContentBlock
+      end
       class Unknown < ToolResultContentBlock
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-bedrockruntime
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core