Class: Aws::BedrockRuntime::Types::SystemContentBlock

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

Overview

Note:

SystemContentBlock is a union - when making an API calls you must set exactly one of the members.

A system content block.

See Also:

Direct Known Subclasses

CachePoint, GuardContent, Text, Unknown

Defined Under Namespace

Classes: CachePoint, GuardContent, Text, Unknown

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cache_point ⇒ Types::CachePointBlock

CachePoint to include in the system prompt.

Returns:



2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 2728

class SystemContentBlock < Struct.new(
  :text,
  :guard_content,
  :cache_point,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Text < SystemContentBlock; end
  class GuardContent < SystemContentBlock; end
  class CachePoint < SystemContentBlock; end
  class Unknown < SystemContentBlock; end
end

#guard_content ⇒ Types::GuardrailConverseContentBlock

A content block to assess with the guardrail. Use with the

Converse][1

or [ConverseStream] API operations.

For more information, see *Use a guardrail with the Converse API* in the *Amazon Bedrock User Guide*.

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html [2]: docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html

Returns:



2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 2728

class SystemContentBlock < Struct.new(
  :text,
  :guard_content,
  :cache_point,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Text < SystemContentBlock; end
  class GuardContent < SystemContentBlock; end
  class CachePoint < SystemContentBlock; end
  class Unknown < SystemContentBlock; end
end

#text ⇒ String

A system prompt for the model.

Returns:

  • (String) 


2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 2728

class SystemContentBlock < Struct.new(
  :text,
  :guard_content,
  :cache_point,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Text < SystemContentBlock; end
  class GuardContent < SystemContentBlock; end
  class CachePoint < SystemContentBlock; end
  class Unknown < SystemContentBlock; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



2728
2729
2730
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 2728

def unknown
  @unknown
end