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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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

The values ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS will be deprecated.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2528

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.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2528

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.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2528

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.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2528

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.

Returns:

• (Types::AIPromptInferenceConfiguration)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2528

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.

For information about which models are supported in each Amazon Web Services Region, see Supported models for system/custom prompts.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2528

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.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2528

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.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2528

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.

Returns:

• (Types::AIPromptTemplateConfiguration)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2528

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.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2528

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.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2528

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.

Returns:

• (String)

# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 2528

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