Class: Aws::QConnect::Types::AIPromptSummary

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

Overview

The summary of 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) 


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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

#ai_prompt_id ⇒ String

The identifier of the Amazon Q in Connect AI prompt.

Returns:

  • (String) 


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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

#api_format ⇒ String

The API format used for this AI Prompt.

Returns:

  • (String) 


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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

#assistant_arn ⇒ String

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

Returns:

  • (String) 


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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

#description ⇒ String

The description of the AI Prompt.

Returns:

  • (String) 


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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

#model_id ⇒ String

The identifier of the model used for this AI Prompt. Model Ids supported are: ‘anthropic.claude-3-haiku-20240307-v1:0`.

Returns:

  • (String) 


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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

#modified_time ⇒ Time

The time the AI Prompt was last modified.

Returns:

  • (Time) 


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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

#name ⇒ String

The name of the AI Prompt.

Returns:

  • (String) 


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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

#status ⇒ String

The status of the AI Prompt.

Returns:

  • (String) 


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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

#template_type ⇒ String

The type of the prompt template for this AI Prompt.

Returns:

  • (String) 


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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

#type ⇒ String

The type of this AI Prompt.

Returns:

  • (String) 


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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

#visibility_status ⇒ String

The visibility status of the AI Prompt.

Returns:

  • (String) 


785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/aws-sdk-qconnect/types.rb', line 785

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