Class: Aws::QConnect::Types::AIPromptData

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

Overview

The data for the AI Prompt

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ai_prompt_arn ⇒ String

The Amazon Resource Name (ARN) of the AI Prompt.

Returns:

  • (String) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#ai_prompt_id ⇒ String

The identifier of the Amazon Q in Connect AI prompt.

Returns:

  • (String) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#api_format ⇒ String

The API format used for this AI Prompt.

Returns:

  • (String) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#assistant_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

Returns:

  • (String) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  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) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the AI Prompt.

Returns:

  • (String) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#inference_configuration ⇒ Types::AIPromptInferenceConfiguration

The configuration for inference parameters when using the AI Prompt.

Returns:



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#model_id ⇒ String

The identifier of the model used for this AI Prompt. The following model Ids are supported:

  • ‘anthropic.claude-3-haiku–v1:0`

  • ‘apac.amazon.nova-lite-v1:0`

  • ‘apac.amazon.nova-micro-v1:0`

  • ‘apac.amazon.nova-pro-v1:0`

  • ‘apac.anthropic.claude-3-5-sonnet–v2:0`

  • ‘apac.anthropic.claude-3-haiku-20240307-v1:0`

  • ‘eu.amazon.nova-lite-v1:0`

  • ‘eu.amazon.nova-micro-v1:0`

  • ‘eu.amazon.nova-pro-v1:0`

  • ‘eu.anthropic.claude-3-7-sonnet-20250219-v1:0`

  • ‘eu.anthropic.claude-3-haiku-20240307-v1:0`

  • ‘us.amazon.nova-lite-v1:0`

  • ‘us.amazon.nova-micro-v1:0`

  • ‘us.amazon.nova-pro-v1:0`

  • ‘us.anthropic.claude-3-5-haiku-20241022-v1:0`

  • ‘us.anthropic.claude-3-7-sonnet-20250219-v1:0`

  • ‘us.anthropic.claude-3-haiku-20240307-v1:0`

Returns:

  • (String) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#modified_time ⇒ Time

The time the AI Prompt was last modified.

Returns:

  • (Time) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the AI Prompt

Returns:

  • (String) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#origin ⇒ String

The origin of the AI Prompt. ‘SYSTEM` for a default AI Prompt created by Q in Connect or `CUSTOMER` for an AI Prompt created by calling AI Prompt creation APIs.

Returns:

  • (String) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the AI Prompt.

Returns:

  • (String) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags used to organize, track, or control access for this resource.

Returns:

  • (Hash<String,String>) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#template_configuration ⇒ Types::AIPromptTemplateConfiguration

The configuration of the prompt template for this AI Prompt.

Returns:



671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#template_type ⇒ String

The type of the prompt template for this AI Prompt.

Returns:

  • (String) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of this AI Prompt.

Returns:

  • (String) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#visibility_status ⇒ String

The visibility status of the AI Prompt.

Returns:

  • (String) 


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/aws-sdk-qconnect/types.rb', line 671

class AIPromptData < Struct.new(
  :assistant_id,
  :assistant_arn,
  :ai_prompt_id,
  :ai_prompt_arn,
  :name,
  :type,
  :template_type,
  :model_id,
  :api_format,
  :template_configuration,
  :inference_configuration,
  :modified_time,
  :description,
  :visibility_status,
  :tags,
  :origin,
  :status)
  SENSITIVE = []
  include Aws::Structure
end