Class: Aws::QApps::Types::QQueryCardInput

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

Overview

The input shape for defining a query card in an Amazon Q App.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_filter ⇒ Types::AttributeFilter

Turns on filtering of responses based on document attributes or metadata fields.

Returns:



1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
 
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/types.rb', line 1702

class QQueryCardInput < Struct.new(
  :title,
  :id,
  :type,
  :prompt,
  :output_source,
  :attribute_filter)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The unique identifier of the query card.

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
 
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/types.rb', line 1702

class QQueryCardInput < Struct.new(
  :title,
  :id,
  :type,
  :prompt,
  :output_source,
  :attribute_filter)
  SENSITIVE = []
  include Aws::Structure
end

#output_source ⇒ String

The source or type of output to generate for the query card.

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
 
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/types.rb', line 1702

class QQueryCardInput < Struct.new(
  :title,
  :id,
  :type,
  :prompt,
  :output_source,
  :attribute_filter)
  SENSITIVE = []
  include Aws::Structure
end

#prompt ⇒ String

The prompt or instructions displayed for the query card.

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
 
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/types.rb', line 1702

class QQueryCardInput < Struct.new(
  :title,
  :id,
  :type,
  :prompt,
  :output_source,
  :attribute_filter)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title or label of the query card.

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
 
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/types.rb', line 1702

class QQueryCardInput < Struct.new(
  :title,
  :id,
  :type,
  :prompt,
  :output_source,
  :attribute_filter)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the card.

Returns:

  • (String) 


1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
 
# File 'gems/aws-sdk-qapps/lib/aws-sdk-qapps/types.rb', line 1702

class QQueryCardInput < Struct.new(
  :title,
  :id,
  :type,
  :prompt,
  :output_source,
  :attribute_filter)
  SENSITIVE = []
  include Aws::Structure
end