aws-sdk-bedrockruntime 1.49.0 → 1.50.0

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

@@ -272,6 +272,217 @@ module Aws::BedrockRuntime
       include Aws::Structure
     end
 
+    # Contains information about a citation that references a specific
+    # source document. Citations provide traceability between the model's
+    # generated response and the source documents that informed that
+    # response.
+    #
+    # @!attribute [rw] title
+    #   The title or identifier of the source document being cited.
+    #   @return [String]
+    #
+    # @!attribute [rw] source_content
+    #   The specific content from the source document that was referenced or
+    #   cited in the generated response.
+    #   @return [Array<Types::CitationSourceContent>]
+    #
+    # @!attribute [rw] location
+    #   The precise location within the source document where the cited
+    #   content can be found, including character positions, page numbers,
+    #   or chunk identifiers.
+    #   @return [Types::CitationLocation]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/Citation AWS API Documentation
+    #
+    class Citation < Struct.new(
+      :title,
+      :source_content,
+      :location)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Contains the generated text content that corresponds to or is
+    # supported by a citation from a source document.
+    #
+    # @note CitationGeneratedContent is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @note CitationGeneratedContent is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of CitationGeneratedContent corresponding to the set member.
+    #
+    # @!attribute [rw] text
+    #   The text content that was generated by the model and is supported by
+    #   the associated citation.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/CitationGeneratedContent AWS API Documentation
+    #
+    class CitationGeneratedContent < Struct.new(
+      :text,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class Text < CitationGeneratedContent; end
+      class Unknown < CitationGeneratedContent; end
+    end
+
+    # Specifies the precise location within a source document where cited
+    # content can be found. This can include character-level positions, page
+    # numbers, or document chunks depending on the document type and
+    # indexing method.
+    #
+    # @note CitationLocation is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @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.
+    #
+    # @!attribute [rw] document_char
+    #   The character-level location within the document where the cited
+    #   content is found.
+    #   @return [Types::DocumentCharLocation]
+    #
+    # @!attribute [rw] document_page
+    #   The page-level location within the document where the cited content
+    #   is found.
+    #   @return [Types::DocumentPageLocation]
+    #
+    # @!attribute [rw] document_chunk
+    #   The chunk-level location within the document where the cited content
+    #   is found, typically used for documents that have been segmented into
+    #   logical chunks.
+    #   @return [Types::DocumentChunkLocation]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/CitationLocation AWS API Documentation
+    #
+    class CitationLocation < Struct.new(
+      :document_char,
+      :document_page,
+      :document_chunk,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class DocumentChar < CitationLocation; end
+      class DocumentPage < CitationLocation; end
+      class DocumentChunk < CitationLocation; end
+      class Unknown < CitationLocation; end
+    end
+
+    # Contains the actual text content from a source document that is being
+    # cited or referenced in the model's response.
+    #
+    # @note CitationSourceContent is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @note CitationSourceContent is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of CitationSourceContent corresponding to the set member.
+    #
+    # @!attribute [rw] text
+    #   The text content from the source document that is being cited.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/CitationSourceContent AWS API Documentation
+    #
+    class CitationSourceContent < Struct.new(
+      :text,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class Text < CitationSourceContent; end
+      class Unknown < CitationSourceContent; end
+    end
+
+    # Contains incremental updates to the source content text during
+    # streaming responses, allowing clients to build up the cited content
+    # progressively.
+    #
+    # @!attribute [rw] text
+    #   An incremental update to the text content from the source document
+    #   that is being cited.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/CitationSourceContentDelta AWS API Documentation
+    #
+    class CitationSourceContentDelta < Struct.new(
+      :text)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Configuration settings for enabling and controlling document citations
+    # in Converse API responses. When enabled, the model can include
+    # citation information that links generated content back to specific
+    # source documents.
+    #
+    # @!attribute [rw] enabled
+    #   Specifies whether document citations should be included in the
+    #   model's response. When set to true, the model can generate
+    #   citations that reference the source documents used to inform the
+    #   response.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/CitationsConfig AWS API Documentation
+    #
+    class CitationsConfig < Struct.new(
+      :enabled)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A content block that contains both generated text and associated
+    # citation information. This block type is returned when document
+    # citations are enabled, providing traceability between the generated
+    # content and the source documents that informed the response.
+    #
+    # @!attribute [rw] content
+    #   The generated content that is supported by the associated citations.
+    #   @return [Array<Types::CitationGeneratedContent>]
+    #
+    # @!attribute [rw] citations
+    #   An array of citations that reference the source documents used to
+    #   generate the associated content.
+    #   @return [Array<Types::Citation>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/CitationsContentBlock AWS API Documentation
+    #
+    class CitationsContentBlock < Struct.new(
+      :content,
+      :citations)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Contains incremental updates to citation information during streaming
+    # responses. This allows clients to build up citation data progressively
+    # as the response is generated.
+    #
+    # @!attribute [rw] title
+    #   The title or identifier of the source document being cited.
+    #   @return [String]
+    #
+    # @!attribute [rw] source_content
+    #   The specific content from the source document that was referenced or
+    #   cited in the generated response.
+    #   @return [Array<Types::CitationSourceContentDelta>]
+    #
+    # @!attribute [rw] location
+    #   Specifies the precise location within a source document where cited
+    #   content can be found. This can include character-level positions,
+    #   page numbers, or document chunks depending on the document type and
+    #   indexing method.
+    #   @return [Types::CitationLocation]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/CitationsDelta AWS API Documentation
+    #
+    class CitationsDelta < Struct.new(
+      :title,
+      :source_content,
+      :location)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Error occurred because of a conflict while performing an operation.
     #
     # @!attribute [rw] message
@@ -331,7 +542,7 @@ module Aws::BedrockRuntime
     #   (if passed in the Converse API) assesses the entire message.
     #
     #   For more information, see *Use a guardrail with the Converse API* in
-    #   the *Amazon Bedrock User Guide*.      </p>
+    #   the *Amazon Bedrock User Guide*.
     #   @return [Types::GuardrailConverseContentBlock]
     #
     # @!attribute [rw] cache_point
@@ -344,6 +555,12 @@ module Aws::BedrockRuntime
     #   generates to enhance the accuracy of its final response.
     #   @return [Types::ReasoningContentBlock]
     #
+    # @!attribute [rw] citations_content
+    #   A content block that contains both generated text and associated
+    #   citation information, providing traceability between the response
+    #   and source documents.
+    #   @return [Types::CitationsContentBlock]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ContentBlock AWS API Documentation
     #
     class ContentBlock < Struct.new(
@@ -356,6 +573,7 @@ module Aws::BedrockRuntime
       :guard_content,
       :cache_point,
       :reasoning_content,
+      :citations_content,
       :unknown)
       SENSITIVE = [:reasoning_content]
       include Aws::Structure
@@ -370,6 +588,7 @@ module Aws::BedrockRuntime
       class GuardContent < ContentBlock; end
       class CachePoint < ContentBlock; end
       class ReasoningContent < ContentBlock; end
+      class CitationsContent < ContentBlock; end
       class Unknown < ContentBlock; end
     end
 
@@ -391,12 +610,18 @@ module Aws::BedrockRuntime
     #   generates to enhance the accuracy of its final response.
     #   @return [Types::ReasoningContentBlockDelta]
     #
+    # @!attribute [rw] citation
+    #   Incremental citation information that is streamed as part of the
+    #   response generation process.
+    #   @return [Types::CitationsDelta]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ContentBlockDelta AWS API Documentation
     #
     class ContentBlockDelta < Struct.new(
       :text,
       :tool_use,
       :reasoning_content,
+      :citation,
       :unknown)
       SENSITIVE = [:reasoning_content]
       include Aws::Structure
@@ -405,6 +630,7 @@ module Aws::BedrockRuntime
       class Text < ContentBlockDelta; end
       class ToolUse < ContentBlockDelta; end
       class ReasoningContent < ContentBlockDelta; end
+      class Citation < ContentBlockDelta; end
       class Unknown < ContentBlockDelta; end
     end
 
@@ -997,12 +1223,132 @@ module Aws::BedrockRuntime
     #   Contains the content of the document.
     #   @return [Types::DocumentSource]
     #
+    # @!attribute [rw] context
+    #   Contextual information about how the document should be processed or
+    #   interpreted by the model when generating citations.
+    #   @return [String]
+    #
+    # @!attribute [rw] citations
+    #   Configuration settings that control how citations should be
+    #   generated for this specific document.
+    #   @return [Types::CitationsConfig]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/DocumentBlock AWS API Documentation
     #
     class DocumentBlock < Struct.new(
       :format,
       :name,
-      :source)
+      :source,
+      :context,
+      :citations)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Specifies a character-level location within a document, providing
+    # precise positioning information for cited content using start and end
+    # character indices.
+    #
+    # @!attribute [rw] document_index
+    #   The index of the document within the array of documents provided in
+    #   the request.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] start
+    #   The starting character position of the cited content within the
+    #   document.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] end
+    #   The ending character position of the cited content within the
+    #   document.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/DocumentCharLocation AWS API Documentation
+    #
+    class DocumentCharLocation < Struct.new(
+      :document_index,
+      :start,
+      :end)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Specifies a chunk-level location within a document, providing
+    # positioning information for cited content using logical document
+    # segments or chunks.
+    #
+    # @!attribute [rw] document_index
+    #   The index of the document within the array of documents provided in
+    #   the request.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] start
+    #   The starting chunk identifier or index of the cited content within
+    #   the document.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] end
+    #   The ending chunk identifier or index of the cited content within the
+    #   document.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/DocumentChunkLocation AWS API Documentation
+    #
+    class DocumentChunkLocation < Struct.new(
+      :document_index,
+      :start,
+      :end)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Contains the actual content of a document that can be processed by the
+    # model and potentially cited in the response.
+    #
+    # @note DocumentContentBlock is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @note DocumentContentBlock is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DocumentContentBlock corresponding to the set member.
+    #
+    # @!attribute [rw] text
+    #   The text content of the document.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/DocumentContentBlock AWS API Documentation
+    #
+    class DocumentContentBlock < Struct.new(
+      :text,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class Text < DocumentContentBlock; end
+      class Unknown < DocumentContentBlock; end
+    end
+
+    # Specifies a page-level location within a document, providing
+    # positioning information for cited content using page numbers.
+    #
+    # @!attribute [rw] document_index
+    #   The index of the document within the array of documents provided in
+    #   the request.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] start
+    #   The starting page number of the cited content within the document.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] end
+    #   The ending page number of the cited content within the document.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/DocumentPageLocation AWS API Documentation
+    #
+    class DocumentPageLocation < Struct.new(
+      :document_index,
+      :start,
+      :end)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1028,11 +1374,23 @@ module Aws::BedrockRuntime
     #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-supported-models-features.html
     #   @return [Types::S3Location]
     #
+    # @!attribute [rw] text
+    #   The text content of the document source.
+    #   @return [String]
+    #
+    # @!attribute [rw] content
+    #   The structured content of the document source, which may include
+    #   various content blocks such as text, images, or other document
+    #   elements.
+    #   @return [Array<Types::DocumentContentBlock>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/DocumentSource AWS API Documentation
     #
     class DocumentSource < Struct.new(
       :bytes,
       :s3_location,
+      :text,
+      :content,
       :unknown)
       SENSITIVE = []
       include Aws::Structure
@@ -1040,6 +1398,8 @@ module Aws::BedrockRuntime
 
       class Bytes < DocumentSource; end
       class S3Location < DocumentSource; end
+      class Text < DocumentSource; end
+      class Content < DocumentSource; end
       class Unknown < DocumentSource; end
     end
 
@@ -2069,10 +2429,11 @@ module Aws::BedrockRuntime
     #     Throughput. For more information, see [Run inference using a
     #     Provisioned Throughput][3] in the Amazon Bedrock User Guide.
     #
-    #   * If you use a custom model, first purchase Provisioned Throughput
-    #     for it. Then specify the ARN of the resulting provisioned model.
-    #     For more information, see [Use a custom model in Amazon
-    #     Bedrock][4] in the Amazon Bedrock User Guide.
+    #   * If you use a custom model, specify the ARN of the custom model
+    #     deployment (for on-demand inference) or the ARN of your
+    #     provisioned model (for Provisioned Throughput). For more
+    #     information, see [Use a custom model in Amazon Bedrock][4] in the
+    #     Amazon Bedrock User Guide.
     #
     #   * If you use an [imported model][5], specify the ARN of the imported
     #     model. You can get the model ARN from a successful call to
@@ -2245,10 +2606,11 @@ module Aws::BedrockRuntime
     #     Throughput. For more information, see [Run inference using a
     #     Provisioned Throughput][3] in the Amazon Bedrock User Guide.
     #
-    #   * If you use a custom model, first purchase Provisioned Throughput
-    #     for it. Then specify the ARN of the resulting provisioned model.
-    #     For more information, see [Use a custom model in Amazon
-    #     Bedrock][4] in the Amazon Bedrock User Guide.
+    #   * If you use a custom model, specify the ARN of the custom model
+    #     deployment (for on-demand inference) or the ARN of your
+    #     provisioned model (for Provisioned Throughput). For more
+    #     information, see [Use a custom model in Amazon Bedrock][4] in the
+    #     Amazon Bedrock User Guide.
     #
     #   * If you use an [imported model][5], specify the ARN of the imported
     #     model. You can get the model ARN from a successful call to

data/lib/aws-sdk-bedrockruntime.rb

@@ -57,7 +57,7 @@ module Aws::BedrockRuntime
   autoload :AsyncClient, 'aws-sdk-bedrockruntime/async_client'
   autoload :EventStreams, 'aws-sdk-bedrockruntime/event_streams'
 
-  GEM_VERSION = '1.49.0'
+  GEM_VERSION = '1.50.0'
 
 end
 

data/sig/client.rbs

@@ -142,15 +142,25 @@ module Aws
                                 }
                               }?,
                               document: {
-                                format: ("pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md"),
+                                format: ("pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md")?,
                                 name: ::String,
                                 source: {
                                   bytes: ::String?,
                                   s3_location: {
                                     uri: ::String,
                                     bucket_owner: ::String?
-                                  }?
-                                }
+                                  }?,
+                                  text: ::String?,
+                                  content: Array[
+                                    {
+                                      text: ::String?
+                                    },
+                                  ]?
+                                },
+                                context: ::String?,
+                                citations: {
+                                  enabled: bool
+                                }?
                               }?,
                               video: {
                                 format: ("mkv" | "mov" | "mp4" | "webm" | "flv" | "mpeg" | "mpg" | "wmv" | "three_gp"),
@@ -186,15 +196,25 @@ module Aws
                                       }
                                     }?,
                                     document: {
-                                      format: ("pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md"),
+                                      format: ("pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md")?,
                                       name: ::String,
                                       source: {
                                         bytes: ::String?,
                                         s3_location: {
                                           uri: ::String,
                                           bucket_owner: ::String?
-                                        }?
-                                      }
+                                        }?,
+                                        text: ::String?,
+                                        content: Array[
+                                          {
+                                            text: ::String?
+                                          },
+                                        ]?
+                                      },
+                                      context: ::String?,
+                                      citations: {
+                                        enabled: bool
+                                      }?
                                     }?,
                                     video: {
                                       format: ("mkv" | "mov" | "mp4" | "webm" | "flv" | "mpeg" | "mpg" | "wmv" | "three_gp"),
@@ -231,6 +251,40 @@ module Aws
                                   signature: ::String?
                                 }?,
                                 redacted_content: ::String?
+                              }?,
+                              citations_content: {
+                                content: Array[
+                                  {
+                                    text: ::String?
+                                  },
+                                ]?,
+                                citations: Array[
+                                  {
+                                    title: ::String?,
+                                    source_content: Array[
+                                      {
+                                        text: ::String?
+                                      },
+                                    ]?,
+                                    location: {
+                                      document_char: {
+                                        document_index: ::Integer?,
+                                        start: ::Integer?,
+                                        end: ::Integer?
+                                      }?,
+                                      document_page: {
+                                        document_index: ::Integer?,
+                                        start: ::Integer?,
+                                        end: ::Integer?
+                                      }?,
+                                      document_chunk: {
+                                        document_index: ::Integer?,
+                                        start: ::Integer?,
+                                        end: ::Integer?
+                                      }?
+                                    }?
+                                  },
+                                ]?
                               }?
                             },
                           ]
@@ -330,15 +384,25 @@ module Aws
                                        }
                                      }?,
                                      document: {
-                                       format: ("pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md"),
+                                       format: ("pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md")?,
                                        name: ::String,
                                        source: {
                                          bytes: ::String?,
                                          s3_location: {
                                            uri: ::String,
                                            bucket_owner: ::String?
-                                         }?
-                                       }
+                                         }?,
+                                         text: ::String?,
+                                         content: Array[
+                                           {
+                                             text: ::String?
+                                           },
+                                         ]?
+                                       },
+                                       context: ::String?,
+                                       citations: {
+                                         enabled: bool
+                                       }?
                                      }?,
                                      video: {
                                        format: ("mkv" | "mov" | "mp4" | "webm" | "flv" | "mpeg" | "mpg" | "wmv" | "three_gp"),
@@ -374,15 +438,25 @@ module Aws
                                              }
                                            }?,
                                            document: {
-                                             format: ("pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md"),
+                                             format: ("pdf" | "csv" | "doc" | "docx" | "xls" | "xlsx" | "html" | "txt" | "md")?,
                                              name: ::String,
                                              source: {
                                                bytes: ::String?,
                                                s3_location: {
                                                  uri: ::String,
                                                  bucket_owner: ::String?
-                                               }?
-                                             }
+                                               }?,
+                                               text: ::String?,
+                                               content: Array[
+                                                 {
+                                                   text: ::String?
+                                                 },
+                                               ]?
+                                             },
+                                             context: ::String?,
+                                             citations: {
+                                               enabled: bool
+                                             }?
                                            }?,
                                            video: {
                                              format: ("mkv" | "mov" | "mp4" | "webm" | "flv" | "mpeg" | "mpg" | "wmv" | "three_gp"),
@@ -419,6 +493,40 @@ module Aws
                                          signature: ::String?
                                        }?,
                                        redacted_content: ::String?
+                                     }?,
+                                     citations_content: {
+                                       content: Array[
+                                         {
+                                           text: ::String?
+                                         },
+                                       ]?,
+                                       citations: Array[
+                                         {
+                                           title: ::String?,
+                                           source_content: Array[
+                                             {
+                                               text: ::String?
+                                             },
+                                           ]?,
+                                           location: {
+                                             document_char: {
+                                               document_index: ::Integer?,
+                                               start: ::Integer?,
+                                               end: ::Integer?
+                                             }?,
+                                             document_page: {
+                                               document_index: ::Integer?,
+                                               start: ::Integer?,
+                                               end: ::Integer?
+                                             }?,
+                                             document_chunk: {
+                                               document_index: ::Integer?,
+                                               start: ::Integer?,
+                                               end: ::Integer?
+                                             }?
+                                           }?
+                                         },
+                                       ]?
                                      }?
                                    },
                                  ]