Class: Aws::BedrockRuntime::Types::DocumentBlock

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-bedrockruntime/types.rb

Overview

A document to include in a message.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#format ⇒ String

The format of a document, or its extension.

Returns:

  • (String) 


741
742
743
744
745
746
747
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 741

class DocumentBlock < Struct.new(
  :format,
  :name,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A name for the document. The name can only contain the following characters:

  • Alphanumeric characters

  • Whitespace characters (no more than one in a row)

  • Hyphens

  • Parentheses

  • Square brackets

<note markdown=“1”> This field is vulnerable to prompt injections, because the model might inadvertently interpret it as instructions. Therefore, we recommend that you specify a neutral name.

</note>

Returns:

  • (String) 


741
742
743
744
745
746
747
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 741

class DocumentBlock < Struct.new(
  :format,
  :name,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ Types::DocumentSource

Contains the content of the document.

Returns:



741
742
743
744
745
746
747
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 741

class DocumentBlock < Struct.new(
  :format,
  :name,
  :source)
  SENSITIVE = []
  include Aws::Structure
end