Class: Aws::QuickSight::Types::CustomPromptInterface

Inherits:

Struct

• Object
• Struct
• Aws::QuickSight::Types::CustomPromptInterface

Defined in:

gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

The custom prompt interface configuration that defines how an agent's prompt is configured.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:response_length, :output_style, :identity, :tone, :custom_instructions, :prompt_summary]

Instance Attribute Summary

• #custom_instructions ⇒ String

  Custom instructions for the agent's behavior.

• #identity ⇒ String

  Instructions that define the agent's identity and persona.

• #model_profile_id ⇒ String

  The identifier of the model profile.

• #output_style ⇒ String

  Instructions for the desired output style.

• #prompt_summary ⇒ String

  A summary of the custom prompt configuration.

• #qbs_aws_account_id ⇒ String

  The Amazon Web Services account ID for the Q Business service.

• #response_length ⇒ String

  Instructions for the desired response length.

• #subscription_id ⇒ String

  The subscription identifier.

• #tone ⇒ String

  Instructions for the desired tone of responses.

Instance Attribute Details

#custom_instructions ⇒ String

Custom instructions for the agent's behavior.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11103

class CustomPromptInterface < Struct.new(
  :model_profile_id,
  :subscription_id,
  :qbs_aws_account_id,
  :response_length,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :prompt_summary)
  SENSITIVE = [:response_length, :output_style, :identity, :tone, :custom_instructions, :prompt_summary]
  include Aws::Structure
end

#identity ⇒ String

Instructions that define the agent's identity and persona.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11103

class CustomPromptInterface < Struct.new(
  :model_profile_id,
  :subscription_id,
  :qbs_aws_account_id,
  :response_length,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :prompt_summary)
  SENSITIVE = [:response_length, :output_style, :identity, :tone, :custom_instructions, :prompt_summary]
  include Aws::Structure
end

#model_profile_id ⇒ String

The identifier of the model profile.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11103

class CustomPromptInterface < Struct.new(
  :model_profile_id,
  :subscription_id,
  :qbs_aws_account_id,
  :response_length,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :prompt_summary)
  SENSITIVE = [:response_length, :output_style, :identity, :tone, :custom_instructions, :prompt_summary]
  include Aws::Structure
end

#output_style ⇒ String

Instructions for the desired output style.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11103

class CustomPromptInterface < Struct.new(
  :model_profile_id,
  :subscription_id,
  :qbs_aws_account_id,
  :response_length,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :prompt_summary)
  SENSITIVE = [:response_length, :output_style, :identity, :tone, :custom_instructions, :prompt_summary]
  include Aws::Structure
end

#prompt_summary ⇒ String

A summary of the custom prompt configuration.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11103

class CustomPromptInterface < Struct.new(
  :model_profile_id,
  :subscription_id,
  :qbs_aws_account_id,
  :response_length,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :prompt_summary)
  SENSITIVE = [:response_length, :output_style, :identity, :tone, :custom_instructions, :prompt_summary]
  include Aws::Structure
end

#qbs_aws_account_id ⇒ String

The Amazon Web Services account ID for the Q Business service.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11103

class CustomPromptInterface < Struct.new(
  :model_profile_id,
  :subscription_id,
  :qbs_aws_account_id,
  :response_length,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :prompt_summary)
  SENSITIVE = [:response_length, :output_style, :identity, :tone, :custom_instructions, :prompt_summary]
  include Aws::Structure
end

#response_length ⇒ String

Instructions for the desired response length.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11103

class CustomPromptInterface < Struct.new(
  :model_profile_id,
  :subscription_id,
  :qbs_aws_account_id,
  :response_length,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :prompt_summary)
  SENSITIVE = [:response_length, :output_style, :identity, :tone, :custom_instructions, :prompt_summary]
  include Aws::Structure
end

#subscription_id ⇒ String

The subscription identifier.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11103

class CustomPromptInterface < Struct.new(
  :model_profile_id,
  :subscription_id,
  :qbs_aws_account_id,
  :response_length,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :prompt_summary)
  SENSITIVE = [:response_length, :output_style, :identity, :tone, :custom_instructions, :prompt_summary]
  include Aws::Structure
end

#tone ⇒ String

Instructions for the desired tone of responses.

Returns:

• (String)

# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 11103

class CustomPromptInterface < Struct.new(
  :model_profile_id,
  :subscription_id,
  :qbs_aws_account_id,
  :response_length,
  :output_style,
  :identity,
  :tone,
  :custom_instructions,
  :prompt_summary)
  SENSITIVE = [:response_length, :output_style, :identity, :tone, :custom_instructions, :prompt_summary]
  include Aws::Structure
end