Class: Aws::QConnect::Types::UpdateAIPromptRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ai_prompt_id ⇒ String

The identifier of the Amazon Q in Connect AI Prompt.

Returns:

  • (String) 


9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9728

class UpdateAIPromptRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_prompt_id,
  :visibility_status,
  :template_configuration,
  :description,
  :model_id)
  SENSITIVE = []
  include Aws::Structure
end

#assistant_id ⇒ String

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (String) 


9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9728

class UpdateAIPromptRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_prompt_id,
  :visibility_status,
  :template_configuration,
  :description,
  :model_id)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9728

class UpdateAIPromptRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_prompt_id,
  :visibility_status,
  :template_configuration,
  :description,
  :model_id)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the Amazon Q in Connect AI Prompt.

Returns:

  • (String) 


9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9728

class UpdateAIPromptRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_prompt_id,
  :visibility_status,
  :template_configuration,
  :description,
  :model_id)
  SENSITIVE = []
  include Aws::Structure
end

#model_id ⇒ String

The identifier of the model used for this AI Prompt.

For more information on supported models, see Supported models for system and custom prompts.

Returns:

  • (String) 


9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9728

class UpdateAIPromptRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_prompt_id,
  :visibility_status,
  :template_configuration,
  :description,
  :model_id)
  SENSITIVE = []
  include Aws::Structure
end

#template_configuration ⇒ Types::AIPromptTemplateConfiguration

The configuration of the prompt template for this AI Prompt.

Returns:



9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9728

class UpdateAIPromptRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_prompt_id,
  :visibility_status,
  :template_configuration,
  :description,
  :model_id)
  SENSITIVE = []
  include Aws::Structure
end

#visibility_status ⇒ String

The visibility status of the Amazon Q in Connect AI prompt.

Returns:

  • (String) 


9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9728

class UpdateAIPromptRequest < Struct.new(
  :client_token,
  :assistant_id,
  :ai_prompt_id,
  :visibility_status,
  :template_configuration,
  :description,
  :model_id)
  SENSITIVE = []
  include Aws::Structure
end