Class: Aws::BedrockRuntime::Types::JsonSchemaDefinition

Inherits:

Struct

• Object
• Struct
• Aws::BedrockRuntime::Types::JsonSchemaDefinition

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockruntime/types.rb

Overview

JSON schema structured output format options.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  A description of the JSON schema.

• #name ⇒ String

  The name of the JSON schema.

• #schema ⇒ String

  The JSON schema to constrain the model’s output.

Instance Attribute Details

#description ⇒ String

A description of the JSON schema.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockruntime/types.rb', line 3630

class JsonSchemaDefinition < Struct.new(
  :schema,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the JSON schema.

Returns:

• (String)

# File 'lib/aws-sdk-bedrockruntime/types.rb', line 3630

class JsonSchemaDefinition < Struct.new(
  :schema,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#schema ⇒ String

The JSON schema to constrain the model’s output. For more information, see [JSON Schema Reference].

[1]: json-schema.org/understanding-json-schema/reference

Returns:

• (String)

# File 'lib/aws-sdk-bedrockruntime/types.rb', line 3630

class JsonSchemaDefinition < Struct.new(
  :schema,
  :name,
  :description)
  SENSITIVE = []
  include Aws::Structure
end