Class: Aws::QConnect::Types::CreateAIPromptRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::QConnect::Types::CreateAIPromptRequest
- Defined in:
- gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#api_format ⇒ String
The API Format of the AI Prompt.
-
#assistant_id ⇒ String
The identifier of the Amazon Q in Connect assistant.
-
#client_token ⇒ String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
-
#description ⇒ String
The description of the AI Prompt.
-
#inference_configuration ⇒ Types::AIPromptInferenceConfiguration
The inference configuration for the AI Prompt being created.
-
#model_id ⇒ String
The identifier of the model used for this AI Prompt.
-
#name ⇒ String
The name of the AI Prompt.
-
#tags ⇒ Hash<String,String>
The tags used to organize, track, or control access for this resource.
-
#template_configuration ⇒ Types::AIPromptTemplateConfiguration
The configuration of the prompt template for this AI Prompt.
-
#template_type ⇒ String
The type of the prompt template for this AI Prompt.
-
#type ⇒ String
The type of this AI Prompt.
-
#visibility_status ⇒ String
The visibility status of the AI Prompt.
Instance Attribute Details
#api_format ⇒ String
The API Format of the AI Prompt.
Recommended values: MESSAGES | TEXT_COMPLETIONS
ANTHROPIC_CLAUDE_MESSAGES |
ANTHROPIC_CLAUDE_TEXT_COMPLETIONS will be deprecated.
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2726 class CreateAIPromptRequest < Struct.new( :client_token, :assistant_id, :name, :type, :template_configuration, :visibility_status, :template_type, :model_id, :api_format, :tags, :description, :inference_configuration) 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.
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2726 class CreateAIPromptRequest < Struct.new( :client_token, :assistant_id, :name, :type, :template_configuration, :visibility_status, :template_type, :model_id, :api_format, :tags, :description, :inference_configuration) 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.
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2726 class CreateAIPromptRequest < Struct.new( :client_token, :assistant_id, :name, :type, :template_configuration, :visibility_status, :template_type, :model_id, :api_format, :tags, :description, :inference_configuration) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description of the AI Prompt.
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2726 class CreateAIPromptRequest < Struct.new( :client_token, :assistant_id, :name, :type, :template_configuration, :visibility_status, :template_type, :model_id, :api_format, :tags, :description, :inference_configuration) SENSITIVE = [] include Aws::Structure end |
#inference_configuration ⇒ Types::AIPromptInferenceConfiguration
The inference configuration for the AI Prompt being created.
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2726 class CreateAIPromptRequest < Struct.new( :client_token, :assistant_id, :name, :type, :template_configuration, :visibility_status, :template_type, :model_id, :api_format, :tags, :description, :inference_configuration) SENSITIVE = [] include Aws::Structure end |
#model_id ⇒ String
The identifier of the model used for this AI Prompt.
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2726 class CreateAIPromptRequest < Struct.new( :client_token, :assistant_id, :name, :type, :template_configuration, :visibility_status, :template_type, :model_id, :api_format, :tags, :description, :inference_configuration) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the AI Prompt.
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2726 class CreateAIPromptRequest < Struct.new( :client_token, :assistant_id, :name, :type, :template_configuration, :visibility_status, :template_type, :model_id, :api_format, :tags, :description, :inference_configuration) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
The tags used to organize, track, or control access for this resource.
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2726 class CreateAIPromptRequest < Struct.new( :client_token, :assistant_id, :name, :type, :template_configuration, :visibility_status, :template_type, :model_id, :api_format, :tags, :description, :inference_configuration) SENSITIVE = [] include Aws::Structure end |
#template_configuration ⇒ Types::AIPromptTemplateConfiguration
The configuration of the prompt template for this AI Prompt.
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2726 class CreateAIPromptRequest < Struct.new( :client_token, :assistant_id, :name, :type, :template_configuration, :visibility_status, :template_type, :model_id, :api_format, :tags, :description, :inference_configuration) SENSITIVE = [] include Aws::Structure end |
#template_type ⇒ String
The type of the prompt template for this AI Prompt.
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2726 class CreateAIPromptRequest < Struct.new( :client_token, :assistant_id, :name, :type, :template_configuration, :visibility_status, :template_type, :model_id, :api_format, :tags, :description, :inference_configuration) SENSITIVE = [] include Aws::Structure end |
#type ⇒ String
The type of this AI Prompt.
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2726 class CreateAIPromptRequest < Struct.new( :client_token, :assistant_id, :name, :type, :template_configuration, :visibility_status, :template_type, :model_id, :api_format, :tags, :description, :inference_configuration) SENSITIVE = [] include Aws::Structure end |
#visibility_status ⇒ String
The visibility status of the AI Prompt.
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 |
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2726 class CreateAIPromptRequest < Struct.new( :client_token, :assistant_id, :name, :type, :template_configuration, :visibility_status, :template_type, :model_id, :api_format, :tags, :description, :inference_configuration) SENSITIVE = [] include Aws::Structure end |