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

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

Overview

JSON schema structured output format options.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the JSON schema.

Returns:

  • (String)


3620
3621
3622
3623
3624
3625
3626
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 3620

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

#nameString

The name of the JSON schema.

Returns:

  • (String)


3620
3621
3622
3623
3624
3625
3626
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 3620

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

#schemaString

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

Returns:

  • (String)


3620
3621
3622
3623
3624
3625
3626
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 3620

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