Class: Aws::QConnect::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb

Overview

An API client for QConnect. To construct a client, you need to configure a :region and :credentials.

client = Aws::QConnect::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::QConnect::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::QConnect::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#activate_message_template(params = {}) ⇒ Types::ActivateMessageTemplateResponse

Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the $ACTIVE_VERSION qualifier later to reference the version that is in active status.

Examples:

Request syntax with placeholder values


resp = client.activate_message_template({
  knowledge_base_id: "UuidOrArn", # required
  message_template_id: "UuidOrArnOrEitherWithQualifier", # required
  version_number: 1, # required
})

Response structure


resp.message_template_arn #=> String
resp.message_template_id #=> String
resp.version_number #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :message_template_id (required, String) —

    The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.

  • :version_number (required, Integer) —

    The version number of the message template version to activate.

Returns:

See Also:



519
520
521
522
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 519

def activate_message_template(params = {}, options = {})
  req = build_request(:activate_message_template, params)
  req.send_request(options)
end

#create_ai_agent(params = {}) ⇒ Types::CreateAIAgentResponse

Creates an Amazon Q in Connect AI Agent.

Examples:

Request syntax with placeholder values


resp = client.create_ai_agent({
  client_token: "ClientToken",
  assistant_id: "UuidOrArn", # required
  name: "Name", # required
  type: "MANUAL_SEARCH", # required, accepts MANUAL_SEARCH, ANSWER_RECOMMENDATION, SELF_SERVICE
  configuration: { # required
    manual_search_ai_agent_configuration: {
      answer_generation_ai_prompt_id: "UuidWithQualifier",
      answer_generation_ai_guardrail_id: "UuidWithQualifier",
      association_configurations: [
        {
          association_id: "Uuid",
          association_type: "KNOWLEDGE_BASE", # accepts KNOWLEDGE_BASE
          association_configuration_data: {
            knowledge_base_association_configuration_data: {
              content_tag_filter: {
                tag_condition: {
                  key: "TagKey", # required
                  value: "TagValue",
                },
                and_conditions: [
                  {
                    key: "TagKey", # required
                    value: "TagValue",
                  },
                ],
                or_conditions: [
                  {
                    and_conditions: [
                      {
                        key: "TagKey", # required
                        value: "TagValue",
                      },
                    ],
                    tag_condition: {
                      key: "TagKey", # required
                      value: "TagValue",
                    },
                  },
                ],
              },
              max_results: 1,
              override_knowledge_base_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
            },
          },
        },
      ],
      locale: "NonEmptyString",
    },
    answer_recommendation_ai_agent_configuration: {
      intent_labeling_generation_ai_prompt_id: "UuidWithQualifier",
      query_reformulation_ai_prompt_id: "UuidWithQualifier",
      answer_generation_ai_prompt_id: "UuidWithQualifier",
      answer_generation_ai_guardrail_id: "UuidWithQualifier",
      association_configurations: [
        {
          association_id: "Uuid",
          association_type: "KNOWLEDGE_BASE", # accepts KNOWLEDGE_BASE
          association_configuration_data: {
            knowledge_base_association_configuration_data: {
              content_tag_filter: {
                tag_condition: {
                  key: "TagKey", # required
                  value: "TagValue",
                },
                and_conditions: [
                  {
                    key: "TagKey", # required
                    value: "TagValue",
                  },
                ],
                or_conditions: [
                  {
                    and_conditions: [
                      {
                        key: "TagKey", # required
                        value: "TagValue",
                      },
                    ],
                    tag_condition: {
                      key: "TagKey", # required
                      value: "TagValue",
                    },
                  },
                ],
              },
              max_results: 1,
              override_knowledge_base_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
            },
          },
        },
      ],
      locale: "NonEmptyString",
    },
    self_service_ai_agent_configuration: {
      self_service_pre_processing_ai_prompt_id: "UuidWithQualifier",
      self_service_answer_generation_ai_prompt_id: "UuidWithQualifier",
      self_service_ai_guardrail_id: "UuidWithQualifier",
      association_configurations: [
        {
          association_id: "Uuid",
          association_type: "KNOWLEDGE_BASE", # accepts KNOWLEDGE_BASE
          association_configuration_data: {
            knowledge_base_association_configuration_data: {
              content_tag_filter: {
                tag_condition: {
                  key: "TagKey", # required
                  value: "TagValue",
                },
                and_conditions: [
                  {
                    key: "TagKey", # required
                    value: "TagValue",
                  },
                ],
                or_conditions: [
                  {
                    and_conditions: [
                      {
                        key: "TagKey", # required
                        value: "TagValue",
                      },
                    ],
                    tag_condition: {
                      key: "TagKey", # required
                      value: "TagValue",
                    },
                  },
                ],
              },
              max_results: 1,
              override_knowledge_base_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
            },
          },
        },
      ],
    },
  },
  visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
  tags: {
    "TagKey" => "TagValue",
  },
  description: "Description",
})

Response structure


resp.ai_agent.assistant_id #=> String
resp.ai_agent.assistant_arn #=> String
resp.ai_agent.ai_agent_id #=> String
resp.ai_agent.ai_agent_arn #=> String
resp.ai_agent.name #=> String
resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION", "SELF_SERVICE"
resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent.configuration.manual_search_ai_agent_configuration.locale #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.locale #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_pre_processing_ai_prompt_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_answer_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_ai_guardrail_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent.modified_time #=> Time
resp.ai_agent.description #=> String
resp.ai_agent.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_agent.tags #=> Hash
resp.ai_agent.tags["TagKey"] #=> String
resp.ai_agent.origin #=> String, one of "SYSTEM", "CUSTOMER"
resp.ai_agent.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.**

  • :assistant_id (required, String) —

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

  • :name (required, String) —

    The name of the AI Agent.

  • :type (required, String) —

    The type of the AI Agent.

  • :configuration (required, Types::AIAgentConfiguration) —

    The configuration of the AI Agent.

  • :visibility_status (required, String) —

    The visibility status of the AI Agent.

  • :tags (Hash<String,String>) —

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

  • :description (String) —

    The description of the AI Agent.

Returns:

See Also:



791
792
793
794
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 791

def create_ai_agent(params = {}, options = {})
  req = build_request(:create_ai_agent, params)
  req.send_request(options)
end

#create_ai_agent_version(params = {}) ⇒ Types::CreateAIAgentVersionResponse

Creates and Amazon Q in Connect AI Agent version.

Examples:

Request syntax with placeholder values


resp = client.create_ai_agent_version({
  assistant_id: "UuidOrArn", # required
  ai_agent_id: "UuidOrArnOrEitherWithQualifier", # required
  modified_time: Time.now,
  client_token: "ClientToken",
})

Response structure


resp.ai_agent.assistant_id #=> String
resp.ai_agent.assistant_arn #=> String
resp.ai_agent.ai_agent_id #=> String
resp.ai_agent.ai_agent_arn #=> String
resp.ai_agent.name #=> String
resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION", "SELF_SERVICE"
resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent.configuration.manual_search_ai_agent_configuration.locale #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.locale #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_pre_processing_ai_prompt_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_answer_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_ai_guardrail_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent.modified_time #=> Time
resp.ai_agent.description #=> String
resp.ai_agent.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_agent.tags #=> Hash
resp.ai_agent.tags["TagKey"] #=> String
resp.ai_agent.origin #=> String, one of "SYSTEM", "CUSTOMER"
resp.ai_agent.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.version_number #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_agent_id (required, String) —

    The identifier of the Amazon Q in Connect AI Agent.

  • :modified_time (Time, DateTime, Date, Integer, String) —

    The modification time of the AI Agent should be tracked for version creation. This field should be specified to avoid version creation when simultaneous update to the underlying AI Agent are possible. The value should be the modifiedTime returned from the request to create or update an AI Agent so that version creation can fail if an update to the AI Agent post the specified modification time has been made.

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

See Also:



920
921
922
923
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 920

def create_ai_agent_version(params = {}, options = {})
  req = build_request(:create_ai_agent_version, params)
  req.send_request(options)
end

#create_ai_guardrail(params = {}) ⇒ Types::CreateAIGuardrailResponse

Creates an Amazon Q in Connect AI Guardrail.

Examples:

Request syntax with placeholder values


resp = client.create_ai_guardrail({
  client_token: "ClientToken",
  assistant_id: "UuidOrArn", # required
  name: "Name", # required
  blocked_input_messaging: "AIGuardrailBlockedMessaging", # required
  blocked_outputs_messaging: "AIGuardrailBlockedMessaging", # required
  visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
  description: "AIGuardrailDescription",
  topic_policy_config: {
    topics_config: [ # required
      {
        name: "GuardrailTopicName", # required
        definition: "GuardrailTopicDefinition", # required
        examples: ["GuardrailTopicExample"],
        type: "DENY", # required, accepts DENY
      },
    ],
  },
  content_policy_config: {
    filters_config: [ # required
      {
        type: "SEXUAL", # required, accepts SEXUAL, VIOLENCE, HATE, INSULTS, MISCONDUCT, PROMPT_ATTACK
        input_strength: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH
        output_strength: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH
      },
    ],
  },
  word_policy_config: {
    words_config: [
      {
        text: "GuardrailWordText", # required
      },
    ],
    managed_word_lists_config: [
      {
        type: "PROFANITY", # required, accepts PROFANITY
      },
    ],
  },
  sensitive_information_policy_config: {
    pii_entities_config: [
      {
        type: "ADDRESS", # required, accepts ADDRESS, AGE, AWS_ACCESS_KEY, AWS_SECRET_KEY, CA_HEALTH_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, CREDIT_DEBIT_CARD_CVV, CREDIT_DEBIT_CARD_EXPIRY, CREDIT_DEBIT_CARD_NUMBER, DRIVER_ID, EMAIL, INTERNATIONAL_BANK_ACCOUNT_NUMBER, IP_ADDRESS, LICENSE_PLATE, MAC_ADDRESS, NAME, PASSWORD, PHONE, PIN, SWIFT_CODE, UK_NATIONAL_HEALTH_SERVICE_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER, URL, USERNAME, US_BANK_ACCOUNT_NUMBER, US_BANK_ROUTING_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, US_PASSPORT_NUMBER, US_SOCIAL_SECURITY_NUMBER, VEHICLE_IDENTIFICATION_NUMBER
        action: "BLOCK", # required, accepts BLOCK, ANONYMIZE
      },
    ],
    regexes_config: [
      {
        name: "GuardrailRegexName", # required
        description: "GuardrailRegexDescription",
        pattern: "GuardrailRegexPattern", # required
        action: "BLOCK", # required, accepts BLOCK, ANONYMIZE
      },
    ],
  },
  contextual_grounding_policy_config: {
    filters_config: [ # required
      {
        type: "GROUNDING", # required, accepts GROUNDING, RELEVANCE
        threshold: 1.0, # required
      },
    ],
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.ai_guardrail.assistant_id #=> String
resp.ai_guardrail.assistant_arn #=> String
resp.ai_guardrail.ai_guardrail_arn #=> String
resp.ai_guardrail.ai_guardrail_id #=> String
resp.ai_guardrail.name #=> String
resp.ai_guardrail.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_guardrail.blocked_input_messaging #=> String
resp.ai_guardrail.blocked_outputs_messaging #=> String
resp.ai_guardrail.description #=> String
resp.ai_guardrail.topic_policy_config.topics_config #=> Array
resp.ai_guardrail.topic_policy_config.topics_config[0].name #=> String
resp.ai_guardrail.topic_policy_config.topics_config[0].definition #=> String
resp.ai_guardrail.topic_policy_config.topics_config[0].examples #=> Array
resp.ai_guardrail.topic_policy_config.topics_config[0].examples[0] #=> String
resp.ai_guardrail.topic_policy_config.topics_config[0].type #=> String, one of "DENY"
resp.ai_guardrail.content_policy_config.filters_config #=> Array
resp.ai_guardrail.content_policy_config.filters_config[0].type #=> String, one of "SEXUAL", "VIOLENCE", "HATE", "INSULTS", "MISCONDUCT", "PROMPT_ATTACK"
resp.ai_guardrail.content_policy_config.filters_config[0].input_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
resp.ai_guardrail.content_policy_config.filters_config[0].output_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
resp.ai_guardrail.word_policy_config.words_config #=> Array
resp.ai_guardrail.word_policy_config.words_config[0].text #=> String
resp.ai_guardrail.word_policy_config.managed_word_lists_config #=> Array
resp.ai_guardrail.word_policy_config.managed_word_lists_config[0].type #=> String, one of "PROFANITY"
resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config #=> Array
resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].type #=> String, one of "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME", "PASSWORD", "PHONE", "PIN", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "URL", "USERNAME", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "VEHICLE_IDENTIFICATION_NUMBER"
resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
resp.ai_guardrail.sensitive_information_policy_config.regexes_config #=> Array
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].name #=> String
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].description #=> String
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].pattern #=> String
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
resp.ai_guardrail.contextual_grounding_policy_config.filters_config #=> Array
resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].type #=> String, one of "GROUNDING", "RELEVANCE"
resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].threshold #=> Float
resp.ai_guardrail.tags #=> Hash
resp.ai_guardrail.tags["TagKey"] #=> String
resp.ai_guardrail.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.ai_guardrail.modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.**

  • :assistant_id (required, String) —

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

  • :name (required, String) —

    The name of the AI Guardrail.

  • :blocked_input_messaging (required, String) —

    The message to return when the AI Guardrail blocks a prompt.

  • :blocked_outputs_messaging (required, String) —

    The message to return when the AI Guardrail blocks a model response.

  • :visibility_status (required, String) —

    The visibility status of the AI Guardrail.

  • :description (String) —

    A description of the AI Guardrail.

  • :topic_policy_config (Types::AIGuardrailTopicPolicyConfig) —

    The topic policies to configure for the AI Guardrail.

  • :content_policy_config (Types::AIGuardrailContentPolicyConfig) —

    The content filter policies to configure for the AI Guardrail.

  • :word_policy_config (Types::AIGuardrailWordPolicyConfig) —

    The word policy you configure for the AI Guardrail.

  • :sensitive_information_policy_config (Types::AIGuardrailSensitiveInformationPolicyConfig) —

    The sensitive information policy to configure for the AI Guardrail.

  • :contextual_grounding_policy_config (Types::AIGuardrailContextualGroundingPolicyConfig) —

    The contextual grounding policy configuration used to create an AI Guardrail.

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



1097
1098
1099
1100
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1097

def create_ai_guardrail(params = {}, options = {})
  req = build_request(:create_ai_guardrail, params)
  req.send_request(options)
end

#create_ai_guardrail_version(params = {}) ⇒ Types::CreateAIGuardrailVersionResponse

Creates an Amazon Q in Connect AI Guardrail version.

Examples:

Request syntax with placeholder values


resp = client.create_ai_guardrail_version({
  assistant_id: "UuidOrArn", # required
  ai_guardrail_id: "UuidOrArnOrEitherWithQualifier", # required
  modified_time: Time.now,
  client_token: "ClientToken",
})

Response structure


resp.ai_guardrail.assistant_id #=> String
resp.ai_guardrail.assistant_arn #=> String
resp.ai_guardrail.ai_guardrail_arn #=> String
resp.ai_guardrail.ai_guardrail_id #=> String
resp.ai_guardrail.name #=> String
resp.ai_guardrail.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_guardrail.blocked_input_messaging #=> String
resp.ai_guardrail.blocked_outputs_messaging #=> String
resp.ai_guardrail.description #=> String
resp.ai_guardrail.topic_policy_config.topics_config #=> Array
resp.ai_guardrail.topic_policy_config.topics_config[0].name #=> String
resp.ai_guardrail.topic_policy_config.topics_config[0].definition #=> String
resp.ai_guardrail.topic_policy_config.topics_config[0].examples #=> Array
resp.ai_guardrail.topic_policy_config.topics_config[0].examples[0] #=> String
resp.ai_guardrail.topic_policy_config.topics_config[0].type #=> String, one of "DENY"
resp.ai_guardrail.content_policy_config.filters_config #=> Array
resp.ai_guardrail.content_policy_config.filters_config[0].type #=> String, one of "SEXUAL", "VIOLENCE", "HATE", "INSULTS", "MISCONDUCT", "PROMPT_ATTACK"
resp.ai_guardrail.content_policy_config.filters_config[0].input_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
resp.ai_guardrail.content_policy_config.filters_config[0].output_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
resp.ai_guardrail.word_policy_config.words_config #=> Array
resp.ai_guardrail.word_policy_config.words_config[0].text #=> String
resp.ai_guardrail.word_policy_config.managed_word_lists_config #=> Array
resp.ai_guardrail.word_policy_config.managed_word_lists_config[0].type #=> String, one of "PROFANITY"
resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config #=> Array
resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].type #=> String, one of "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME", "PASSWORD", "PHONE", "PIN", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "URL", "USERNAME", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "VEHICLE_IDENTIFICATION_NUMBER"
resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
resp.ai_guardrail.sensitive_information_policy_config.regexes_config #=> Array
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].name #=> String
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].description #=> String
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].pattern #=> String
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
resp.ai_guardrail.contextual_grounding_policy_config.filters_config #=> Array
resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].type #=> String, one of "GROUNDING", "RELEVANCE"
resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].threshold #=> Float
resp.ai_guardrail.tags #=> Hash
resp.ai_guardrail.tags["TagKey"] #=> String
resp.ai_guardrail.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.ai_guardrail.modified_time #=> Time
resp.version_number #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_guardrail_id (required, String) —

    The identifier of the Amazon Q in Connect AI Guardrail.

  • :modified_time (Time, DateTime, Date, Integer, String) —

    The time the AI Guardrail was last modified.

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

See Also:



1187
1188
1189
1190
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1187

def create_ai_guardrail_version(params = {}, options = {})
  req = build_request(:create_ai_guardrail_version, params)
  req.send_request(options)
end

#create_ai_prompt(params = {}) ⇒ Types::CreateAIPromptResponse

Creates an Amazon Q in Connect AI Prompt.

Examples:

Request syntax with placeholder values


resp = client.create_ai_prompt({
  client_token: "ClientToken",
  assistant_id: "UuidOrArn", # required
  name: "Name", # required
  type: "ANSWER_GENERATION", # required, accepts ANSWER_GENERATION, INTENT_LABELING_GENERATION, QUERY_REFORMULATION, SELF_SERVICE_PRE_PROCESSING, SELF_SERVICE_ANSWER_GENERATION
  template_configuration: { # required
    text_full_ai_prompt_edit_template_configuration: {
      text: "TextAIPrompt", # required
    },
  },
  visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
  template_type: "TEXT", # required, accepts TEXT
  model_id: "AIPromptModelIdentifier", # required
  api_format: "ANTHROPIC_CLAUDE_MESSAGES", # required, accepts ANTHROPIC_CLAUDE_MESSAGES, ANTHROPIC_CLAUDE_TEXT_COMPLETIONS, MESSAGES, TEXT_COMPLETIONS
  tags: {
    "TagKey" => "TagValue",
  },
  description: "Description",
})

Response structure


resp.ai_prompt.assistant_id #=> String
resp.ai_prompt.assistant_arn #=> String
resp.ai_prompt.ai_prompt_id #=> String
resp.ai_prompt.ai_prompt_arn #=> String
resp.ai_prompt.name #=> String
resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION", "SELF_SERVICE_PRE_PROCESSING", "SELF_SERVICE_ANSWER_GENERATION"
resp.ai_prompt.template_type #=> String, one of "TEXT"
resp.ai_prompt.model_id #=> String
resp.ai_prompt.api_format #=> String, one of "ANTHROPIC_CLAUDE_MESSAGES", "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS", "MESSAGES", "TEXT_COMPLETIONS"
resp.ai_prompt.template_configuration.text_full_ai_prompt_edit_template_configuration.text #=> String
resp.ai_prompt.modified_time #=> Time
resp.ai_prompt.description #=> String
resp.ai_prompt.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_prompt.tags #=> Hash
resp.ai_prompt.tags["TagKey"] #=> String
resp.ai_prompt.origin #=> String, one of "SYSTEM", "CUSTOMER"
resp.ai_prompt.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.**

  • :assistant_id (required, String) —

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

  • :name (required, String) —

    The name of the AI Prompt.

  • :type (required, String) —

    The type of this AI Prompt.

  • :template_configuration (required, Types::AIPromptTemplateConfiguration) —

    The configuration of the prompt template for this AI Prompt.

  • :visibility_status (required, String) —

    The visibility status of the AI Prompt.

  • :template_type (required, String) —

    The type of the prompt template for this AI Prompt.

  • :model_id (required, String) —

    The identifier of the model used for this AI Prompt.

  • :api_format (required, 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.

  • :tags (Hash<String,String>) —

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

  • :description (String) —

    The description of the AI Prompt.

Returns:

See Also:



1295
1296
1297
1298
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1295

def create_ai_prompt(params = {}, options = {})
  req = build_request(:create_ai_prompt, params)
  req.send_request(options)
end

#create_ai_prompt_version(params = {}) ⇒ Types::CreateAIPromptVersionResponse

Creates an Amazon Q in Connect AI Prompt version.

Examples:

Request syntax with placeholder values


resp = client.create_ai_prompt_version({
  assistant_id: "UuidOrArn", # required
  ai_prompt_id: "UuidOrArnOrEitherWithQualifier", # required
  modified_time: Time.now,
  client_token: "ClientToken",
})

Response structure


resp.ai_prompt.assistant_id #=> String
resp.ai_prompt.assistant_arn #=> String
resp.ai_prompt.ai_prompt_id #=> String
resp.ai_prompt.ai_prompt_arn #=> String
resp.ai_prompt.name #=> String
resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION", "SELF_SERVICE_PRE_PROCESSING", "SELF_SERVICE_ANSWER_GENERATION"
resp.ai_prompt.template_type #=> String, one of "TEXT"
resp.ai_prompt.model_id #=> String
resp.ai_prompt.api_format #=> String, one of "ANTHROPIC_CLAUDE_MESSAGES", "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS", "MESSAGES", "TEXT_COMPLETIONS"
resp.ai_prompt.template_configuration.text_full_ai_prompt_edit_template_configuration.text #=> String
resp.ai_prompt.modified_time #=> Time
resp.ai_prompt.description #=> String
resp.ai_prompt.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_prompt.tags #=> Hash
resp.ai_prompt.tags["TagKey"] #=> String
resp.ai_prompt.origin #=> String, one of "SYSTEM", "CUSTOMER"
resp.ai_prompt.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.version_number #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_prompt_id (required, String) —

    The identifier of the Amazon Q in Connect AI prompt.

  • :modified_time (Time, DateTime, Date, Integer, String) —

    The time the AI Prompt was last modified.

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

See Also:



1364
1365
1366
1367
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1364

def create_ai_prompt_version(params = {}, options = {})
  req = build_request(:create_ai_prompt_version, params)
  req.send_request(options)
end

#create_assistant(params = {}) ⇒ Types::CreateAssistantResponse

Creates an Amazon Q in Connect assistant.

Examples:

Request syntax with placeholder values


resp = client.create_assistant({
  client_token: "ClientToken",
  name: "Name", # required
  type: "AGENT", # required, accepts AGENT
  description: "Description",
  tags: {
    "TagKey" => "TagValue",
  },
  server_side_encryption_configuration: {
    kms_key_id: "NonEmptyString",
  },
})

Response structure


resp.assistant.assistant_id #=> String
resp.assistant.assistant_arn #=> String
resp.assistant.name #=> String
resp.assistant.type #=> String, one of "AGENT"
resp.assistant.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.assistant.description #=> String
resp.assistant.tags #=> Hash
resp.assistant.tags["TagKey"] #=> String
resp.assistant.server_side_encryption_configuration.kms_key_id #=> String
resp.assistant.integration_configuration.topic_integration_arn #=> String
resp.assistant.capability_configuration.type #=> String, one of "V1", "V2"
resp.assistant.ai_agent_configuration #=> Hash
resp.assistant.ai_agent_configuration["AIAgentType"].ai_agent_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.**

  • :name (required, String) —

    The name of the assistant.

  • :type (required, String) —

    The type of assistant.

  • :description (String) —

    The description of the assistant.

  • :tags (Hash<String,String>) —

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

  • :server_side_encryption_configuration (Types::ServerSideEncryptionConfiguration) —

    The configuration information for the customer managed key used for encryption.

    The customer managed key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect. To use Amazon Q in Connect with chat, the key policy must also allow kms:Decrypt, kms:GenerateDataKey*, and kms:DescribeKey permissions to the connect.amazonaws.com service principal.

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

Returns:

See Also:



1455
1456
1457
1458
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1455

def create_assistant(params = {}, options = {})
  req = build_request(:create_assistant, params)
  req.send_request(options)
end

#create_assistant_association(params = {}) ⇒ Types::CreateAssistantAssociationResponse

Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

Examples:

Request syntax with placeholder values


resp = client.create_assistant_association({
  assistant_id: "UuidOrArn", # required
  association_type: "KNOWLEDGE_BASE", # required, accepts KNOWLEDGE_BASE
  association: { # required
    knowledge_base_id: "Uuid",
  },
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.assistant_association.assistant_association_id #=> String
resp.assistant_association.assistant_association_arn #=> String
resp.assistant_association.assistant_id #=> String
resp.assistant_association.assistant_arn #=> String
resp.assistant_association.association_type #=> String, one of "KNOWLEDGE_BASE"
resp.assistant_association.association_data.knowledge_base_association.knowledge_base_id #=> String
resp.assistant_association.association_data.knowledge_base_association.knowledge_base_arn #=> String
resp.assistant_association.tags #=> Hash
resp.assistant_association.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :association_type (required, String) —

    The type of association.

  • :association (required, Types::AssistantAssociationInputData) —

    The identifier of the associated resource.

  • :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.**

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



1524
1525
1526
1527
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1524

def create_assistant_association(params = {}, options = {})
  req = build_request(:create_assistant_association, params)
  req.send_request(options)
end

#create_content(params = {}) ⇒ Types::CreateContentResponse

Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.

Examples:

Request syntax with placeholder values


resp = client.create_content({
  knowledge_base_id: "UuidOrArn", # required
  name: "Name", # required
  title: "ContentTitle",
  override_link_out_uri: "Uri",
  metadata: {
    "NonEmptyString" => "NonEmptyString",
  },
  upload_id: "UploadId", # required
  client_token: "NonEmptyString",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.content.content_arn #=> String
resp.content.content_id #=> String
resp.content.knowledge_base_arn #=> String
resp.content.knowledge_base_id #=> String
resp.content.name #=> String
resp.content.revision_id #=> String
resp.content.title #=> String
resp.content.content_type #=> String
resp.content.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
resp.content.metadata #=> Hash
resp.content.metadata["NonEmptyString"] #=> String
resp.content.tags #=> Hash
resp.content.tags["TagKey"] #=> String
resp.content.link_out_uri #=> String
resp.content.url #=> String
resp.content.url_expiry #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :name (required, String) —

    The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.

  • :title (String) —

    The title of the content. If not set, the title is equal to the name.

  • :override_link_out_uri (String) —

    The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.

  • :metadata (Hash<String,String>) —

    A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

  • :upload_id (required, String) —

    A pointer to the uploaded asset. This value is returned by StartContentUpload.

  • :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.**

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



1632
1633
1634
1635
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1632

def create_content(params = {}, options = {})
  req = build_request(:create_content, params)
  req.send_request(options)
end

#create_content_association(params = {}) ⇒ Types::CreateContentAssociationResponse

Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.

After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.

Note the following limitations:

  • You can create only one content association for each content resource in a knowledge base.

  • You can associate a step-by-step guide with multiple content resources.

For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.create_content_association({
  client_token: "ClientToken",
  knowledge_base_id: "UuidOrArn", # required
  content_id: "UuidOrArn", # required
  association_type: "AMAZON_CONNECT_GUIDE", # required, accepts AMAZON_CONNECT_GUIDE
  association: { # required
    amazon_connect_guide_association: {
      flow_id: "GenericArn",
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.content_association.knowledge_base_id #=> String
resp.content_association.knowledge_base_arn #=> String
resp.content_association.content_id #=> String
resp.content_association.content_arn #=> String
resp.content_association.content_association_id #=> String
resp.content_association.content_association_arn #=> String
resp.content_association.association_type #=> String, one of "AMAZON_CONNECT_GUIDE"
resp.content_association.association_data.amazon_connect_guide_association.flow_id #=> String
resp.content_association.tags #=> Hash
resp.content_association.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.**

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base.

  • :content_id (required, String) —

    The identifier of the content.

  • :association_type (required, String) —

    The type of association.

  • :association (required, Types::ContentAssociationContents) —

    The identifier of the associated resource.

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



1729
1730
1731
1732
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1729

def create_content_association(params = {}, options = {})
  req = build_request(:create_content_association, params)
  req.send_request(options)
end

#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse

Creates a knowledge base.

When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.

For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:

  1. Call DeleteKnowledgeBase.

  2. Call DeleteDataIntegration.

  3. Call CreateDataIntegration to recreate the DataIntegration or a create different one.

  4. Call CreateKnowledgeBase.

Examples:

Request syntax with placeholder values


resp = client.create_knowledge_base({
  client_token: "NonEmptyString",
  name: "Name", # required
  knowledge_base_type: "EXTERNAL", # required, accepts EXTERNAL, CUSTOM, QUICK_RESPONSES, MESSAGE_TEMPLATES, MANAGED
  source_configuration: {
    app_integrations: {
      app_integration_arn: "GenericArn", # required
      object_fields: ["NonEmptyString"],
    },
    managed_source_configuration: {
      web_crawler_configuration: {
        url_configuration: { # required
          seed_urls: [
            {
              url: "WebUrl",
            },
          ],
        },
        crawler_limits: {
          rate_limit: 1,
        },
        inclusion_filters: ["UrlFilterPattern"],
        exclusion_filters: ["UrlFilterPattern"],
        scope: "HOST_ONLY", # accepts HOST_ONLY, SUBDOMAINS
      },
    },
  },
  rendering_configuration: {
    template_uri: "Uri",
  },
  vector_ingestion_configuration: {
    chunking_configuration: {
      chunking_strategy: "FIXED_SIZE", # required, accepts FIXED_SIZE, NONE, HIERARCHICAL, SEMANTIC
      fixed_size_chunking_configuration: {
        max_tokens: 1, # required
        overlap_percentage: 1, # required
      },
      hierarchical_chunking_configuration: {
        level_configurations: [ # required
          {
            max_tokens: 1, # required
          },
        ],
        overlap_tokens: 1, # required
      },
      semantic_chunking_configuration: {
        max_tokens: 1, # required
        buffer_size: 1, # required
        breakpoint_percentile_threshold: 1, # required
      },
    },
    parsing_configuration: {
      parsing_strategy: "BEDROCK_FOUNDATION_MODEL", # required, accepts BEDROCK_FOUNDATION_MODEL
      bedrock_foundation_model_configuration: {
        model_arn: "BedrockModelArnForParsing", # required
        parsing_prompt: {
          parsing_prompt_text: "ParsingPromptText", # required
        },
      },
    },
  },
  server_side_encryption_configuration: {
    kms_key_id: "NonEmptyString",
  },
  description: "Description",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.knowledge_base.knowledge_base_id #=> String
resp.knowledge_base.knowledge_base_arn #=> String
resp.knowledge_base.name #=> String
resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES", "MESSAGE_TEMPLATES", "MANAGED"
resp.knowledge_base.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.knowledge_base.last_content_modification_time #=> Time
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.chunking_strategy #=> String, one of "FIXED_SIZE", "NONE", "HIERARCHICAL", "SEMANTIC"
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.max_tokens #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.overlap_percentage #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations #=> Array
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations[0].max_tokens #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.overlap_tokens #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.max_tokens #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.buffer_size #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.breakpoint_percentile_threshold #=> Integer
resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.parsing_strategy #=> String, one of "BEDROCK_FOUNDATION_MODEL"
resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.model_arn #=> String
resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.parsing_prompt.parsing_prompt_text #=> String
resp.knowledge_base.source_configuration.app_integrations.app_integration_arn #=> String
resp.knowledge_base.source_configuration.app_integrations.object_fields #=> Array
resp.knowledge_base.source_configuration.app_integrations.object_fields[0] #=> String
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls #=> Array
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls[0].url #=> String
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.crawler_limits.rate_limit #=> Integer
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters #=> Array
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters[0] #=> String
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters #=> Array
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters[0] #=> String
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.scope #=> String, one of "HOST_ONLY", "SUBDOMAINS"
resp.knowledge_base.rendering_configuration.template_uri #=> String
resp.knowledge_base.server_side_encryption_configuration.kms_key_id #=> String
resp.knowledge_base.description #=> String
resp.knowledge_base.tags #=> Hash
resp.knowledge_base.tags["TagKey"] #=> String
resp.knowledge_base.ingestion_status #=> String, one of "SYNC_FAILED", "SYNCING_IN_PROGRESS", "SYNC_SUCCESS", "CREATE_IN_PROGRESS"
resp.knowledge_base.ingestion_failure_reasons #=> Array
resp.knowledge_base.ingestion_failure_reasons[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.**

  • :name (required, String) —

    The name of the knowledge base.

  • :knowledge_base_type (required, String) —

    The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

  • :source_configuration (Types::SourceConfiguration) —

    The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.

  • :rendering_configuration (Types::RenderingConfiguration) —

    Information about how to render the content.

  • :vector_ingestion_configuration (Types::VectorIngestionConfiguration) —

    Contains details about how to ingest the documents in a data source.

  • :server_side_encryption_configuration (Types::ServerSideEncryptionConfiguration) —

    The configuration information for the customer managed key used for encryption.

    This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

  • :description (String) —

    The description.

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



1936
1937
1938
1939
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 1936

def create_knowledge_base(params = {}, options = {})
  req = build_request(:create_knowledge_base, params)
  req.send_request(options)
end

#create_message_template(params = {}) ⇒ Types::CreateMessageTemplateResponse

Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.

Examples:

Request syntax with placeholder values


resp = client.create_message_template({
  knowledge_base_id: "UuidOrArn", # required
  name: "Name", # required
  content: { # required
    email: {
      subject: "NonEmptyUnlimitedString",
      body: {
        plain_text: {
          content: "NonEmptyUnlimitedString",
        },
        html: {
          content: "NonEmptyUnlimitedString",
        },
      },
      headers: [
        {
          name: "EmailHeaderKey",
          value: "EmailHeaderValue",
        },
      ],
    },
    sms: {
      body: {
        plain_text: {
          content: "NonEmptyUnlimitedString",
        },
      },
    },
  },
  description: "Description",
  channel_subtype: "EMAIL", # required, accepts EMAIL, SMS
  language: "LanguageCode",
  default_attributes: {
    system_attributes: {
      name: "MessageTemplateAttributeValue",
      customer_endpoint: {
        address: "MessageTemplateAttributeValue",
      },
      system_endpoint: {
        address: "MessageTemplateAttributeValue",
      },
    },
    agent_attributes: {
      first_name: "MessageTemplateAttributeValue",
      last_name: "MessageTemplateAttributeValue",
    },
    customer_profile_attributes: {
      profile_id: "MessageTemplateAttributeValue",
      profile_arn: "MessageTemplateAttributeValue",
      first_name: "MessageTemplateAttributeValue",
      middle_name: "MessageTemplateAttributeValue",
      last_name: "MessageTemplateAttributeValue",
      account_number: "MessageTemplateAttributeValue",
      email_address: "MessageTemplateAttributeValue",
      phone_number: "MessageTemplateAttributeValue",
      additional_information: "MessageTemplateAttributeValue",
      party_type: "MessageTemplateAttributeValue",
      business_name: "MessageTemplateAttributeValue",
      birth_date: "MessageTemplateAttributeValue",
      gender: "MessageTemplateAttributeValue",
      mobile_phone_number: "MessageTemplateAttributeValue",
      home_phone_number: "MessageTemplateAttributeValue",
      business_phone_number: "MessageTemplateAttributeValue",
      business_email_address: "MessageTemplateAttributeValue",
      address1: "MessageTemplateAttributeValue",
      address2: "MessageTemplateAttributeValue",
      address3: "MessageTemplateAttributeValue",
      address4: "MessageTemplateAttributeValue",
      city: "MessageTemplateAttributeValue",
      county: "MessageTemplateAttributeValue",
      country: "MessageTemplateAttributeValue",
      postal_code: "MessageTemplateAttributeValue",
      province: "MessageTemplateAttributeValue",
      state: "MessageTemplateAttributeValue",
      shipping_address_1: "MessageTemplateAttributeValue",
      shipping_address_2: "MessageTemplateAttributeValue",
      shipping_address_3: "MessageTemplateAttributeValue",
      shipping_address_4: "MessageTemplateAttributeValue",
      shipping_city: "MessageTemplateAttributeValue",
      shipping_county: "MessageTemplateAttributeValue",
      shipping_country: "MessageTemplateAttributeValue",
      shipping_postal_code: "MessageTemplateAttributeValue",
      shipping_province: "MessageTemplateAttributeValue",
      shipping_state: "MessageTemplateAttributeValue",
      mailing_address_1: "MessageTemplateAttributeValue",
      mailing_address_2: "MessageTemplateAttributeValue",
      mailing_address_3: "MessageTemplateAttributeValue",
      mailing_address_4: "MessageTemplateAttributeValue",
      mailing_city: "MessageTemplateAttributeValue",
      mailing_county: "MessageTemplateAttributeValue",
      mailing_country: "MessageTemplateAttributeValue",
      mailing_postal_code: "MessageTemplateAttributeValue",
      mailing_province: "MessageTemplateAttributeValue",
      mailing_state: "MessageTemplateAttributeValue",
      billing_address_1: "MessageTemplateAttributeValue",
      billing_address_2: "MessageTemplateAttributeValue",
      billing_address_3: "MessageTemplateAttributeValue",
      billing_address_4: "MessageTemplateAttributeValue",
      billing_city: "MessageTemplateAttributeValue",
      billing_county: "MessageTemplateAttributeValue",
      billing_country: "MessageTemplateAttributeValue",
      billing_postal_code: "MessageTemplateAttributeValue",
      billing_province: "MessageTemplateAttributeValue",
      billing_state: "MessageTemplateAttributeValue",
      custom: {
        "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
      },
    },
    custom_attributes: {
      "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
    },
  },
  grouping_configuration: {
    criteria: "GroupingCriteria",
    values: ["GroupingValue"],
  },
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.message_template.message_template_arn #=> String
resp.message_template.message_template_id #=> String
resp.message_template.knowledge_base_arn #=> String
resp.message_template.knowledge_base_id #=> String
resp.message_template.name #=> String
resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
resp.message_template.created_time #=> Time
resp.message_template.last_modified_time #=> Time
resp.message_template.last_modified_by #=> String
resp.message_template.content.email.subject #=> String
resp.message_template.content.email.body.plain_text.content #=> String
resp.message_template.content.email.body.html.content #=> String
resp.message_template.content.email.headers #=> Array
resp.message_template.content.email.headers[0].name #=> String
resp.message_template.content.email.headers[0].value #=> String
resp.message_template.content.sms.body.plain_text.content #=> String
resp.message_template.description #=> String
resp.message_template.language #=> String
resp.message_template.grouping_configuration.criteria #=> String
resp.message_template.grouping_configuration.values #=> Array
resp.message_template.grouping_configuration.values[0] #=> String
resp.message_template.default_attributes.system_attributes.name #=> String
resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
resp.message_template.default_attributes.agent_attributes.first_name #=> String
resp.message_template.default_attributes.agent_attributes.last_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
resp.message_template.default_attributes.customer_profile_attributes. #=> String
resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.city #=> String
resp.message_template.default_attributes.customer_profile_attributes.county #=> String
resp.message_template.default_attributes.customer_profile_attributes.country #=> String
resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.province #=> String
resp.message_template.default_attributes.customer_profile_attributes.state #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
resp.message_template.default_attributes.custom_attributes #=> Hash
resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
resp.message_template.attribute_types #=> Array
resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
resp.message_template.message_template_content_sha_256 #=> String
resp.message_template.tags #=> Hash
resp.message_template.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :name (required, String) —

    The name of the message template.

  • :content (required, Types::MessageTemplateContentProvider) —

    The content of the message template.

  • :description (String) —

    The description of the message template.

  • :channel_subtype (required, String) —

    The channel subtype this message template applies to.

  • :language (String) —

    The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

  • :default_attributes (Types::MessageTemplateAttributes) —

    An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.

  • :grouping_configuration (Types::GroupingConfiguration) —

    The configuration information of the grouping of Amazon Q in Connect users.

  • :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.**

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



2223
2224
2225
2226
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2223

def create_message_template(params = {}, options = {})
  req = build_request(:create_message_template, params)
  req.send_request(options)
end

#create_message_template_attachment(params = {}) ⇒ Types::CreateMessageTemplateAttachmentResponse

Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the $LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.

Examples:

Request syntax with placeholder values


resp = client.create_message_template_attachment({
  knowledge_base_id: "UuidOrArn", # required
  message_template_id: "UuidOrArnOrEitherWithQualifier", # required
  content_disposition: "ATTACHMENT", # required, accepts ATTACHMENT
  name: "AttachmentFileName", # required
  body: "NonEmptyUnlimitedString", # required
  client_token: "ClientToken",
})

Response structure


resp.attachment.content_disposition #=> String, one of "ATTACHMENT"
resp.attachment.name #=> String
resp.attachment.uploaded_time #=> Time
resp.attachment.url #=> String
resp.attachment.url_expiry #=> Time
resp.attachment.attachment_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :message_template_id (required, String) —

    The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.

  • :content_disposition (required, String) —

    The presentation information for the attachment file.

  • :name (required, String) —

    The name of the attachment file being uploaded. The name should include the file extension.

  • :body (required, String) —

    The body of the attachment file being uploaded. It should be encoded using base64 encoding.

  • :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.

Returns:

See Also:



2293
2294
2295
2296
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2293

def create_message_template_attachment(params = {}, options = {})
  req = build_request(:create_message_template_attachment, params)
  req.send_request(options)
end

#create_message_template_version(params = {}) ⇒ Types::CreateMessageTemplateVersionResponse

Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in <message-template-id>:<versionNumber> as the message template identifier. An error is displayed if the supplied messageTemplateContentSha256 is different from the messageTemplateContentSha256 of the message template with $LATEST qualifier. If multiple CreateMessageTemplateVersion requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.

Examples:

Request syntax with placeholder values


resp = client.create_message_template_version({
  knowledge_base_id: "UuidOrArn", # required
  message_template_id: "UuidOrArnOrEitherWithQualifier", # required
  message_template_content_sha_256: "MessageTemplateContentSha256",
})

Response structure


resp.message_template.message_template_arn #=> String
resp.message_template.message_template_id #=> String
resp.message_template.knowledge_base_arn #=> String
resp.message_template.knowledge_base_id #=> String
resp.message_template.name #=> String
resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
resp.message_template.created_time #=> Time
resp.message_template.last_modified_time #=> Time
resp.message_template.last_modified_by #=> String
resp.message_template.content.email.subject #=> String
resp.message_template.content.email.body.plain_text.content #=> String
resp.message_template.content.email.body.html.content #=> String
resp.message_template.content.email.headers #=> Array
resp.message_template.content.email.headers[0].name #=> String
resp.message_template.content.email.headers[0].value #=> String
resp.message_template.content.sms.body.plain_text.content #=> String
resp.message_template.description #=> String
resp.message_template.language #=> String
resp.message_template.grouping_configuration.criteria #=> String
resp.message_template.grouping_configuration.values #=> Array
resp.message_template.grouping_configuration.values[0] #=> String
resp.message_template.default_attributes.system_attributes.name #=> String
resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
resp.message_template.default_attributes.agent_attributes.first_name #=> String
resp.message_template.default_attributes.agent_attributes.last_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
resp.message_template.default_attributes.customer_profile_attributes. #=> String
resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.city #=> String
resp.message_template.default_attributes.customer_profile_attributes.county #=> String
resp.message_template.default_attributes.customer_profile_attributes.country #=> String
resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.province #=> String
resp.message_template.default_attributes.customer_profile_attributes.state #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
resp.message_template.default_attributes.custom_attributes #=> Hash
resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
resp.message_template.attribute_types #=> Array
resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
resp.message_template.attachments #=> Array
resp.message_template.attachments[0].content_disposition #=> String, one of "ATTACHMENT"
resp.message_template.attachments[0].name #=> String
resp.message_template.attachments[0].uploaded_time #=> Time
resp.message_template.attachments[0].url #=> String
resp.message_template.attachments[0].url_expiry #=> Time
resp.message_template.attachments[0].attachment_id #=> String
resp.message_template.is_active #=> Boolean
resp.message_template.version_number #=> Integer
resp.message_template.message_template_content_sha_256 #=> String
resp.message_template.tags #=> Hash
resp.message_template.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :message_template_id (required, String) —

    The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.

  • :message_template_content_sha_256 (String) —

    The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template. If not supplied, the message template version will be created based on the message template content that is referenced by the $LATEST qualifier by default.

Returns:

See Also:



2448
2449
2450
2451
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2448

def create_message_template_version(params = {}, options = {})
  req = build_request(:create_message_template_version, params)
  req.send_request(options)
end

#create_quick_response(params = {}) ⇒ Types::CreateQuickResponseResponse

Creates an Amazon Q in Connect quick response.

Examples:

Request syntax with placeholder values


resp = client.create_quick_response({
  knowledge_base_id: "UuidOrArn", # required
  name: "QuickResponseName", # required
  content: { # required
    content: "QuickResponseContent",
  },
  content_type: "QuickResponseType",
  grouping_configuration: {
    criteria: "GroupingCriteria",
    values: ["GroupingValue"],
  },
  description: "QuickResponseDescription",
  shortcut_key: "ShortCutKey",
  is_active: false,
  channels: ["Channel"],
  language: "LanguageCode",
  client_token: "NonEmptyString",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.quick_response.quick_response_arn #=> String
resp.quick_response.quick_response_id #=> String
resp.quick_response.knowledge_base_arn #=> String
resp.quick_response.knowledge_base_id #=> String
resp.quick_response.name #=> String
resp.quick_response.content_type #=> String
resp.quick_response.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.quick_response.created_time #=> Time
resp.quick_response.last_modified_time #=> Time
resp.quick_response.contents.plain_text.content #=> String
resp.quick_response.contents.markdown.content #=> String
resp.quick_response.description #=> String
resp.quick_response.grouping_configuration.criteria #=> String
resp.quick_response.grouping_configuration.values #=> Array
resp.quick_response.grouping_configuration.values[0] #=> String
resp.quick_response.shortcut_key #=> String
resp.quick_response.last_modified_by #=> String
resp.quick_response.is_active #=> Boolean
resp.quick_response.channels #=> Array
resp.quick_response.channels[0] #=> String
resp.quick_response.language #=> String
resp.quick_response.tags #=> Hash
resp.quick_response.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :name (required, String) —

    The name of the quick response.

  • :content (required, Types::QuickResponseDataProvider) —

    The content of the quick response.

  • :content_type (String) —

    The media type of the quick response content.

    • Use application/x.quickresponse;format=plain for a quick response written in plain text.

    • Use application/x.quickresponse;format=markdown for a quick response written in richtext.

  • :grouping_configuration (Types::GroupingConfiguration) —

    The configuration information of the user groups that the quick response is accessible to.

  • :description (String) —

    The description of the quick response.

  • :shortcut_key (String) —

    The shortcut key of the quick response. The value should be unique across the knowledge base.

  • :is_active (Boolean) —

    Whether the quick response is active.

  • :channels (Array<String>) —

    The Amazon Connect channels this quick response applies to.

  • :language (String) —

    The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

  • :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.**

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



2571
2572
2573
2574
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2571

def create_quick_response(params = {}, options = {})
  req = build_request(:create_quick_response, params)
  req.send_request(options)
end

#create_session(params = {}) ⇒ Types::CreateSessionResponse

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

Examples:

Request syntax with placeholder values


resp = client.create_session({
  client_token: "ClientToken",
  assistant_id: "UuidOrArn", # required
  name: "Name", # required
  description: "Description",
  tags: {
    "TagKey" => "TagValue",
  },
  tag_filter: {
    tag_condition: {
      key: "TagKey", # required
      value: "TagValue",
    },
    and_conditions: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
    or_conditions: [
      {
        and_conditions: [
          {
            key: "TagKey", # required
            value: "TagValue",
          },
        ],
        tag_condition: {
          key: "TagKey", # required
          value: "TagValue",
        },
      },
    ],
  },
  ai_agent_configuration: {
    "MANUAL_SEARCH" => {
      ai_agent_id: "UuidWithQualifier", # required
    },
  },
})

Response structure


resp.session.session_arn #=> String
resp.session.session_id #=> String
resp.session.name #=> String
resp.session.description #=> String
resp.session.tags #=> Hash
resp.session.tags["TagKey"] #=> String
resp.session.integration_configuration.topic_integration_arn #=> String
resp.session.tag_filter.tag_condition.key #=> String
resp.session.tag_filter.tag_condition.value #=> String
resp.session.tag_filter.and_conditions #=> Array
resp.session.tag_filter.and_conditions[0].key #=> String
resp.session.tag_filter.and_conditions[0].value #=> String
resp.session.tag_filter.or_conditions #=> Array
resp.session.tag_filter.or_conditions[0].and_conditions #=> Array
resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String
resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String
resp.session.ai_agent_configuration #=> Hash
resp.session.ai_agent_configuration["AIAgentType"].ai_agent_id #=> String
resp.session.origin #=> String, one of "SYSTEM", "CUSTOMER"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.**

  • :assistant_id (required, String) —

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

  • :name (required, String) —

    The name of the session.

  • :description (String) —

    The description.

  • :tags (Hash<String,String>) —

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

  • :tag_filter (Types::TagFilter) —

    An object that can be used to specify Tag conditions.

  • :ai_agent_configuration (Hash<String,Types::AIAgentConfigurationData>) —

    The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

Returns:

See Also:



2690
2691
2692
2693
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2690

def create_session(params = {}, options = {})
  req = build_request(:create_session, params)
  req.send_request(options)
end

#deactivate_message_template(params = {}) ⇒ Types::DeactivateMessageTemplateResponse

Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the $ACTIVE_VERSION qualifier to reference the version in active status.

Examples:

Request syntax with placeholder values


resp = client.deactivate_message_template({
  knowledge_base_id: "UuidOrArn", # required
  message_template_id: "UuidOrArnOrEitherWithQualifier", # required
  version_number: 1, # required
})

Response structure


resp.message_template_arn #=> String
resp.message_template_id #=> String
resp.version_number #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :message_template_id (required, String) —

    The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.

  • :version_number (required, Integer) —

    The version number of the message template version to deactivate.

Returns:

See Also:



2734
2735
2736
2737
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2734

def deactivate_message_template(params = {}, options = {})
  req = build_request(:deactivate_message_template, params)
  req.send_request(options)
end

#delete_ai_agent(params = {}) ⇒ Struct

Deletes an Amazon Q in Connect AI Agent.

Examples:

Request syntax with placeholder values


resp = client.delete_ai_agent({
  assistant_id: "UuidOrArn", # required
  ai_agent_id: "UuidOrArnOrEitherWithQualifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_agent_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2762
2763
2764
2765
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2762

def delete_ai_agent(params = {}, options = {})
  req = build_request(:delete_ai_agent, params)
  req.send_request(options)
end

#delete_ai_agent_version(params = {}) ⇒ Struct

Deletes an Amazon Q in Connect AI Agent Version.

Examples:

Request syntax with placeholder values


resp = client.delete_ai_agent_version({
  assistant_id: "UuidOrArn", # required
  ai_agent_id: "UuidOrArnOrEitherWithQualifier", # required
  version_number: 1, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_agent_id (required, String) —

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

  • :version_number (required, Integer) —

    The version number of the AI Agent version.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2794
2795
2796
2797
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2794

def delete_ai_agent_version(params = {}, options = {})
  req = build_request(:delete_ai_agent_version, params)
  req.send_request(options)
end

#delete_ai_guardrail(params = {}) ⇒ Struct

Deletes an Amazon Q in Connect AI Guardrail.

Examples:

Request syntax with placeholder values


resp = client.delete_ai_guardrail({
  assistant_id: "UuidOrArn", # required
  ai_guardrail_id: "UuidOrArnOrEitherWithQualifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_guardrail_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2822
2823
2824
2825
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2822

def delete_ai_guardrail(params = {}, options = {})
  req = build_request(:delete_ai_guardrail, params)
  req.send_request(options)
end

#delete_ai_guardrail_version(params = {}) ⇒ Struct

Delete and Amazon Q in Connect AI Guardrail version.

Examples:

Request syntax with placeholder values


resp = client.delete_ai_guardrail_version({
  assistant_id: "UuidOrArn", # required
  ai_guardrail_id: "UuidOrArnOrEitherWithQualifier", # required
  version_number: 1, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_guardrail_id (required, String) —

    The identifier of the Amazon Q in Connect AI Guardrail.

  • :version_number (required, Integer) —

    The version number of the AI Guardrail version to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2853
2854
2855
2856
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2853

def delete_ai_guardrail_version(params = {}, options = {})
  req = build_request(:delete_ai_guardrail_version, params)
  req.send_request(options)
end

#delete_ai_prompt(params = {}) ⇒ Struct

Deletes an Amazon Q in Connect AI Prompt.

Examples:

Request syntax with placeholder values


resp = client.delete_ai_prompt({
  assistant_id: "UuidOrArn", # required
  ai_prompt_id: "UuidOrArnOrEitherWithQualifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_prompt_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2881
2882
2883
2884
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2881

def delete_ai_prompt(params = {}, options = {})
  req = build_request(:delete_ai_prompt, params)
  req.send_request(options)
end

#delete_ai_prompt_version(params = {}) ⇒ Struct

Delete and Amazon Q in Connect AI Prompt version.

Examples:

Request syntax with placeholder values


resp = client.delete_ai_prompt_version({
  assistant_id: "UuidOrArn", # required
  ai_prompt_id: "UuidOrArnOrEitherWithQualifier", # required
  version_number: 1, # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_prompt_id (required, String) —

    The identifier of the Amazon Q in Connect AI prompt.

  • :version_number (required, Integer) —

    The version number of the AI Prompt version to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2912
2913
2914
2915
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2912

def delete_ai_prompt_version(params = {}, options = {})
  req = build_request(:delete_ai_prompt_version, params)
  req.send_request(options)
end

#delete_assistant(params = {}) ⇒ Struct

Deletes an assistant.

Examples:

Request syntax with placeholder values


resp = client.delete_assistant({
  assistant_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2935
2936
2937
2938
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2935

def delete_assistant(params = {}, options = {})
  req = build_request(:delete_assistant, params)
  req.send_request(options)
end

#delete_assistant_association(params = {}) ⇒ Struct

Deletes an assistant association.

Examples:

Request syntax with placeholder values


resp = client.delete_assistant_association({
  assistant_association_id: "UuidOrArn", # required
  assistant_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_association_id (required, String) —

    The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :assistant_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2963
2964
2965
2966
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2963

def delete_assistant_association(params = {}, options = {})
  req = build_request(:delete_assistant_association, params)
  req.send_request(options)
end

#delete_content(params = {}) ⇒ Struct

Deletes the content.

Examples:

Request syntax with placeholder values


resp = client.delete_content({
  knowledge_base_id: "UuidOrArn", # required
  content_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :content_id (required, String) —

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2991
2992
2993
2994
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 2991

def delete_content(params = {}, options = {})
  req = build_request(:delete_content, params)
  req.send_request(options)
end

#delete_content_association(params = {}) ⇒ Struct

Deletes the content association.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.delete_content_association({
  knowledge_base_id: "UuidOrArn", # required
  content_id: "UuidOrArn", # required
  content_association_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base.

  • :content_id (required, String) —

    The identifier of the content.

  • :content_association_id (required, String) —

    The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3030
3031
3032
3033
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3030

def delete_content_association(params = {}, options = {})
  req = build_request(:delete_content_association, params)
  req.send_request(options)
end

#delete_import_job(params = {}) ⇒ Struct

Deletes the quick response import job.

Examples:

Request syntax with placeholder values


resp = client.delete_import_job({
  knowledge_base_id: "UuidOrArn", # required
  import_job_id: "Uuid", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base.

  • :import_job_id (required, String) —

    The identifier of the import job to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3056
3057
3058
3059
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3056

def delete_import_job(params = {}, options = {})
  req = build_request(:delete_import_job, params)
  req.send_request(options)
end

#delete_knowledge_base(params = {}) ⇒ Struct

Deletes the knowledge base.

When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.

Examples:

Request syntax with placeholder values


resp = client.delete_knowledge_base({
  knowledge_base_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3095
3096
3097
3098
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3095

def delete_knowledge_base(params = {}, options = {})
  req = build_request(:delete_knowledge_base, params)
  req.send_request(options)
end

#delete_message_template(params = {}) ⇒ Struct

Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_message_template({
  knowledge_base_id: "UuidOrArn", # required
  message_template_id: "UuidOrArnOrEitherWithQualifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :message_template_id (required, String) —

    The identifier of the message template. Can be either the ID or the ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3128
3129
3130
3131
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3128

def delete_message_template(params = {}, options = {})
  req = build_request(:delete_message_template, params)
  req.send_request(options)
end

#delete_message_template_attachment(params = {}) ⇒ Struct

Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template versions will remain unchanged.

Examples:

Request syntax with placeholder values


resp = client.delete_message_template_attachment({
  knowledge_base_id: "UuidOrArn", # required
  message_template_id: "UuidOrArnOrEitherWithQualifier", # required
  attachment_id: "Uuid", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :message_template_id (required, String) —

    The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.

  • :attachment_id (required, String) —

    The identifier of the attachment file.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3162
3163
3164
3165
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3162

def delete_message_template_attachment(params = {}, options = {})
  req = build_request(:delete_message_template_attachment, params)
  req.send_request(options)
end

#delete_quick_response(params = {}) ⇒ Struct

Deletes a quick response.

Examples:

Request syntax with placeholder values


resp = client.delete_quick_response({
  knowledge_base_id: "UuidOrArn", # required
  quick_response_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The knowledge base from which the quick response is deleted. The identifier of the knowledge base.

  • :quick_response_id (required, String) —

    The identifier of the quick response to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3189
3190
3191
3192
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3189

def delete_quick_response(params = {}, options = {})
  req = build_request(:delete_quick_response, params)
  req.send_request(options)
end

#get_ai_agent(params = {}) ⇒ Types::GetAIAgentResponse

Gets an Amazon Q in Connect AI Agent.

Examples:

Request syntax with placeholder values


resp = client.get_ai_agent({
  assistant_id: "UuidOrArn", # required
  ai_agent_id: "UuidOrArnOrEitherWithQualifier", # required
})

Response structure


resp.ai_agent.assistant_id #=> String
resp.ai_agent.assistant_arn #=> String
resp.ai_agent.ai_agent_id #=> String
resp.ai_agent.ai_agent_arn #=> String
resp.ai_agent.name #=> String
resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION", "SELF_SERVICE"
resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent.configuration.manual_search_ai_agent_configuration.locale #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.locale #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_pre_processing_ai_prompt_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_answer_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_ai_guardrail_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent.modified_time #=> Time
resp.ai_agent.description #=> String
resp.ai_agent.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_agent.tags #=> Hash
resp.ai_agent.tags["TagKey"] #=> String
resp.ai_agent.origin #=> String, one of "SYSTEM", "CUSTOMER"
resp.ai_agent.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.version_number #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_agent_id (required, String) —

    The identifier of the Amazon Q in Connect AI Agent (with or without a version qualifier). Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



3297
3298
3299
3300
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3297

def get_ai_agent(params = {}, options = {})
  req = build_request(:get_ai_agent, params)
  req.send_request(options)
end

#get_ai_guardrail(params = {}) ⇒ Types::GetAIGuardrailResponse

Gets the Amazon Q in Connect AI Guardrail.

Examples:

Request syntax with placeholder values


resp = client.get_ai_guardrail({
  assistant_id: "UuidOrArn", # required
  ai_guardrail_id: "UuidOrArnOrEitherWithQualifier", # required
})

Response structure


resp.ai_guardrail.assistant_id #=> String
resp.ai_guardrail.assistant_arn #=> String
resp.ai_guardrail.ai_guardrail_arn #=> String
resp.ai_guardrail.ai_guardrail_id #=> String
resp.ai_guardrail.name #=> String
resp.ai_guardrail.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_guardrail.blocked_input_messaging #=> String
resp.ai_guardrail.blocked_outputs_messaging #=> String
resp.ai_guardrail.description #=> String
resp.ai_guardrail.topic_policy_config.topics_config #=> Array
resp.ai_guardrail.topic_policy_config.topics_config[0].name #=> String
resp.ai_guardrail.topic_policy_config.topics_config[0].definition #=> String
resp.ai_guardrail.topic_policy_config.topics_config[0].examples #=> Array
resp.ai_guardrail.topic_policy_config.topics_config[0].examples[0] #=> String
resp.ai_guardrail.topic_policy_config.topics_config[0].type #=> String, one of "DENY"
resp.ai_guardrail.content_policy_config.filters_config #=> Array
resp.ai_guardrail.content_policy_config.filters_config[0].type #=> String, one of "SEXUAL", "VIOLENCE", "HATE", "INSULTS", "MISCONDUCT", "PROMPT_ATTACK"
resp.ai_guardrail.content_policy_config.filters_config[0].input_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
resp.ai_guardrail.content_policy_config.filters_config[0].output_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
resp.ai_guardrail.word_policy_config.words_config #=> Array
resp.ai_guardrail.word_policy_config.words_config[0].text #=> String
resp.ai_guardrail.word_policy_config.managed_word_lists_config #=> Array
resp.ai_guardrail.word_policy_config.managed_word_lists_config[0].type #=> String, one of "PROFANITY"
resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config #=> Array
resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].type #=> String, one of "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME", "PASSWORD", "PHONE", "PIN", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "URL", "USERNAME", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "VEHICLE_IDENTIFICATION_NUMBER"
resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
resp.ai_guardrail.sensitive_information_policy_config.regexes_config #=> Array
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].name #=> String
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].description #=> String
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].pattern #=> String
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
resp.ai_guardrail.contextual_grounding_policy_config.filters_config #=> Array
resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].type #=> String, one of "GROUNDING", "RELEVANCE"
resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].threshold #=> Float
resp.ai_guardrail.tags #=> Hash
resp.ai_guardrail.tags["TagKey"] #=> String
resp.ai_guardrail.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.ai_guardrail.modified_time #=> Time
resp.version_number #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_guardrail_id (required, String) —

    The identifier of the Amazon Q in Connect AI Guardrail.

Returns:

See Also:



3369
3370
3371
3372
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3369

def get_ai_guardrail(params = {}, options = {})
  req = build_request(:get_ai_guardrail, params)
  req.send_request(options)
end

#get_ai_prompt(params = {}) ⇒ Types::GetAIPromptResponse

Gets and Amazon Q in Connect AI Prompt.

Examples:

Request syntax with placeholder values


resp = client.get_ai_prompt({
  assistant_id: "UuidOrArn", # required
  ai_prompt_id: "UuidOrArnOrEitherWithQualifier", # required
})

Response structure


resp.ai_prompt.assistant_id #=> String
resp.ai_prompt.assistant_arn #=> String
resp.ai_prompt.ai_prompt_id #=> String
resp.ai_prompt.ai_prompt_arn #=> String
resp.ai_prompt.name #=> String
resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION", "SELF_SERVICE_PRE_PROCESSING", "SELF_SERVICE_ANSWER_GENERATION"
resp.ai_prompt.template_type #=> String, one of "TEXT"
resp.ai_prompt.model_id #=> String
resp.ai_prompt.api_format #=> String, one of "ANTHROPIC_CLAUDE_MESSAGES", "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS", "MESSAGES", "TEXT_COMPLETIONS"
resp.ai_prompt.template_configuration.text_full_ai_prompt_edit_template_configuration.text #=> String
resp.ai_prompt.modified_time #=> Time
resp.ai_prompt.description #=> String
resp.ai_prompt.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_prompt.tags #=> Hash
resp.ai_prompt.tags["TagKey"] #=> String
resp.ai_prompt.origin #=> String, one of "SYSTEM", "CUSTOMER"
resp.ai_prompt.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.version_number #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_prompt_id (required, String) —

    The identifier of the Amazon Q in Connect AI prompt.

Returns:

See Also:



3420
3421
3422
3423
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3420

def get_ai_prompt(params = {}, options = {})
  req = build_request(:get_ai_prompt, params)
  req.send_request(options)
end

#get_assistant(params = {}) ⇒ Types::GetAssistantResponse

Retrieves information about an assistant.

Examples:

Request syntax with placeholder values


resp = client.get_assistant({
  assistant_id: "UuidOrArn", # required
})

Response structure


resp.assistant.assistant_id #=> String
resp.assistant.assistant_arn #=> String
resp.assistant.name #=> String
resp.assistant.type #=> String, one of "AGENT"
resp.assistant.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.assistant.description #=> String
resp.assistant.tags #=> Hash
resp.assistant.tags["TagKey"] #=> String
resp.assistant.server_side_encryption_configuration.kms_key_id #=> String
resp.assistant.integration_configuration.topic_integration_arn #=> String
resp.assistant.capability_configuration.type #=> String, one of "V1", "V2"
resp.assistant.ai_agent_configuration #=> Hash
resp.assistant.ai_agent_configuration["AIAgentType"].ai_agent_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

Returns:

See Also:



3461
3462
3463
3464
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3461

def get_assistant(params = {}, options = {})
  req = build_request(:get_assistant, params)
  req.send_request(options)
end

#get_assistant_association(params = {}) ⇒ Types::GetAssistantAssociationResponse

Retrieves information about an assistant association.

Examples:

Request syntax with placeholder values


resp = client.get_assistant_association({
  assistant_association_id: "UuidOrArn", # required
  assistant_id: "UuidOrArn", # required
})

Response structure


resp.assistant_association.assistant_association_id #=> String
resp.assistant_association.assistant_association_arn #=> String
resp.assistant_association.assistant_id #=> String
resp.assistant_association.assistant_arn #=> String
resp.assistant_association.association_type #=> String, one of "KNOWLEDGE_BASE"
resp.assistant_association.association_data.knowledge_base_association.knowledge_base_id #=> String
resp.assistant_association.association_data.knowledge_base_association.knowledge_base_arn #=> String
resp.assistant_association.tags #=> Hash
resp.assistant_association.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_association_id (required, String) —

    The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :assistant_id (required, String) —

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

Returns:

See Also:



3503
3504
3505
3506
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3503

def get_assistant_association(params = {}, options = {})
  req = build_request(:get_assistant_association, params)
  req.send_request(options)
end

#get_content(params = {}) ⇒ Types::GetContentResponse

Retrieves content, including a pre-signed URL to download the content.

Examples:

Request syntax with placeholder values


resp = client.get_content({
  content_id: "UuidOrArn", # required
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.content.content_arn #=> String
resp.content.content_id #=> String
resp.content.knowledge_base_arn #=> String
resp.content.knowledge_base_id #=> String
resp.content.name #=> String
resp.content.revision_id #=> String
resp.content.title #=> String
resp.content.content_type #=> String
resp.content.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
resp.content.metadata #=> Hash
resp.content.metadata["NonEmptyString"] #=> String
resp.content.tags #=> Hash
resp.content.tags["TagKey"] #=> String
resp.content.link_out_uri #=> String
resp.content.url #=> String
resp.content.url_expiry #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_id (required, String) —

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



3553
3554
3555
3556
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3553

def get_content(params = {}, options = {})
  req = build_request(:get_content, params)
  req.send_request(options)
end

#get_content_association(params = {}) ⇒ Types::GetContentAssociationResponse

Returns the content association.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

Examples:

Request syntax with placeholder values


resp = client.get_content_association({
  knowledge_base_id: "UuidOrArn", # required
  content_id: "UuidOrArn", # required
  content_association_id: "UuidOrArn", # required
})

Response structure


resp.content_association.knowledge_base_id #=> String
resp.content_association.knowledge_base_arn #=> String
resp.content_association.content_id #=> String
resp.content_association.content_arn #=> String
resp.content_association.content_association_id #=> String
resp.content_association.content_association_arn #=> String
resp.content_association.association_type #=> String, one of "AMAZON_CONNECT_GUIDE"
resp.content_association.association_data.amazon_connect_guide_association.flow_id #=> String
resp.content_association.tags #=> Hash
resp.content_association.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base.

  • :content_id (required, String) —

    The identifier of the content.

  • :content_association_id (required, String) —

    The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



3607
3608
3609
3610
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3607

def get_content_association(params = {}, options = {})
  req = build_request(:get_content_association, params)
  req.send_request(options)
end

#get_content_summary(params = {}) ⇒ Types::GetContentSummaryResponse

Retrieves summary information about the content.

Examples:

Request syntax with placeholder values


resp = client.get_content_summary({
  content_id: "UuidOrArn", # required
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.content_summary.content_arn #=> String
resp.content_summary.content_id #=> String
resp.content_summary.knowledge_base_arn #=> String
resp.content_summary.knowledge_base_id #=> String
resp.content_summary.name #=> String
resp.content_summary.revision_id #=> String
resp.content_summary.title #=> String
resp.content_summary.content_type #=> String
resp.content_summary.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
resp.content_summary.metadata #=> Hash
resp.content_summary.metadata["NonEmptyString"] #=> String
resp.content_summary.tags #=> Hash
resp.content_summary.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :content_id (required, String) —

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



3653
3654
3655
3656
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3653

def get_content_summary(params = {}, options = {})
  req = build_request(:get_content_summary, params)
  req.send_request(options)
end

#get_import_job(params = {}) ⇒ Types::GetImportJobResponse

Retrieves the started import job.

Examples:

Request syntax with placeholder values


resp = client.get_import_job({
  import_job_id: "Uuid", # required
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.import_job.import_job_id #=> String
resp.import_job.knowledge_base_id #=> String
resp.import_job.upload_id #=> String
resp.import_job.knowledge_base_arn #=> String
resp.import_job.import_job_type #=> String, one of "QUICK_RESPONSES"
resp.import_job.status #=> String, one of "START_IN_PROGRESS", "FAILED", "COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.import_job.url #=> String
resp.import_job.failed_record_report #=> String
resp.import_job.url_expiry #=> Time
resp.import_job.created_time #=> Time
resp.import_job.last_modified_time #=> Time
resp.import_job.metadata #=> Hash
resp.import_job.metadata["NonEmptyString"] #=> String
resp.import_job.external_source_configuration.source #=> String, one of "AMAZON_CONNECT"
resp.import_job.external_source_configuration.configuration.connect_configuration.instance_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :import_job_id (required, String) —

    The identifier of the import job to retrieve.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base that the import job belongs to.

Returns:

See Also:



3699
3700
3701
3702
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3699

def get_import_job(params = {}, options = {})
  req = build_request(:get_import_job, params)
  req.send_request(options)
end

#get_knowledge_base(params = {}) ⇒ Types::GetKnowledgeBaseResponse

Retrieves information about the knowledge base.

Examples:

Request syntax with placeholder values


resp = client.get_knowledge_base({
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.knowledge_base.knowledge_base_id #=> String
resp.knowledge_base.knowledge_base_arn #=> String
resp.knowledge_base.name #=> String
resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES", "MESSAGE_TEMPLATES", "MANAGED"
resp.knowledge_base.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.knowledge_base.last_content_modification_time #=> Time
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.chunking_strategy #=> String, one of "FIXED_SIZE", "NONE", "HIERARCHICAL", "SEMANTIC"
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.max_tokens #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.overlap_percentage #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations #=> Array
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations[0].max_tokens #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.overlap_tokens #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.max_tokens #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.buffer_size #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.breakpoint_percentile_threshold #=> Integer
resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.parsing_strategy #=> String, one of "BEDROCK_FOUNDATION_MODEL"
resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.model_arn #=> String
resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.parsing_prompt.parsing_prompt_text #=> String
resp.knowledge_base.source_configuration.app_integrations.app_integration_arn #=> String
resp.knowledge_base.source_configuration.app_integrations.object_fields #=> Array
resp.knowledge_base.source_configuration.app_integrations.object_fields[0] #=> String
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls #=> Array
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls[0].url #=> String
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.crawler_limits.rate_limit #=> Integer
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters #=> Array
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters[0] #=> String
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters #=> Array
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters[0] #=> String
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.scope #=> String, one of "HOST_ONLY", "SUBDOMAINS"
resp.knowledge_base.rendering_configuration.template_uri #=> String
resp.knowledge_base.server_side_encryption_configuration.kms_key_id #=> String
resp.knowledge_base.description #=> String
resp.knowledge_base.tags #=> Hash
resp.knowledge_base.tags["TagKey"] #=> String
resp.knowledge_base.ingestion_status #=> String, one of "SYNC_FAILED", "SYNCING_IN_PROGRESS", "SYNC_SUCCESS", "CREATE_IN_PROGRESS"
resp.knowledge_base.ingestion_failure_reasons #=> Array
resp.knowledge_base.ingestion_failure_reasons[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



3764
3765
3766
3767
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3764

def get_knowledge_base(params = {}, options = {})
  req = build_request(:get_knowledge_base, params)
  req.send_request(options)
end

#get_message_template(params = {}) ⇒ Types::GetMessageTemplateResponse

Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, <message-template-id>:<qualifier>, which is either an actual version number or an Amazon Q Connect managed qualifier $ACTIVE_VERSION | $LATEST. If it is not supplied, then $LATEST is assumed implicitly.

Examples:

Request syntax with placeholder values


resp = client.get_message_template({
  message_template_id: "UuidOrArnOrEitherWithQualifier", # required
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.message_template.message_template_arn #=> String
resp.message_template.message_template_id #=> String
resp.message_template.knowledge_base_arn #=> String
resp.message_template.knowledge_base_id #=> String
resp.message_template.name #=> String
resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
resp.message_template.created_time #=> Time
resp.message_template.last_modified_time #=> Time
resp.message_template.last_modified_by #=> String
resp.message_template.content.email.subject #=> String
resp.message_template.content.email.body.plain_text.content #=> String
resp.message_template.content.email.body.html.content #=> String
resp.message_template.content.email.headers #=> Array
resp.message_template.content.email.headers[0].name #=> String
resp.message_template.content.email.headers[0].value #=> String
resp.message_template.content.sms.body.plain_text.content #=> String
resp.message_template.description #=> String
resp.message_template.language #=> String
resp.message_template.grouping_configuration.criteria #=> String
resp.message_template.grouping_configuration.values #=> Array
resp.message_template.grouping_configuration.values[0] #=> String
resp.message_template.default_attributes.system_attributes.name #=> String
resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
resp.message_template.default_attributes.agent_attributes.first_name #=> String
resp.message_template.default_attributes.agent_attributes.last_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
resp.message_template.default_attributes.customer_profile_attributes. #=> String
resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.city #=> String
resp.message_template.default_attributes.customer_profile_attributes.county #=> String
resp.message_template.default_attributes.customer_profile_attributes.country #=> String
resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.province #=> String
resp.message_template.default_attributes.customer_profile_attributes.state #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
resp.message_template.default_attributes.custom_attributes #=> Hash
resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
resp.message_template.attribute_types #=> Array
resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
resp.message_template.attachments #=> Array
resp.message_template.attachments[0].content_disposition #=> String, one of "ATTACHMENT"
resp.message_template.attachments[0].name #=> String
resp.message_template.attachments[0].uploaded_time #=> Time
resp.message_template.attachments[0].url #=> String
resp.message_template.attachments[0].url_expiry #=> Time
resp.message_template.attachments[0].attachment_id #=> String
resp.message_template.is_active #=> Boolean
resp.message_template.version_number #=> Integer
resp.message_template.message_template_content_sha_256 #=> String
resp.message_template.tags #=> Hash
resp.message_template.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :message_template_id (required, String) —

    The identifier of the message template. Can be either the ID or the ARN.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



3903
3904
3905
3906
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3903

def get_message_template(params = {}, options = {})
  req = build_request(:get_message_template, params)
  req.send_request(options)
end

#get_next_message(params = {}) ⇒ Types::GetNextMessageResponse

Retrieves next message on an Amazon Q in Connect session.

Examples:

Request syntax with placeholder values


resp = client.get_next_message({
  assistant_id: "UuidOrArn", # required
  session_id: "UuidOrArn", # required
  next_message_token: "NextToken", # required
})

Response structure


resp.type #=> String, one of "TEXT"
resp.response.value.text.value #=> String
resp.response.message_id #=> String
resp.response.participant #=> String, one of "CUSTOMER", "AGENT", "BOT"
resp.response.timestamp #=> Time
resp.request_message_id #=> String
resp.conversation_state.status #=> String, one of "CLOSED", "READY", "PROCESSING"
resp.conversation_state.reason #=> String, one of "SUCCESS", "FAILED", "REJECTED"
resp.next_message_token #=> String
resp.conversation_session_data #=> Array
resp.conversation_session_data[0].key #=> String
resp.conversation_session_data[0].value.string_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant.

  • :session_id (required, String) —

    The identifier of the Amazon Q in Connect session.

  • :next_message_token (required, String) —

    The token for the next message. Use the value returned in the SendMessage or previous response in the next request to retrieve the next message.

Returns:

See Also:



3957
3958
3959
3960
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 3957

def get_next_message(params = {}, options = {})
  req = build_request(:get_next_message, params)
  req.send_request(options)
end

#get_quick_response(params = {}) ⇒ Types::GetQuickResponseResponse

Retrieves the quick response.

Examples:

Request syntax with placeholder values


resp = client.get_quick_response({
  quick_response_id: "UuidOrArn", # required
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.quick_response.quick_response_arn #=> String
resp.quick_response.quick_response_id #=> String
resp.quick_response.knowledge_base_arn #=> String
resp.quick_response.knowledge_base_id #=> String
resp.quick_response.name #=> String
resp.quick_response.content_type #=> String
resp.quick_response.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.quick_response.created_time #=> Time
resp.quick_response.last_modified_time #=> Time
resp.quick_response.contents.plain_text.content #=> String
resp.quick_response.contents.markdown.content #=> String
resp.quick_response.description #=> String
resp.quick_response.grouping_configuration.criteria #=> String
resp.quick_response.grouping_configuration.values #=> Array
resp.quick_response.grouping_configuration.values[0] #=> String
resp.quick_response.shortcut_key #=> String
resp.quick_response.last_modified_by #=> String
resp.quick_response.is_active #=> Boolean
resp.quick_response.channels #=> Array
resp.quick_response.channels[0] #=> String
resp.quick_response.language #=> String
resp.quick_response.tags #=> Hash
resp.quick_response.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :quick_response_id (required, String) —

    The identifier of the quick response.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.

Returns:

See Also:



4012
4013
4014
4015
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4012

def get_quick_response(params = {}, options = {})
  req = build_request(:get_quick_response, params)
  req.send_request(options)
end

#get_recommendations(params = {}) ⇒ Types::GetRecommendationsResponse

This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

Examples:

Request syntax with placeholder values


resp = client.get_recommendations({
  assistant_id: "UuidOrArn", # required
  session_id: "UuidOrArn", # required
  max_results: 1,
  wait_time_seconds: 1,
  next_chunk_token: "NextToken",
})

Response structure


resp.recommendations #=> Array
resp.recommendations[0].recommendation_id #=> String
resp.recommendations[0].document.content_reference.knowledge_base_arn #=> String
resp.recommendations[0].document.content_reference.knowledge_base_id #=> String
resp.recommendations[0].document.content_reference.content_arn #=> String
resp.recommendations[0].document.content_reference.content_id #=> String
resp.recommendations[0].document.content_reference.source_url #=> String
resp.recommendations[0].document.content_reference.reference_type #=> String, one of "WEB_CRAWLER", "KNOWLEDGE_BASE"
resp.recommendations[0].document.title.text #=> String
resp.recommendations[0].document.title.highlights #=> Array
resp.recommendations[0].document.title.highlights[0].begin_offset_inclusive #=> Integer
resp.recommendations[0].document.title.highlights[0].end_offset_exclusive #=> Integer
resp.recommendations[0].document.excerpt.text #=> String
resp.recommendations[0].document.excerpt.highlights #=> Array
resp.recommendations[0].document.excerpt.highlights[0].begin_offset_inclusive #=> Integer
resp.recommendations[0].document.excerpt.highlights[0].end_offset_exclusive #=> Integer
resp.recommendations[0].relevance_score #=> Float
resp.recommendations[0].relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.recommendations[0].type #=> String, one of "KNOWLEDGE_CONTENT", "GENERATIVE_RESPONSE", "GENERATIVE_ANSWER", "DETECTED_INTENT", "GENERATIVE_ANSWER_CHUNK", "BLOCKED_GENERATIVE_ANSWER_CHUNK", "INTENT_ANSWER_CHUNK", "BLOCKED_INTENT_ANSWER_CHUNK"
resp.recommendations[0].data.reference.content_reference.knowledge_base_arn #=> String
resp.recommendations[0].data.reference.content_reference.knowledge_base_id #=> String
resp.recommendations[0].data.reference.content_reference.content_arn #=> String
resp.recommendations[0].data.reference.content_reference.content_id #=> String
resp.recommendations[0].data.reference.content_reference.source_url #=> String
resp.recommendations[0].data.reference.content_reference.reference_type #=> String, one of "WEB_CRAWLER", "KNOWLEDGE_BASE"
resp.recommendations[0].data.reference.generative_reference.model_id #=> String
resp.recommendations[0].data.reference.generative_reference.generation_id #=> String
resp.recommendations[0].data.details.content_data.text_data.title.text #=> String
resp.recommendations[0].data.details.content_data.text_data.title.highlights #=> Array
resp.recommendations[0].data.details.content_data.text_data.title.highlights[0].begin_offset_inclusive #=> Integer
resp.recommendations[0].data.details.content_data.text_data.title.highlights[0].end_offset_exclusive #=> Integer
resp.recommendations[0].data.details.content_data.text_data.excerpt.text #=> String
resp.recommendations[0].data.details.content_data.text_data.excerpt.highlights #=> Array
resp.recommendations[0].data.details.content_data.text_data.excerpt.highlights[0].begin_offset_inclusive #=> Integer
resp.recommendations[0].data.details.content_data.text_data.excerpt.highlights[0].end_offset_exclusive #=> Integer
resp.recommendations[0].data.details.content_data.ranking_data.relevance_score #=> Float
resp.recommendations[0].data.details.content_data.ranking_data.relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.recommendations[0].data.details.generative_data.completion #=> String
resp.recommendations[0].data.details.generative_data.references #=> Array
resp.recommendations[0].data.details.generative_data.references[0] #=> Types::DataSummary
resp.recommendations[0].data.details.generative_data.ranking_data.relevance_score #=> Float
resp.recommendations[0].data.details.generative_data.ranking_data.relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.recommendations[0].data.details.intent_detected_data.intent #=> String
resp.recommendations[0].data.details.intent_detected_data.intent_id #=> String
resp.recommendations[0].data.details.source_content_data.id #=> String
resp.recommendations[0].data.details.source_content_data.type #=> String, one of "KNOWLEDGE_CONTENT"
resp.recommendations[0].data.details.source_content_data.text_data.title.text #=> String
resp.recommendations[0].data.details.source_content_data.text_data.title.highlights #=> Array
resp.recommendations[0].data.details.source_content_data.text_data.title.highlights[0].begin_offset_inclusive #=> Integer
resp.recommendations[0].data.details.source_content_data.text_data.title.highlights[0].end_offset_exclusive #=> Integer
resp.recommendations[0].data.details.source_content_data.text_data.excerpt.text #=> String
resp.recommendations[0].data.details.source_content_data.text_data.excerpt.highlights #=> Array
resp.recommendations[0].data.details.source_content_data.text_data.excerpt.highlights[0].begin_offset_inclusive #=> Integer
resp.recommendations[0].data.details.source_content_data.text_data.excerpt.highlights[0].end_offset_exclusive #=> Integer
resp.recommendations[0].data.details.source_content_data.ranking_data.relevance_score #=> Float
resp.recommendations[0].data.details.source_content_data.ranking_data.relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.recommendations[0].data.details.source_content_data.citation_span.begin_offset_inclusive #=> Integer
resp.recommendations[0].data.details.source_content_data.citation_span.end_offset_exclusive #=> Integer
resp.recommendations[0].data.details.generative_chunk_data.completion #=> String
resp.recommendations[0].data.details.generative_chunk_data.references #=> Array
resp.recommendations[0].data.details.generative_chunk_data.references[0] #=> Types::DataSummary
resp.recommendations[0].data.details.generative_chunk_data.next_chunk_token #=> String
resp.triggers #=> Array
resp.triggers[0].id #=> String
resp.triggers[0].type #=> String, one of "QUERY", "GENERATIVE"
resp.triggers[0].source #=> String, one of "ISSUE_DETECTION", "RULE_EVALUATION", "OTHER"
resp.triggers[0].data.query.text #=> String
resp.triggers[0].recommendation_ids #=> Array
resp.triggers[0].recommendation_ids[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :session_id (required, String) —

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :wait_time_seconds (Integer) —

    The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.

  • :next_chunk_token (String) —

    The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.

Returns:

See Also:



4150
4151
4152
4153
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4150

def get_recommendations(params = {}, options = {})
  req = build_request(:get_recommendations, params)
  req.send_request(options)
end

#get_session(params = {}) ⇒ Types::GetSessionResponse

Retrieves information for a specified session.

Examples:

Request syntax with placeholder values


resp = client.get_session({
  assistant_id: "UuidOrArn", # required
  session_id: "UuidOrArn", # required
})

Response structure


resp.session.session_arn #=> String
resp.session.session_id #=> String
resp.session.name #=> String
resp.session.description #=> String
resp.session.tags #=> Hash
resp.session.tags["TagKey"] #=> String
resp.session.integration_configuration.topic_integration_arn #=> String
resp.session.tag_filter.tag_condition.key #=> String
resp.session.tag_filter.tag_condition.value #=> String
resp.session.tag_filter.and_conditions #=> Array
resp.session.tag_filter.and_conditions[0].key #=> String
resp.session.tag_filter.and_conditions[0].value #=> String
resp.session.tag_filter.or_conditions #=> Array
resp.session.tag_filter.or_conditions[0].and_conditions #=> Array
resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String
resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String
resp.session.ai_agent_configuration #=> Hash
resp.session.ai_agent_configuration["AIAgentType"].ai_agent_id #=> String
resp.session.origin #=> String, one of "SYSTEM", "CUSTOMER"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :session_id (required, String) —

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



4204
4205
4206
4207
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4204

def get_session(params = {}, options = {})
  req = build_request(:get_session, params)
  req.send_request(options)
end

#list_ai_agent_versions(params = {}) ⇒ Types::ListAIAgentVersionsResponse

List AI Agent versions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_ai_agent_versions({
  assistant_id: "UuidOrArn", # required
  ai_agent_id: "UuidOrArnOrEitherWithQualifier", # required
  next_token: "NextToken",
  max_results: 1,
  origin: "SYSTEM", # accepts SYSTEM, CUSTOMER
})

Response structure


resp.ai_agent_version_summaries #=> Array
resp.ai_agent_version_summaries[0].ai_agent_summary.name #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.assistant_id #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.assistant_arn #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.ai_agent_id #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION", "SELF_SERVICE"
resp.ai_agent_version_summaries[0].ai_agent_summary.ai_agent_arn #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.modified_time #=> Time
resp.ai_agent_version_summaries[0].ai_agent_summary.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.manual_search_ai_agent_configuration.locale #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.answer_recommendation_ai_agent_configuration.locale #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.self_service_pre_processing_ai_prompt_id #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.self_service_answer_generation_ai_prompt_id #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.self_service_ai_guardrail_id #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent_version_summaries[0].ai_agent_summary.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent_version_summaries[0].ai_agent_summary.origin #=> String, one of "SYSTEM", "CUSTOMER"
resp.ai_agent_version_summaries[0].ai_agent_summary.description #=> String
resp.ai_agent_version_summaries[0].ai_agent_summary.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.ai_agent_version_summaries[0].ai_agent_summary.tags #=> Hash
resp.ai_agent_version_summaries[0].ai_agent_summary.tags["TagKey"] #=> String
resp.ai_agent_version_summaries[0].version_number #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_agent_id (required, String) —

    The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :origin (String) —

    The origin of the AI Agent versions to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.

Returns:

See Also:



4331
4332
4333
4334
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4331

def list_ai_agent_versions(params = {}, options = {})
  req = build_request(:list_ai_agent_versions, params)
  req.send_request(options)
end

#list_ai_agents(params = {}) ⇒ Types::ListAIAgentsResponse

Lists AI Agents.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_ai_agents({
  assistant_id: "UuidOrArn", # required
  next_token: "NextToken",
  max_results: 1,
  origin: "SYSTEM", # accepts SYSTEM, CUSTOMER
})

Response structure


resp.ai_agent_summaries #=> Array
resp.ai_agent_summaries[0].name #=> String
resp.ai_agent_summaries[0].assistant_id #=> String
resp.ai_agent_summaries[0].assistant_arn #=> String
resp.ai_agent_summaries[0].ai_agent_id #=> String
resp.ai_agent_summaries[0].type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION", "SELF_SERVICE"
resp.ai_agent_summaries[0].ai_agent_arn #=> String
resp.ai_agent_summaries[0].modified_time #=> Time
resp.ai_agent_summaries[0].visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent_summaries[0].configuration.manual_search_ai_agent_configuration.locale #=> String
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent_summaries[0].configuration.answer_recommendation_ai_agent_configuration.locale #=> String
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.self_service_pre_processing_ai_prompt_id #=> String
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.self_service_answer_generation_ai_prompt_id #=> String
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.self_service_ai_guardrail_id #=> String
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent_summaries[0].configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent_summaries[0].origin #=> String, one of "SYSTEM", "CUSTOMER"
resp.ai_agent_summaries[0].description #=> String
resp.ai_agent_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.ai_agent_summaries[0].tags #=> Hash
resp.ai_agent_summaries[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :origin (String) —

    The origin of the AI Agents to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.

Returns:

See Also:



4452
4453
4454
4455
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4452

def list_ai_agents(params = {}, options = {})
  req = build_request(:list_ai_agents, params)
  req.send_request(options)
end

#list_ai_guardrail_versions(params = {}) ⇒ Types::ListAIGuardrailVersionsResponse

Lists AI Guardrail versions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_ai_guardrail_versions({
  assistant_id: "UuidOrArn", # required
  ai_guardrail_id: "UuidOrArnOrEitherWithQualifier", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.ai_guardrail_version_summaries #=> Array
resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.name #=> String
resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.assistant_id #=> String
resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.assistant_arn #=> String
resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.ai_guardrail_id #=> String
resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.ai_guardrail_arn #=> String
resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.modified_time #=> Time
resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.description #=> String
resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.tags #=> Hash
resp.ai_guardrail_version_summaries[0].ai_guardrail_summary.tags["TagKey"] #=> String
resp.ai_guardrail_version_summaries[0].version_number #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_guardrail_id (required, String) —

    The identifier of the Amazon Q in Connect AI Guardrail for which versions are to be listed.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



4512
4513
4514
4515
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4512

def list_ai_guardrail_versions(params = {}, options = {})
  req = build_request(:list_ai_guardrail_versions, params)
  req.send_request(options)
end

#list_ai_guardrails(params = {}) ⇒ Types::ListAIGuardrailsResponse

Lists the AI Guardrails available on the Amazon Q in Connect assistant.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_ai_guardrails({
  assistant_id: "UuidOrArn", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.ai_guardrail_summaries #=> Array
resp.ai_guardrail_summaries[0].name #=> String
resp.ai_guardrail_summaries[0].assistant_id #=> String
resp.ai_guardrail_summaries[0].assistant_arn #=> String
resp.ai_guardrail_summaries[0].ai_guardrail_id #=> String
resp.ai_guardrail_summaries[0].ai_guardrail_arn #=> String
resp.ai_guardrail_summaries[0].modified_time #=> Time
resp.ai_guardrail_summaries[0].visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_guardrail_summaries[0].description #=> String
resp.ai_guardrail_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.ai_guardrail_summaries[0].tags #=> Hash
resp.ai_guardrail_summaries[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



4567
4568
4569
4570
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4567

def list_ai_guardrails(params = {}, options = {})
  req = build_request(:list_ai_guardrails, params)
  req.send_request(options)
end

#list_ai_prompt_versions(params = {}) ⇒ Types::ListAIPromptVersionsResponse

Lists AI Prompt versions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_ai_prompt_versions({
  assistant_id: "UuidOrArn", # required
  ai_prompt_id: "UuidOrArnOrEitherWithQualifier", # required
  next_token: "NextToken",
  max_results: 1,
  origin: "SYSTEM", # accepts SYSTEM, CUSTOMER
})

Response structure


resp.ai_prompt_version_summaries #=> Array
resp.ai_prompt_version_summaries[0].ai_prompt_summary.name #=> String
resp.ai_prompt_version_summaries[0].ai_prompt_summary.assistant_id #=> String
resp.ai_prompt_version_summaries[0].ai_prompt_summary.assistant_arn #=> String
resp.ai_prompt_version_summaries[0].ai_prompt_summary.ai_prompt_id #=> String
resp.ai_prompt_version_summaries[0].ai_prompt_summary.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION", "SELF_SERVICE_PRE_PROCESSING", "SELF_SERVICE_ANSWER_GENERATION"
resp.ai_prompt_version_summaries[0].ai_prompt_summary.ai_prompt_arn #=> String
resp.ai_prompt_version_summaries[0].ai_prompt_summary.modified_time #=> Time
resp.ai_prompt_version_summaries[0].ai_prompt_summary.template_type #=> String, one of "TEXT"
resp.ai_prompt_version_summaries[0].ai_prompt_summary.model_id #=> String
resp.ai_prompt_version_summaries[0].ai_prompt_summary.api_format #=> String, one of "ANTHROPIC_CLAUDE_MESSAGES", "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS", "MESSAGES", "TEXT_COMPLETIONS"
resp.ai_prompt_version_summaries[0].ai_prompt_summary.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_prompt_version_summaries[0].ai_prompt_summary.origin #=> String, one of "SYSTEM", "CUSTOMER"
resp.ai_prompt_version_summaries[0].ai_prompt_summary.description #=> String
resp.ai_prompt_version_summaries[0].ai_prompt_summary.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.ai_prompt_version_summaries[0].ai_prompt_summary.tags #=> Hash
resp.ai_prompt_version_summaries[0].ai_prompt_summary.tags["TagKey"] #=> String
resp.ai_prompt_version_summaries[0].version_number #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_prompt_id (required, String) —

    The identifier of the Amazon Q in Connect AI prompt for which versions are to be listed.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :origin (String) —

    The origin of the AI Prompt versions to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.

Returns:

See Also:



4638
4639
4640
4641
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4638

def list_ai_prompt_versions(params = {}, options = {})
  req = build_request(:list_ai_prompt_versions, params)
  req.send_request(options)
end

#list_ai_prompts(params = {}) ⇒ Types::ListAIPromptsResponse

Lists the AI Prompts available on the Amazon Q in Connect assistant.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_ai_prompts({
  assistant_id: "UuidOrArn", # required
  next_token: "NextToken",
  max_results: 1,
  origin: "SYSTEM", # accepts SYSTEM, CUSTOMER
})

Response structure


resp.ai_prompt_summaries #=> Array
resp.ai_prompt_summaries[0].name #=> String
resp.ai_prompt_summaries[0].assistant_id #=> String
resp.ai_prompt_summaries[0].assistant_arn #=> String
resp.ai_prompt_summaries[0].ai_prompt_id #=> String
resp.ai_prompt_summaries[0].type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION", "SELF_SERVICE_PRE_PROCESSING", "SELF_SERVICE_ANSWER_GENERATION"
resp.ai_prompt_summaries[0].ai_prompt_arn #=> String
resp.ai_prompt_summaries[0].modified_time #=> Time
resp.ai_prompt_summaries[0].template_type #=> String, one of "TEXT"
resp.ai_prompt_summaries[0].model_id #=> String
resp.ai_prompt_summaries[0].api_format #=> String, one of "ANTHROPIC_CLAUDE_MESSAGES", "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS", "MESSAGES", "TEXT_COMPLETIONS"
resp.ai_prompt_summaries[0].visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_prompt_summaries[0].origin #=> String, one of "SYSTEM", "CUSTOMER"
resp.ai_prompt_summaries[0].description #=> String
resp.ai_prompt_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.ai_prompt_summaries[0].tags #=> Hash
resp.ai_prompt_summaries[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :origin (String) —

    The origin of the AI Prompts to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.

Returns:

See Also:



4703
4704
4705
4706
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4703

def list_ai_prompts(params = {}, options = {})
  req = build_request(:list_ai_prompts, params)
  req.send_request(options)
end

#list_assistant_associations(params = {}) ⇒ Types::ListAssistantAssociationsResponse

Lists information about assistant associations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_assistant_associations({
  next_token: "NextToken",
  max_results: 1,
  assistant_id: "UuidOrArn", # required
})

Response structure


resp.assistant_association_summaries #=> Array
resp.assistant_association_summaries[0].assistant_association_id #=> String
resp.assistant_association_summaries[0].assistant_association_arn #=> String
resp.assistant_association_summaries[0].assistant_id #=> String
resp.assistant_association_summaries[0].assistant_arn #=> String
resp.assistant_association_summaries[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.assistant_association_summaries[0].association_data.knowledge_base_association.knowledge_base_id #=> String
resp.assistant_association_summaries[0].association_data.knowledge_base_association.knowledge_base_arn #=> String
resp.assistant_association_summaries[0].tags #=> Hash
resp.assistant_association_summaries[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :assistant_id (required, String) —

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

Returns:

See Also:



4755
4756
4757
4758
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4755

def list_assistant_associations(params = {}, options = {})
  req = build_request(:list_assistant_associations, params)
  req.send_request(options)
end

#list_assistants(params = {}) ⇒ Types::ListAssistantsResponse

Lists information about assistants.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_assistants({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.assistant_summaries #=> Array
resp.assistant_summaries[0].assistant_id #=> String
resp.assistant_summaries[0].assistant_arn #=> String
resp.assistant_summaries[0].name #=> String
resp.assistant_summaries[0].type #=> String, one of "AGENT"
resp.assistant_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.assistant_summaries[0].description #=> String
resp.assistant_summaries[0].tags #=> Hash
resp.assistant_summaries[0].tags["TagKey"] #=> String
resp.assistant_summaries[0].server_side_encryption_configuration.kms_key_id #=> String
resp.assistant_summaries[0].integration_configuration.topic_integration_arn #=> String
resp.assistant_summaries[0].capability_configuration.type #=> String, one of "V1", "V2"
resp.assistant_summaries[0].ai_agent_configuration #=> Hash
resp.assistant_summaries[0].ai_agent_configuration["AIAgentType"].ai_agent_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



4806
4807
4808
4809
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4806

def list_assistants(params = {}, options = {})
  req = build_request(:list_assistants, params)
  req.send_request(options)
end

#list_content_associations(params = {}) ⇒ Types::ListContentAssociationsResponse

Lists the content associations.

For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_content_associations({
  next_token: "NextToken",
  max_results: 1,
  knowledge_base_id: "UuidOrArn", # required
  content_id: "UuidOrArn", # required
})

Response structure


resp.content_association_summaries #=> Array
resp.content_association_summaries[0].knowledge_base_id #=> String
resp.content_association_summaries[0].knowledge_base_arn #=> String
resp.content_association_summaries[0].content_id #=> String
resp.content_association_summaries[0].content_arn #=> String
resp.content_association_summaries[0].content_association_id #=> String
resp.content_association_summaries[0].content_association_arn #=> String
resp.content_association_summaries[0].association_type #=> String, one of "AMAZON_CONNECT_GUIDE"
resp.content_association_summaries[0].association_data.amazon_connect_guide_association.flow_id #=> String
resp.content_association_summaries[0].tags #=> Hash
resp.content_association_summaries[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base.

  • :content_id (required, String) —

    The identifier of the content.

Returns:

See Also:



4870
4871
4872
4873
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4870

def list_content_associations(params = {}, options = {})
  req = build_request(:list_content_associations, params)
  req.send_request(options)
end

#list_contents(params = {}) ⇒ Types::ListContentsResponse

Lists the content.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_contents({
  next_token: "NextToken",
  max_results: 1,
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.content_summaries #=> Array
resp.content_summaries[0].content_arn #=> String
resp.content_summaries[0].content_id #=> String
resp.content_summaries[0].knowledge_base_arn #=> String
resp.content_summaries[0].knowledge_base_id #=> String
resp.content_summaries[0].name #=> String
resp.content_summaries[0].revision_id #=> String
resp.content_summaries[0].title #=> String
resp.content_summaries[0].content_type #=> String
resp.content_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
resp.content_summaries[0].metadata #=> Hash
resp.content_summaries[0].metadata["NonEmptyString"] #=> String
resp.content_summaries[0].tags #=> Hash
resp.content_summaries[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



4927
4928
4929
4930
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4927

def list_contents(params = {}, options = {})
  req = build_request(:list_contents, params)
  req.send_request(options)
end

#list_import_jobs(params = {}) ⇒ Types::ListImportJobsResponse

Lists information about import jobs.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_import_jobs({
  next_token: "NonEmptyString",
  max_results: 1,
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.import_job_summaries #=> Array
resp.import_job_summaries[0].import_job_id #=> String
resp.import_job_summaries[0].knowledge_base_id #=> String
resp.import_job_summaries[0].upload_id #=> String
resp.import_job_summaries[0].knowledge_base_arn #=> String
resp.import_job_summaries[0].import_job_type #=> String, one of "QUICK_RESPONSES"
resp.import_job_summaries[0].status #=> String, one of "START_IN_PROGRESS", "FAILED", "COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.import_job_summaries[0].created_time #=> Time
resp.import_job_summaries[0].last_modified_time #=> Time
resp.import_job_summaries[0].metadata #=> Hash
resp.import_job_summaries[0].metadata["NonEmptyString"] #=> String
resp.import_job_summaries[0].external_source_configuration.source #=> String, one of "AMAZON_CONNECT"
resp.import_job_summaries[0].external_source_configuration.configuration.connect_configuration.instance_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



4982
4983
4984
4985
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 4982

def list_import_jobs(params = {}, options = {})
  req = build_request(:list_import_jobs, params)
  req.send_request(options)
end

#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse

Lists the knowledge bases.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_knowledge_bases({
  next_token: "NonEmptyString",
  max_results: 1,
})

Response structure


resp.knowledge_base_summaries #=> Array
resp.knowledge_base_summaries[0].knowledge_base_id #=> String
resp.knowledge_base_summaries[0].knowledge_base_arn #=> String
resp.knowledge_base_summaries[0].name #=> String
resp.knowledge_base_summaries[0].knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES", "MESSAGE_TEMPLATES", "MANAGED"
resp.knowledge_base_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.knowledge_base_summaries[0].source_configuration.app_integrations.app_integration_arn #=> String
resp.knowledge_base_summaries[0].source_configuration.app_integrations.object_fields #=> Array
resp.knowledge_base_summaries[0].source_configuration.app_integrations.object_fields[0] #=> String
resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls #=> Array
resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls[0].url #=> String
resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.crawler_limits.rate_limit #=> Integer
resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters #=> Array
resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters[0] #=> String
resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters #=> Array
resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters[0] #=> String
resp.knowledge_base_summaries[0].source_configuration.managed_source_configuration.web_crawler_configuration.scope #=> String, one of "HOST_ONLY", "SUBDOMAINS"
resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.chunking_strategy #=> String, one of "FIXED_SIZE", "NONE", "HIERARCHICAL", "SEMANTIC"
resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.max_tokens #=> Integer
resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.overlap_percentage #=> Integer
resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations #=> Array
resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations[0].max_tokens #=> Integer
resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.overlap_tokens #=> Integer
resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.max_tokens #=> Integer
resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.buffer_size #=> Integer
resp.knowledge_base_summaries[0].vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.breakpoint_percentile_threshold #=> Integer
resp.knowledge_base_summaries[0].vector_ingestion_configuration.parsing_configuration.parsing_strategy #=> String, one of "BEDROCK_FOUNDATION_MODEL"
resp.knowledge_base_summaries[0].vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.model_arn #=> String
resp.knowledge_base_summaries[0].vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.parsing_prompt.parsing_prompt_text #=> String
resp.knowledge_base_summaries[0].rendering_configuration.template_uri #=> String
resp.knowledge_base_summaries[0].server_side_encryption_configuration.kms_key_id #=> String
resp.knowledge_base_summaries[0].description #=> String
resp.knowledge_base_summaries[0].tags #=> Hash
resp.knowledge_base_summaries[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



5053
5054
5055
5056
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 5053

def list_knowledge_bases(params = {}, options = {})
  req = build_request(:list_knowledge_bases, params)
  req.send_request(options)
end

#list_message_template_versions(params = {}) ⇒ Types::ListMessageTemplateVersionsResponse

Lists all the available versions for the specified Amazon Q in Connect message template.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_message_template_versions({
  knowledge_base_id: "UuidOrArn", # required
  message_template_id: "UuidOrArnOrEitherWithQualifier", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.message_template_version_summaries #=> Array
resp.message_template_version_summaries[0].message_template_arn #=> String
resp.message_template_version_summaries[0].message_template_id #=> String
resp.message_template_version_summaries[0].knowledge_base_arn #=> String
resp.message_template_version_summaries[0].knowledge_base_id #=> String
resp.message_template_version_summaries[0].name #=> String
resp.message_template_version_summaries[0].channel_subtype #=> String, one of "EMAIL", "SMS"
resp.message_template_version_summaries[0].is_active #=> Boolean
resp.message_template_version_summaries[0].version_number #=> Integer
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :message_template_id (required, String) —

    The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



5110
5111
5112
5113
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 5110

def list_message_template_versions(params = {}, options = {})
  req = build_request(:list_message_template_versions, params)
  req.send_request(options)
end

#list_message_templates(params = {}) ⇒ Types::ListMessageTemplatesResponse

Lists all the available Amazon Q in Connect message templates for the specified knowledge base.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_message_templates({
  next_token: "NextToken",
  max_results: 1,
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.message_template_summaries #=> Array
resp.message_template_summaries[0].message_template_arn #=> String
resp.message_template_summaries[0].message_template_id #=> String
resp.message_template_summaries[0].knowledge_base_arn #=> String
resp.message_template_summaries[0].knowledge_base_id #=> String
resp.message_template_summaries[0].name #=> String
resp.message_template_summaries[0].channel_subtype #=> String, one of "EMAIL", "SMS"
resp.message_template_summaries[0].created_time #=> Time
resp.message_template_summaries[0].last_modified_time #=> Time
resp.message_template_summaries[0].last_modified_by #=> String
resp.message_template_summaries[0].active_version_number #=> Integer
resp.message_template_summaries[0].description #=> String
resp.message_template_summaries[0].tags #=> Hash
resp.message_template_summaries[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



5167
5168
5169
5170
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 5167

def list_message_templates(params = {}, options = {})
  req = build_request(:list_message_templates, params)
  req.send_request(options)
end

#list_messages(params = {}) ⇒ Types::ListMessagesResponse

Lists messages on an Amazon Q in Connect session.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_messages({
  assistant_id: "UuidOrArn", # required
  session_id: "UuidOrArn", # required
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.messages #=> Array
resp.messages[0].value.text.value #=> String
resp.messages[0].message_id #=> String
resp.messages[0].participant #=> String, one of "CUSTOMER", "AGENT", "BOT"
resp.messages[0].timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant.

  • :session_id (required, String) —

    The identifier of the Amazon Q in Connect session.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



5217
5218
5219
5220
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 5217

def list_messages(params = {}, options = {})
  req = build_request(:list_messages, params)
  req.send_request(options)
end

#list_quick_responses(params = {}) ⇒ Types::ListQuickResponsesResponse

Lists information about quick response.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_quick_responses({
  next_token: "NonEmptyString",
  max_results: 1,
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.quick_response_summaries #=> Array
resp.quick_response_summaries[0].quick_response_arn #=> String
resp.quick_response_summaries[0].quick_response_id #=> String
resp.quick_response_summaries[0].knowledge_base_arn #=> String
resp.quick_response_summaries[0].knowledge_base_id #=> String
resp.quick_response_summaries[0].name #=> String
resp.quick_response_summaries[0].content_type #=> String
resp.quick_response_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.quick_response_summaries[0].created_time #=> Time
resp.quick_response_summaries[0].last_modified_time #=> Time
resp.quick_response_summaries[0].description #=> String
resp.quick_response_summaries[0].last_modified_by #=> String
resp.quick_response_summaries[0].is_active #=> Boolean
resp.quick_response_summaries[0].channels #=> Array
resp.quick_response_summaries[0].channels[0] #=> String
resp.quick_response_summaries[0].tags #=> Hash
resp.quick_response_summaries[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



5276
5277
5278
5279
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 5276

def list_quick_responses(params = {}, options = {})
  req = build_request(:list_quick_responses, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags for the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



5305
5306
5307
5308
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 5305

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#notify_recommendations_received(params = {}) ⇒ Types::NotifyRecommendationsReceivedResponse

Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.

Examples:

Request syntax with placeholder values


resp = client.notify_recommendations_received({
  assistant_id: "UuidOrArn", # required
  session_id: "UuidOrArn", # required
  recommendation_ids: ["RecommendationId"], # required
})

Response structure


resp.recommendation_ids #=> Array
resp.recommendation_ids[0] #=> String
resp.errors #=> Array
resp.errors[0].recommendation_id #=> String
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :session_id (required, String) —

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :recommendation_ids (required, Array<String>) —

    The identifiers of the recommendations.

Returns:

See Also:



5355
5356
5357
5358
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 5355

def notify_recommendations_received(params = {}, options = {})
  req = build_request(:notify_recommendations_received, params)
  req.send_request(options)
end

#put_feedback(params = {}) ⇒ Types::PutFeedbackResponse

Provides feedback against the specified assistant for the specified target. This API only supports generative targets.

Examples:

Request syntax with placeholder values


resp = client.put_feedback({
  assistant_id: "UuidOrArn", # required
  target_id: "Uuid", # required
  target_type: "RECOMMENDATION", # required, accepts RECOMMENDATION, RESULT
  content_feedback: { # required
    generative_content_feedback_data: {
      relevance: "HELPFUL", # required, accepts HELPFUL, NOT_HELPFUL
    },
  },
})

Response structure


resp.assistant_id #=> String
resp.assistant_arn #=> String
resp.target_id #=> String
resp.target_type #=> String, one of "RECOMMENDATION", "RESULT"
resp.content_feedback.generative_content_feedback_data.relevance #=> String, one of "HELPFUL", "NOT_HELPFUL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant.

  • :target_id (required, String) —

    The identifier of the feedback target.

  • :target_type (required, String) —

    The type of the feedback target.

  • :content_feedback (required, Types::ContentFeedbackData) —

    Information about the feedback provided.

Returns:

See Also:



5408
5409
5410
5411
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 5408

def put_feedback(params = {}, options = {})
  req = build_request(:put_feedback, params)
  req.send_request(options)
end

#query_assistant(params = {}) ⇒ Types::QueryAssistantResponse

This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.query_assistant({
  assistant_id: "UuidOrArn", # required
  query_text: "QueryText",
  next_token: "NextToken",
  max_results: 1,
  session_id: "UuidOrArn",
  query_condition: [
    {
      single: {
        field: "RESULT_TYPE", # required, accepts RESULT_TYPE
        comparator: "EQUALS", # required, accepts EQUALS
        value: "NonEmptyString", # required
      },
    },
  ],
  query_input_data: {
    query_text_input_data: {
      text: "QueryText", # required
    },
    intent_input_data: {
      intent_id: "Uuid", # required
    },
  },
  override_knowledge_base_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
})

Response structure


resp.results #=> Array
resp.results[0].result_id #=> String
resp.results[0].document.content_reference.knowledge_base_arn #=> String
resp.results[0].document.content_reference.knowledge_base_id #=> String
resp.results[0].document.content_reference.content_arn #=> String
resp.results[0].document.content_reference.content_id #=> String
resp.results[0].document.content_reference.source_url #=> String
resp.results[0].document.content_reference.reference_type #=> String, one of "WEB_CRAWLER", "KNOWLEDGE_BASE"
resp.results[0].document.title.text #=> String
resp.results[0].document.title.highlights #=> Array
resp.results[0].document.title.highlights[0].begin_offset_inclusive #=> Integer
resp.results[0].document.title.highlights[0].end_offset_exclusive #=> Integer
resp.results[0].document.excerpt.text #=> String
resp.results[0].document.excerpt.highlights #=> Array
resp.results[0].document.excerpt.highlights[0].begin_offset_inclusive #=> Integer
resp.results[0].document.excerpt.highlights[0].end_offset_exclusive #=> Integer
resp.results[0].relevance_score #=> Float
resp.results[0].data.reference.content_reference.knowledge_base_arn #=> String
resp.results[0].data.reference.content_reference.knowledge_base_id #=> String
resp.results[0].data.reference.content_reference.content_arn #=> String
resp.results[0].data.reference.content_reference.content_id #=> String
resp.results[0].data.reference.content_reference.source_url #=> String
resp.results[0].data.reference.content_reference.reference_type #=> String, one of "WEB_CRAWLER", "KNOWLEDGE_BASE"
resp.results[0].data.reference.generative_reference.model_id #=> String
resp.results[0].data.reference.generative_reference.generation_id #=> String
resp.results[0].data.details.content_data.text_data.title.text #=> String
resp.results[0].data.details.content_data.text_data.title.highlights #=> Array
resp.results[0].data.details.content_data.text_data.title.highlights[0].begin_offset_inclusive #=> Integer
resp.results[0].data.details.content_data.text_data.title.highlights[0].end_offset_exclusive #=> Integer
resp.results[0].data.details.content_data.text_data.excerpt.text #=> String
resp.results[0].data.details.content_data.text_data.excerpt.highlights #=> Array
resp.results[0].data.details.content_data.text_data.excerpt.highlights[0].begin_offset_inclusive #=> Integer
resp.results[0].data.details.content_data.text_data.excerpt.highlights[0].end_offset_exclusive #=> Integer
resp.results[0].data.details.content_data.ranking_data.relevance_score #=> Float
resp.results[0].data.details.content_data.ranking_data.relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.results[0].data.details.generative_data.completion #=> String
resp.results[0].data.details.generative_data.references #=> Array
resp.results[0].data.details.generative_data.references[0] #=> Types::DataSummary
resp.results[0].data.details.generative_data.ranking_data.relevance_score #=> Float
resp.results[0].data.details.generative_data.ranking_data.relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.results[0].data.details.intent_detected_data.intent #=> String
resp.results[0].data.details.intent_detected_data.intent_id #=> String
resp.results[0].data.details.source_content_data.id #=> String
resp.results[0].data.details.source_content_data.type #=> String, one of "KNOWLEDGE_CONTENT"
resp.results[0].data.details.source_content_data.text_data.title.text #=> String
resp.results[0].data.details.source_content_data.text_data.title.highlights #=> Array
resp.results[0].data.details.source_content_data.text_data.title.highlights[0].begin_offset_inclusive #=> Integer
resp.results[0].data.details.source_content_data.text_data.title.highlights[0].end_offset_exclusive #=> Integer
resp.results[0].data.details.source_content_data.text_data.excerpt.text #=> String
resp.results[0].data.details.source_content_data.text_data.excerpt.highlights #=> Array
resp.results[0].data.details.source_content_data.text_data.excerpt.highlights[0].begin_offset_inclusive #=> Integer
resp.results[0].data.details.source_content_data.text_data.excerpt.highlights[0].end_offset_exclusive #=> Integer
resp.results[0].data.details.source_content_data.ranking_data.relevance_score #=> Float
resp.results[0].data.details.source_content_data.ranking_data.relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.results[0].data.details.source_content_data.citation_span.begin_offset_inclusive #=> Integer
resp.results[0].data.details.source_content_data.citation_span.end_offset_exclusive #=> Integer
resp.results[0].data.details.generative_chunk_data.completion #=> String
resp.results[0].data.details.generative_chunk_data.references #=> Array
resp.results[0].data.details.generative_chunk_data.references[0] #=> Types::DataSummary
resp.results[0].data.details.generative_chunk_data.next_chunk_token #=> String
resp.results[0].type #=> String, one of "KNOWLEDGE_CONTENT", "INTENT_ANSWER", "GENERATIVE_ANSWER", "GENERATIVE_ANSWER_CHUNK", "BLOCKED_GENERATIVE_ANSWER_CHUNK", "INTENT_ANSWER_CHUNK", "BLOCKED_INTENT_ANSWER_CHUNK"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :query_text (String) —

    The text to search for.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :session_id (String) —

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

  • :query_condition (Array<Types::QueryCondition>) —

    Information about how to query content.

  • :query_input_data (Types::QueryInputData) —

    Information about the query.

  • :override_knowledge_base_search_type (String) —

    The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text.

Returns:

See Also:



5560
5561
5562
5563
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 5560

def query_assistant(params = {}, options = {})
  req = build_request(:query_assistant, params)
  req.send_request(options)
end

#remove_assistant_ai_agent(params = {}) ⇒ Struct

Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.

Examples:

Request syntax with placeholder values


resp = client.remove_assistant_ai_agent({
  assistant_id: "UuidOrArn", # required
  ai_agent_type: "MANUAL_SEARCH", # required, accepts MANUAL_SEARCH, ANSWER_RECOMMENDATION, SELF_SERVICE
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_agent_type (required, String) —

    The type of the AI Agent being removed for use by default from the Amazon Q in Connect Assistant.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5589
5590
5591
5592
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 5589

def remove_assistant_ai_agent(params = {}, options = {})
  req = build_request(:remove_assistant_ai_agent, params)
  req.send_request(options)
end

#remove_knowledge_base_template_uri(params = {}) ⇒ Struct

Removes a URI template from a knowledge base.

Examples:

Request syntax with placeholder values


resp = client.remove_knowledge_base_template_uri({
  knowledge_base_id: "UuidOrArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



5612
5613
5614
5615
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 5612

def remove_knowledge_base_template_uri(params = {}, options = {})
  req = build_request(:remove_knowledge_base_template_uri, params)
  req.send_request(options)
end

#render_message_template(params = {}) ⇒ Types::RenderMessageTemplateResponse

Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.

Examples:

Request syntax with placeholder values


resp = client.render_message_template({
  knowledge_base_id: "UuidOrArn", # required
  message_template_id: "UuidOrArnOrEitherWithQualifier", # required
  attributes: { # required
    system_attributes: {
      name: "MessageTemplateAttributeValue",
      customer_endpoint: {
        address: "MessageTemplateAttributeValue",
      },
      system_endpoint: {
        address: "MessageTemplateAttributeValue",
      },
    },
    agent_attributes: {
      first_name: "MessageTemplateAttributeValue",
      last_name: "MessageTemplateAttributeValue",
    },
    customer_profile_attributes: {
      profile_id: "MessageTemplateAttributeValue",
      profile_arn: "MessageTemplateAttributeValue",
      first_name: "MessageTemplateAttributeValue",
      middle_name: "MessageTemplateAttributeValue",
      last_name: "MessageTemplateAttributeValue",
      account_number: "MessageTemplateAttributeValue",
      email_address: "MessageTemplateAttributeValue",
      phone_number: "MessageTemplateAttributeValue",
      additional_information: "MessageTemplateAttributeValue",
      party_type: "MessageTemplateAttributeValue",
      business_name: "MessageTemplateAttributeValue",
      birth_date: "MessageTemplateAttributeValue",
      gender: "MessageTemplateAttributeValue",
      mobile_phone_number: "MessageTemplateAttributeValue",
      home_phone_number: "MessageTemplateAttributeValue",
      business_phone_number: "MessageTemplateAttributeValue",
      business_email_address: "MessageTemplateAttributeValue",
      address1: "MessageTemplateAttributeValue",
      address2: "MessageTemplateAttributeValue",
      address3: "MessageTemplateAttributeValue",
      address4: "MessageTemplateAttributeValue",
      city: "MessageTemplateAttributeValue",
      county: "MessageTemplateAttributeValue",
      country: "MessageTemplateAttributeValue",
      postal_code: "MessageTemplateAttributeValue",
      province: "MessageTemplateAttributeValue",
      state: "MessageTemplateAttributeValue",
      shipping_address_1: "MessageTemplateAttributeValue",
      shipping_address_2: "MessageTemplateAttributeValue",
      shipping_address_3: "MessageTemplateAttributeValue",
      shipping_address_4: "MessageTemplateAttributeValue",
      shipping_city: "MessageTemplateAttributeValue",
      shipping_county: "MessageTemplateAttributeValue",
      shipping_country: "MessageTemplateAttributeValue",
      shipping_postal_code: "MessageTemplateAttributeValue",
      shipping_province: "MessageTemplateAttributeValue",
      shipping_state: "MessageTemplateAttributeValue",
      mailing_address_1: "MessageTemplateAttributeValue",
      mailing_address_2: "MessageTemplateAttributeValue",
      mailing_address_3: "MessageTemplateAttributeValue",
      mailing_address_4: "MessageTemplateAttributeValue",
      mailing_city: "MessageTemplateAttributeValue",
      mailing_county: "MessageTemplateAttributeValue",
      mailing_country: "MessageTemplateAttributeValue",
      mailing_postal_code: "MessageTemplateAttributeValue",
      mailing_province: "MessageTemplateAttributeValue",
      mailing_state: "MessageTemplateAttributeValue",
      billing_address_1: "MessageTemplateAttributeValue",
      billing_address_2: "MessageTemplateAttributeValue",
      billing_address_3: "MessageTemplateAttributeValue",
      billing_address_4: "MessageTemplateAttributeValue",
      billing_city: "MessageTemplateAttributeValue",
      billing_county: "MessageTemplateAttributeValue",
      billing_country: "MessageTemplateAttributeValue",
      billing_postal_code: "MessageTemplateAttributeValue",
      billing_province: "MessageTemplateAttributeValue",
      billing_state: "MessageTemplateAttributeValue",
      custom: {
        "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
      },
    },
    custom_attributes: {
      "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
    },
  },
})

Response structure


resp.content.email.subject #=> String
resp.content.email.body.plain_text.content #=> String
resp.content.email.body.html.content #=> String
resp.content.email.headers #=> Array
resp.content.email.headers[0].name #=> String
resp.content.email.headers[0].value #=> String
resp.content.sms.body.plain_text.content #=> String
resp.attributes_not_interpolated #=> Array
resp.attributes_not_interpolated[0] #=> String
resp.attachments #=> Array
resp.attachments[0].content_disposition #=> String, one of "ATTACHMENT"
resp.attachments[0].name #=> String
resp.attachments[0].uploaded_time #=> Time
resp.attachments[0].url #=> String
resp.attachments[0].url_expiry #=> Time
resp.attachments[0].attachment_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :message_template_id (required, String) —

    The identifier of the message template. Can be either the ID or the ARN.

  • :attributes (required, Types::MessageTemplateAttributes) —

    An object that specifies the values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the value for that variable.

Returns:

See Also:



5756
5757
5758
5759
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 5756

def render_message_template(params = {}, options = {})
  req = build_request(:render_message_template, params)
  req.send_request(options)
end

#search_content(params = {}) ⇒ Types::SearchContentResponse

Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_content({
  next_token: "NextToken",
  max_results: 1,
  knowledge_base_id: "UuidOrArn", # required
  search_expression: { # required
    filters: [ # required
      {
        field: "NAME", # required, accepts NAME
        operator: "EQUALS", # required, accepts EQUALS
        value: "NonEmptyString", # required
      },
    ],
  },
})

Response structure


resp.content_summaries #=> Array
resp.content_summaries[0].content_arn #=> String
resp.content_summaries[0].content_id #=> String
resp.content_summaries[0].knowledge_base_arn #=> String
resp.content_summaries[0].knowledge_base_id #=> String
resp.content_summaries[0].name #=> String
resp.content_summaries[0].revision_id #=> String
resp.content_summaries[0].title #=> String
resp.content_summaries[0].content_type #=> String
resp.content_summaries[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
resp.content_summaries[0].metadata #=> Hash
resp.content_summaries[0].metadata["NonEmptyString"] #=> String
resp.content_summaries[0].tags #=> Hash
resp.content_summaries[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :search_expression (required, Types::SearchExpression) —

    The search expression to filter results.

Returns:

See Also:



5826
5827
5828
5829
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 5826

def search_content(params = {}, options = {})
  req = build_request(:search_content, params)
  req.send_request(options)
end

#search_message_templates(params = {}) ⇒ Types::SearchMessageTemplatesResponse

Searches for Amazon Q in Connect message templates in the specified knowledge base.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_message_templates({
  knowledge_base_id: "UuidOrArn", # required
  search_expression: { # required
    queries: [
      {
        name: "NonEmptyString", # required
        values: ["MessageTemplateQueryValue"], # required
        operator: "CONTAINS", # required, accepts CONTAINS, CONTAINS_AND_PREFIX
        allow_fuzziness: false,
        priority: "HIGH", # accepts HIGH, MEDIUM, LOW
      },
    ],
    filters: [
      {
        name: "NonEmptyString", # required
        values: ["MessageTemplateFilterValue"],
        operator: "EQUALS", # required, accepts EQUALS, PREFIX
        include_no_existence: false,
      },
    ],
    order_on_field: {
      name: "NonEmptyString", # required
      order: "ASC", # accepts ASC, DESC
    },
  },
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.results #=> Array
resp.results[0].message_template_arn #=> String
resp.results[0].message_template_id #=> String
resp.results[0].knowledge_base_arn #=> String
resp.results[0].knowledge_base_id #=> String
resp.results[0].name #=> String
resp.results[0].channel_subtype #=> String, one of "EMAIL", "SMS"
resp.results[0].created_time #=> Time
resp.results[0].last_modified_time #=> Time
resp.results[0].last_modified_by #=> String
resp.results[0].is_active #=> Boolean
resp.results[0].version_number #=> Integer
resp.results[0].description #=> String
resp.results[0].grouping_configuration.criteria #=> String
resp.results[0].grouping_configuration.values #=> Array
resp.results[0].grouping_configuration.values[0] #=> String
resp.results[0].language #=> String
resp.results[0].tags #=> Hash
resp.results[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :search_expression (required, Types::MessageTemplateSearchExpression) —

    The search expression for querying the message template.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

Returns:

See Also:



5914
5915
5916
5917
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 5914

def search_message_templates(params = {}, options = {})
  req = build_request(:search_message_templates, params)
  req.send_request(options)
end

#search_quick_responses(params = {}) ⇒ Types::SearchQuickResponsesResponse

Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_quick_responses({
  knowledge_base_id: "UuidOrArn", # required
  search_expression: { # required
    queries: [
      {
        name: "NonEmptyString", # required
        values: ["QuickResponseQueryValue"], # required
        operator: "CONTAINS", # required, accepts CONTAINS, CONTAINS_AND_PREFIX
        allow_fuzziness: false,
        priority: "HIGH", # accepts HIGH, MEDIUM, LOW
      },
    ],
    filters: [
      {
        name: "NonEmptyString", # required
        values: ["QuickResponseFilterValue"],
        operator: "EQUALS", # required, accepts EQUALS, PREFIX
        include_no_existence: false,
      },
    ],
    order_on_field: {
      name: "NonEmptyString", # required
      order: "ASC", # accepts ASC, DESC
    },
  },
  next_token: "NonEmptyString",
  max_results: 1,
  attributes: {
    "ContactAttributeKey" => "ContactAttributeValue",
  },
})

Response structure


resp.results #=> Array
resp.results[0].quick_response_arn #=> String
resp.results[0].quick_response_id #=> String
resp.results[0].knowledge_base_arn #=> String
resp.results[0].knowledge_base_id #=> String
resp.results[0].name #=> String
resp.results[0].content_type #=> String
resp.results[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.results[0].contents.plain_text.content #=> String
resp.results[0].contents.markdown.content #=> String
resp.results[0].created_time #=> Time
resp.results[0].last_modified_time #=> Time
resp.results[0].is_active #=> Boolean
resp.results[0].description #=> String
resp.results[0].grouping_configuration.criteria #=> String
resp.results[0].grouping_configuration.values #=> Array
resp.results[0].grouping_configuration.values[0] #=> String
resp.results[0].shortcut_key #=> String
resp.results[0].last_modified_by #=> String
resp.results[0].channels #=> Array
resp.results[0].channels[0] #=> String
resp.results[0].language #=> String
resp.results[0].attributes_not_interpolated #=> Array
resp.results[0].attributes_not_interpolated[0] #=> String
resp.results[0].attributes_interpolated #=> Array
resp.results[0].attributes_interpolated[0] #=> String
resp.results[0].tags #=> Hash
resp.results[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :search_expression (required, Types::QuickResponseSearchExpression) —

    The search expression for querying the quick response.

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :attributes (Hash<String,String>) —

    The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

Returns:

See Also:



6023
6024
6025
6026
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 6023

def search_quick_responses(params = {}, options = {})
  req = build_request(:search_quick_responses, params)
  req.send_request(options)
end

#search_sessions(params = {}) ⇒ Types::SearchSessionsResponse

Searches for sessions.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.search_sessions({
  next_token: "NextToken",
  max_results: 1,
  assistant_id: "UuidOrArn", # required
  search_expression: { # required
    filters: [ # required
      {
        field: "NAME", # required, accepts NAME
        operator: "EQUALS", # required, accepts EQUALS
        value: "NonEmptyString", # required
      },
    ],
  },
})

Response structure


resp.session_summaries #=> Array
resp.session_summaries[0].session_id #=> String
resp.session_summaries[0].session_arn #=> String
resp.session_summaries[0].assistant_id #=> String
resp.session_summaries[0].assistant_arn #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • :max_results (Integer) —

    The maximum number of results to return per page.

  • :assistant_id (required, String) —

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

  • :search_expression (required, Types::SearchExpression) —

    The search expression to filter results.

Returns:

See Also:



6082
6083
6084
6085
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 6082

def search_sessions(params = {}, options = {})
  req = build_request(:search_sessions, params)
  req.send_request(options)
end

#send_message(params = {}) ⇒ Types::SendMessageResponse

Submits a message to the Amazon Q in Connect session.

Examples:

Request syntax with placeholder values


resp = client.send_message({
  assistant_id: "UuidOrArn", # required
  session_id: "UuidOrArn", # required
  type: "TEXT", # required, accepts TEXT
  message: { # required
    value: { # required
      text: {
        value: "TextMessageValueString",
      },
    },
  },
  conversation_context: {
    self_service_conversation_history: [ # required
      {
        turn_number: 1, # required
        input_transcript: "SensitiveString",
        bot_response: "SensitiveString",
      },
    ],
  },
  configuration: {
    generate_filler_message: false,
  },
  client_token: "ClientToken",
})

Response structure


resp.request_message_id #=> String
resp.configuration.generate_filler_message #=> Boolean
resp.next_message_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Amazon Q in Connect assistant.

  • :session_id (required, String) —

    The identifier of the Amazon Q in Connect session.

  • :type (required, String) —

    The message type.

  • :message (required, Types::MessageInput) —

    The message data to submit to the Amazon Q in Connect session.

  • :conversation_context (Types::ConversationContext) —

    The conversation context before the Amazon Q in Connect session.

  • :configuration (Types::MessageConfiguration) —

    The configuration of the SendMessage request.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS 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:

See Also:



6164
6165
6166
6167
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 6164

def send_message(params = {}, options = {})
  req = build_request(:send_message, params)
  req.send_request(options)
end

#start_content_upload(params = {}) ⇒ Types::StartContentUploadResponse

Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.

Examples:

Request syntax with placeholder values


resp = client.start_content_upload({
  knowledge_base_id: "UuidOrArn", # required
  content_type: "ContentType", # required
  presigned_url_time_to_live: 1,
})

Response structure


resp.upload_id #=> String
resp.url #=> String
resp.url_expiry #=> Time
resp.headers_to_include #=> Hash
resp.headers_to_include["NonEmptyString"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :content_type (required, String) —

    The type of content to upload.

  • :presigned_url_time_to_live (Integer) —

    The expected expiration time of the generated presigned URL, specified in minutes.

Returns:

See Also:



6219
6220
6221
6222
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 6219

def start_content_upload(params = {}, options = {})
  req = build_request(:start_content_upload, params)
  req.send_request(options)
end

#start_import_job(params = {}) ⇒ Types::StartImportJobResponse

Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.

  • For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.

^

Examples:

Request syntax with placeholder values


resp = client.start_import_job({
  knowledge_base_id: "UuidOrArn", # required
  import_job_type: "QUICK_RESPONSES", # required, accepts QUICK_RESPONSES
  upload_id: "UploadId", # required
  client_token: "NonEmptyString",
  metadata: {
    "NonEmptyString" => "NonEmptyString",
  },
  external_source_configuration: {
    source: "AMAZON_CONNECT", # required, accepts AMAZON_CONNECT
    configuration: { # required
      connect_configuration: {
        instance_id: "NonEmptyString",
      },
    },
  },
})

Response structure


resp.import_job.import_job_id #=> String
resp.import_job.knowledge_base_id #=> String
resp.import_job.upload_id #=> String
resp.import_job.knowledge_base_arn #=> String
resp.import_job.import_job_type #=> String, one of "QUICK_RESPONSES"
resp.import_job.status #=> String, one of "START_IN_PROGRESS", "FAILED", "COMPLETE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.import_job.url #=> String
resp.import_job.failed_record_report #=> String
resp.import_job.url_expiry #=> Time
resp.import_job.created_time #=> Time
resp.import_job.last_modified_time #=> Time
resp.import_job.metadata #=> Hash
resp.import_job.metadata["NonEmptyString"] #=> String
resp.import_job.external_source_configuration.source #=> String, one of "AMAZON_CONNECT"
resp.import_job.external_source_configuration.configuration.connect_configuration.instance_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

    • For importing Amazon Q in Connect quick responses, this should be a QUICK_RESPONSES type knowledge base.

    ^

  • :import_job_type (required, String) —

    The type of the import job.

    • For importing quick response resource, set the value to QUICK_RESPONSES.

    ^

  • :upload_id (required, String) —

    A pointer to the uploaded asset. This value is returned by StartContentUpload.

  • :client_token (String) —

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

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

  • :metadata (Hash<String,String>) —

    The metadata fields of the imported Amazon Q in Connect resources.

  • :external_source_configuration (Types::ExternalSourceConfiguration) —

    The configuration information of the external source that the resource data are imported from.

Returns:

See Also:



6325
6326
6327
6328
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 6325

def start_import_job(params = {}, options = {})
  req = build_request(:start_import_job, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds the specified tags to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tags (required, Hash<String,String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6353
6354
6355
6356
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 6353

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the specified tags from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

  • :tag_keys (required, Array<String>) —

    The tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



6379
6380
6381
6382
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 6379

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_ai_agent(params = {}) ⇒ Types::UpdateAIAgentResponse

Updates an AI Agent.

Examples:

Request syntax with placeholder values


resp = client.update_ai_agent({
  client_token: "ClientToken",
  assistant_id: "UuidOrArn", # required
  ai_agent_id: "UuidOrArnOrEitherWithQualifier", # required
  visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
  configuration: {
    manual_search_ai_agent_configuration: {
      answer_generation_ai_prompt_id: "UuidWithQualifier",
      answer_generation_ai_guardrail_id: "UuidWithQualifier",
      association_configurations: [
        {
          association_id: "Uuid",
          association_type: "KNOWLEDGE_BASE", # accepts KNOWLEDGE_BASE
          association_configuration_data: {
            knowledge_base_association_configuration_data: {
              content_tag_filter: {
                tag_condition: {
                  key: "TagKey", # required
                  value: "TagValue",
                },
                and_conditions: [
                  {
                    key: "TagKey", # required
                    value: "TagValue",
                  },
                ],
                or_conditions: [
                  {
                    and_conditions: [
                      {
                        key: "TagKey", # required
                        value: "TagValue",
                      },
                    ],
                    tag_condition: {
                      key: "TagKey", # required
                      value: "TagValue",
                    },
                  },
                ],
              },
              max_results: 1,
              override_knowledge_base_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
            },
          },
        },
      ],
      locale: "NonEmptyString",
    },
    answer_recommendation_ai_agent_configuration: {
      intent_labeling_generation_ai_prompt_id: "UuidWithQualifier",
      query_reformulation_ai_prompt_id: "UuidWithQualifier",
      answer_generation_ai_prompt_id: "UuidWithQualifier",
      answer_generation_ai_guardrail_id: "UuidWithQualifier",
      association_configurations: [
        {
          association_id: "Uuid",
          association_type: "KNOWLEDGE_BASE", # accepts KNOWLEDGE_BASE
          association_configuration_data: {
            knowledge_base_association_configuration_data: {
              content_tag_filter: {
                tag_condition: {
                  key: "TagKey", # required
                  value: "TagValue",
                },
                and_conditions: [
                  {
                    key: "TagKey", # required
                    value: "TagValue",
                  },
                ],
                or_conditions: [
                  {
                    and_conditions: [
                      {
                        key: "TagKey", # required
                        value: "TagValue",
                      },
                    ],
                    tag_condition: {
                      key: "TagKey", # required
                      value: "TagValue",
                    },
                  },
                ],
              },
              max_results: 1,
              override_knowledge_base_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
            },
          },
        },
      ],
      locale: "NonEmptyString",
    },
    self_service_ai_agent_configuration: {
      self_service_pre_processing_ai_prompt_id: "UuidWithQualifier",
      self_service_answer_generation_ai_prompt_id: "UuidWithQualifier",
      self_service_ai_guardrail_id: "UuidWithQualifier",
      association_configurations: [
        {
          association_id: "Uuid",
          association_type: "KNOWLEDGE_BASE", # accepts KNOWLEDGE_BASE
          association_configuration_data: {
            knowledge_base_association_configuration_data: {
              content_tag_filter: {
                tag_condition: {
                  key: "TagKey", # required
                  value: "TagValue",
                },
                and_conditions: [
                  {
                    key: "TagKey", # required
                    value: "TagValue",
                  },
                ],
                or_conditions: [
                  {
                    and_conditions: [
                      {
                        key: "TagKey", # required
                        value: "TagValue",
                      },
                    ],
                    tag_condition: {
                      key: "TagKey", # required
                      value: "TagValue",
                    },
                  },
                ],
              },
              max_results: 1,
              override_knowledge_base_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
            },
          },
        },
      ],
    },
  },
  description: "Description",
})

Response structure


resp.ai_agent.assistant_id #=> String
resp.ai_agent.assistant_arn #=> String
resp.ai_agent.ai_agent_id #=> String
resp.ai_agent.ai_agent_arn #=> String
resp.ai_agent.name #=> String
resp.ai_agent.type #=> String, one of "MANUAL_SEARCH", "ANSWER_RECOMMENDATION", "SELF_SERVICE"
resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent.configuration.manual_search_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent.configuration.manual_search_ai_agent_configuration.locale #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.intent_labeling_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.query_reformulation_ai_prompt_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.answer_generation_ai_guardrail_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent.configuration.answer_recommendation_ai_agent_configuration.locale #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_pre_processing_ai_prompt_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_answer_generation_ai_prompt_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.self_service_ai_guardrail_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_id #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_type #=> String, one of "KNOWLEDGE_BASE"
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.tag_condition.value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.and_conditions[0].value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions #=> Array
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.key #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.content_tag_filter.or_conditions[0].tag_condition.value #=> String
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.max_results #=> Integer
resp.ai_agent.configuration.self_service_ai_agent_configuration.association_configurations[0].association_configuration_data.knowledge_base_association_configuration_data.override_knowledge_base_search_type #=> String, one of "HYBRID", "SEMANTIC"
resp.ai_agent.modified_time #=> Time
resp.ai_agent.description #=> String
resp.ai_agent.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_agent.tags #=> Hash
resp.ai_agent.tags["TagKey"] #=> String
resp.ai_agent.origin #=> String, one of "SYSTEM", "CUSTOMER"
resp.ai_agent.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.**

  • :assistant_id (required, String) —

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

  • :ai_agent_id (required, String) —

    The identifier of the Amazon Q in Connect AI Agent.

  • :visibility_status (required, String) —

    The visbility status of the Amazon Q in Connect AI Agent.

  • :configuration (Types::AIAgentConfiguration) —

    The configuration of the Amazon Q in Connect AI Agent.

  • :description (String) —

    The description of the Amazon Q in Connect AI Agent.

Returns:

See Also:



6641
6642
6643
6644
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 6641

def update_ai_agent(params = {}, options = {})
  req = build_request(:update_ai_agent, params)
  req.send_request(options)
end

#update_ai_guardrail(params = {}) ⇒ Types::UpdateAIGuardrailResponse

Updates an AI Guardrail.

Examples:

Request syntax with placeholder values


resp = client.update_ai_guardrail({
  client_token: "ClientToken",
  assistant_id: "UuidOrArn", # required
  ai_guardrail_id: "UuidOrArnOrEitherWithQualifier", # required
  visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
  blocked_input_messaging: "AIGuardrailBlockedMessaging", # required
  blocked_outputs_messaging: "AIGuardrailBlockedMessaging", # required
  description: "AIGuardrailDescription",
  topic_policy_config: {
    topics_config: [ # required
      {
        name: "GuardrailTopicName", # required
        definition: "GuardrailTopicDefinition", # required
        examples: ["GuardrailTopicExample"],
        type: "DENY", # required, accepts DENY
      },
    ],
  },
  content_policy_config: {
    filters_config: [ # required
      {
        type: "SEXUAL", # required, accepts SEXUAL, VIOLENCE, HATE, INSULTS, MISCONDUCT, PROMPT_ATTACK
        input_strength: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH
        output_strength: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH
      },
    ],
  },
  word_policy_config: {
    words_config: [
      {
        text: "GuardrailWordText", # required
      },
    ],
    managed_word_lists_config: [
      {
        type: "PROFANITY", # required, accepts PROFANITY
      },
    ],
  },
  sensitive_information_policy_config: {
    pii_entities_config: [
      {
        type: "ADDRESS", # required, accepts ADDRESS, AGE, AWS_ACCESS_KEY, AWS_SECRET_KEY, CA_HEALTH_NUMBER, CA_SOCIAL_INSURANCE_NUMBER, CREDIT_DEBIT_CARD_CVV, CREDIT_DEBIT_CARD_EXPIRY, CREDIT_DEBIT_CARD_NUMBER, DRIVER_ID, EMAIL, INTERNATIONAL_BANK_ACCOUNT_NUMBER, IP_ADDRESS, LICENSE_PLATE, MAC_ADDRESS, NAME, PASSWORD, PHONE, PIN, SWIFT_CODE, UK_NATIONAL_HEALTH_SERVICE_NUMBER, UK_NATIONAL_INSURANCE_NUMBER, UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER, URL, USERNAME, US_BANK_ACCOUNT_NUMBER, US_BANK_ROUTING_NUMBER, US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER, US_PASSPORT_NUMBER, US_SOCIAL_SECURITY_NUMBER, VEHICLE_IDENTIFICATION_NUMBER
        action: "BLOCK", # required, accepts BLOCK, ANONYMIZE
      },
    ],
    regexes_config: [
      {
        name: "GuardrailRegexName", # required
        description: "GuardrailRegexDescription",
        pattern: "GuardrailRegexPattern", # required
        action: "BLOCK", # required, accepts BLOCK, ANONYMIZE
      },
    ],
  },
  contextual_grounding_policy_config: {
    filters_config: [ # required
      {
        type: "GROUNDING", # required, accepts GROUNDING, RELEVANCE
        threshold: 1.0, # required
      },
    ],
  },
})

Response structure


resp.ai_guardrail.assistant_id #=> String
resp.ai_guardrail.assistant_arn #=> String
resp.ai_guardrail.ai_guardrail_arn #=> String
resp.ai_guardrail.ai_guardrail_id #=> String
resp.ai_guardrail.name #=> String
resp.ai_guardrail.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_guardrail.blocked_input_messaging #=> String
resp.ai_guardrail.blocked_outputs_messaging #=> String
resp.ai_guardrail.description #=> String
resp.ai_guardrail.topic_policy_config.topics_config #=> Array
resp.ai_guardrail.topic_policy_config.topics_config[0].name #=> String
resp.ai_guardrail.topic_policy_config.topics_config[0].definition #=> String
resp.ai_guardrail.topic_policy_config.topics_config[0].examples #=> Array
resp.ai_guardrail.topic_policy_config.topics_config[0].examples[0] #=> String
resp.ai_guardrail.topic_policy_config.topics_config[0].type #=> String, one of "DENY"
resp.ai_guardrail.content_policy_config.filters_config #=> Array
resp.ai_guardrail.content_policy_config.filters_config[0].type #=> String, one of "SEXUAL", "VIOLENCE", "HATE", "INSULTS", "MISCONDUCT", "PROMPT_ATTACK"
resp.ai_guardrail.content_policy_config.filters_config[0].input_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
resp.ai_guardrail.content_policy_config.filters_config[0].output_strength #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
resp.ai_guardrail.word_policy_config.words_config #=> Array
resp.ai_guardrail.word_policy_config.words_config[0].text #=> String
resp.ai_guardrail.word_policy_config.managed_word_lists_config #=> Array
resp.ai_guardrail.word_policy_config.managed_word_lists_config[0].type #=> String, one of "PROFANITY"
resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config #=> Array
resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].type #=> String, one of "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME", "PASSWORD", "PHONE", "PIN", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "URL", "USERNAME", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "VEHICLE_IDENTIFICATION_NUMBER"
resp.ai_guardrail.sensitive_information_policy_config.pii_entities_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
resp.ai_guardrail.sensitive_information_policy_config.regexes_config #=> Array
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].name #=> String
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].description #=> String
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].pattern #=> String
resp.ai_guardrail.sensitive_information_policy_config.regexes_config[0].action #=> String, one of "BLOCK", "ANONYMIZE"
resp.ai_guardrail.contextual_grounding_policy_config.filters_config #=> Array
resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].type #=> String, one of "GROUNDING", "RELEVANCE"
resp.ai_guardrail.contextual_grounding_policy_config.filters_config[0].threshold #=> Float
resp.ai_guardrail.tags #=> Hash
resp.ai_guardrail.tags["TagKey"] #=> String
resp.ai_guardrail.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.ai_guardrail.modified_time #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.**

  • :assistant_id (required, String) —

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

  • :ai_guardrail_id (required, String) —

    The identifier of the Amazon Q in Connect AI Guardrail.

  • :visibility_status (required, String) —

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

  • :blocked_input_messaging (required, String) —

    The message to return when the AI Guardrail blocks a prompt.

  • :blocked_outputs_messaging (required, String) —

    The message to return when the AI Guardrail blocks a model response.

  • :description (String) —

    A description of the AI Guardrail.

  • :topic_policy_config (Types::AIGuardrailTopicPolicyConfig) —

    The topic policies to configure for the AI Guardrail.

  • :content_policy_config (Types::AIGuardrailContentPolicyConfig) —

    The content filter policies to configure for the AI Guardrail.

  • :word_policy_config (Types::AIGuardrailWordPolicyConfig) —

    The word policy you configure for the AI Guardrail.

  • :sensitive_information_policy_config (Types::AIGuardrailSensitiveInformationPolicyConfig) —

    The sensitive information policy to configure for the AI Guardrail.

  • :contextual_grounding_policy_config (Types::AIGuardrailContextualGroundingPolicyConfig) —

    The contextual grounding policy configuration used to create an AI Guardrail.

Returns:

See Also:



6812
6813
6814
6815
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 6812

def update_ai_guardrail(params = {}, options = {})
  req = build_request(:update_ai_guardrail, params)
  req.send_request(options)
end

#update_ai_prompt(params = {}) ⇒ Types::UpdateAIPromptResponse

Updates an AI Prompt.

Examples:

Request syntax with placeholder values


resp = client.update_ai_prompt({
  client_token: "ClientToken",
  assistant_id: "UuidOrArn", # required
  ai_prompt_id: "UuidOrArnOrEitherWithQualifier", # required
  visibility_status: "SAVED", # required, accepts SAVED, PUBLISHED
  template_configuration: {
    text_full_ai_prompt_edit_template_configuration: {
      text: "TextAIPrompt", # required
    },
  },
  description: "Description",
})

Response structure


resp.ai_prompt.assistant_id #=> String
resp.ai_prompt.assistant_arn #=> String
resp.ai_prompt.ai_prompt_id #=> String
resp.ai_prompt.ai_prompt_arn #=> String
resp.ai_prompt.name #=> String
resp.ai_prompt.type #=> String, one of "ANSWER_GENERATION", "INTENT_LABELING_GENERATION", "QUERY_REFORMULATION", "SELF_SERVICE_PRE_PROCESSING", "SELF_SERVICE_ANSWER_GENERATION"
resp.ai_prompt.template_type #=> String, one of "TEXT"
resp.ai_prompt.model_id #=> String
resp.ai_prompt.api_format #=> String, one of "ANTHROPIC_CLAUDE_MESSAGES", "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS", "MESSAGES", "TEXT_COMPLETIONS"
resp.ai_prompt.template_configuration.text_full_ai_prompt_edit_template_configuration.text #=> String
resp.ai_prompt.modified_time #=> Time
resp.ai_prompt.description #=> String
resp.ai_prompt.visibility_status #=> String, one of "SAVED", "PUBLISHED"
resp.ai_prompt.tags #=> Hash
resp.ai_prompt.tags["TagKey"] #=> String
resp.ai_prompt.origin #=> String, one of "SYSTEM", "CUSTOMER"
resp.ai_prompt.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.**

  • :assistant_id (required, String) —

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

  • :ai_prompt_id (required, String) —

    The identifier of the Amazon Q in Connect AI Prompt.

  • :visibility_status (required, String) —

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

  • :template_configuration (Types::AIPromptTemplateConfiguration) —

    The configuration of the prompt template for this AI Prompt.

  • :description (String) —

    The description of the Amazon Q in Connect AI Prompt.

Returns:

See Also:



6891
6892
6893
6894
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 6891

def update_ai_prompt(params = {}, options = {})
  req = build_request(:update_ai_prompt, params)
  req.send_request(options)
end

#update_assistant_ai_agent(params = {}) ⇒ Types::UpdateAssistantAIAgentResponse

Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.

Examples:

Request syntax with placeholder values


resp = client.update_assistant_ai_agent({
  assistant_id: "UuidOrArn", # required
  ai_agent_type: "MANUAL_SEARCH", # required, accepts MANUAL_SEARCH, ANSWER_RECOMMENDATION, SELF_SERVICE
  configuration: { # required
    ai_agent_id: "UuidWithQualifier", # required
  },
})

Response structure


resp.assistant.assistant_id #=> String
resp.assistant.assistant_arn #=> String
resp.assistant.name #=> String
resp.assistant.type #=> String, one of "AGENT"
resp.assistant.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.assistant.description #=> String
resp.assistant.tags #=> Hash
resp.assistant.tags["TagKey"] #=> String
resp.assistant.server_side_encryption_configuration.kms_key_id #=> String
resp.assistant.integration_configuration.topic_integration_arn #=> String
resp.assistant.capability_configuration.type #=> String, one of "V1", "V2"
resp.assistant.ai_agent_configuration #=> Hash
resp.assistant.ai_agent_configuration["AIAgentType"].ai_agent_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :ai_agent_type (required, String) —

    The type of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.

  • :configuration (required, Types::AIAgentConfigurationData) —

    The configuration of the AI Agent being updated for use by default on the Amazon Q in Connect Assistant.

Returns:

See Also:



6945
6946
6947
6948
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 6945

def update_assistant_ai_agent(params = {}, options = {})
  req = build_request(:update_assistant_ai_agent, params)
  req.send_request(options)
end

#update_content(params = {}) ⇒ Types::UpdateContentResponse

Updates information about the content.

Examples:

Request syntax with placeholder values


resp = client.update_content({
  knowledge_base_id: "UuidOrArn", # required
  content_id: "UuidOrArn", # required
  revision_id: "NonEmptyString",
  title: "ContentTitle",
  override_link_out_uri: "Uri",
  remove_override_link_out_uri: false,
  metadata: {
    "NonEmptyString" => "NonEmptyString",
  },
  upload_id: "UploadId",
})

Response structure


resp.content.content_arn #=> String
resp.content.content_id #=> String
resp.content.knowledge_base_arn #=> String
resp.content.knowledge_base_id #=> String
resp.content.name #=> String
resp.content.revision_id #=> String
resp.content.title #=> String
resp.content.content_type #=> String
resp.content.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
resp.content.metadata #=> Hash
resp.content.metadata["NonEmptyString"] #=> String
resp.content.tags #=> Hash
resp.content.tags["TagKey"] #=> String
resp.content.link_out_uri #=> String
resp.content.url #=> String
resp.content.url_expiry #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN

  • :content_id (required, String) —

    The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :revision_id (String) —

    The revisionId of the content resource to update, taken from an earlier call to GetContent, GetContentSummary, SearchContent, or ListContents. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a PreconditionFailedException.

  • :title (String) —

    The title of the content.

  • :override_link_out_uri (String) —

    The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri to true.

  • :remove_override_link_out_uri (Boolean) —

    Unset the existing overrideLinkOutUri if it exists.

  • :metadata (Hash<String,String>) —

    A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.

  • :upload_id (String) —

    A pointer to the uploaded asset. This value is returned by StartContentUpload.

Returns:

See Also:



7035
7036
7037
7038
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 7035

def update_content(params = {}, options = {})
  req = build_request(:update_content, params)
  req.send_request(options)
end

#update_knowledge_base_template_uri(params = {}) ⇒ Types::UpdateKnowledgeBaseTemplateUriResponse

Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.

Examples:

Request syntax with placeholder values


resp = client.update_knowledge_base_template_uri({
  knowledge_base_id: "UuidOrArn", # required
  template_uri: "Uri", # required
})

Response structure


resp.knowledge_base.knowledge_base_id #=> String
resp.knowledge_base.knowledge_base_arn #=> String
resp.knowledge_base.name #=> String
resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM", "QUICK_RESPONSES", "MESSAGE_TEMPLATES", "MANAGED"
resp.knowledge_base.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.knowledge_base.last_content_modification_time #=> Time
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.chunking_strategy #=> String, one of "FIXED_SIZE", "NONE", "HIERARCHICAL", "SEMANTIC"
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.max_tokens #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.overlap_percentage #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations #=> Array
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.level_configurations[0].max_tokens #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.hierarchical_chunking_configuration.overlap_tokens #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.max_tokens #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.buffer_size #=> Integer
resp.knowledge_base.vector_ingestion_configuration.chunking_configuration.semantic_chunking_configuration.breakpoint_percentile_threshold #=> Integer
resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.parsing_strategy #=> String, one of "BEDROCK_FOUNDATION_MODEL"
resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.model_arn #=> String
resp.knowledge_base.vector_ingestion_configuration.parsing_configuration.bedrock_foundation_model_configuration.parsing_prompt.parsing_prompt_text #=> String
resp.knowledge_base.source_configuration.app_integrations.app_integration_arn #=> String
resp.knowledge_base.source_configuration.app_integrations.object_fields #=> Array
resp.knowledge_base.source_configuration.app_integrations.object_fields[0] #=> String
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls #=> Array
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.url_configuration.seed_urls[0].url #=> String
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.crawler_limits.rate_limit #=> Integer
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters #=> Array
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.inclusion_filters[0] #=> String
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters #=> Array
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.exclusion_filters[0] #=> String
resp.knowledge_base.source_configuration.managed_source_configuration.web_crawler_configuration.scope #=> String, one of "HOST_ONLY", "SUBDOMAINS"
resp.knowledge_base.rendering_configuration.template_uri #=> String
resp.knowledge_base.server_side_encryption_configuration.kms_key_id #=> String
resp.knowledge_base.description #=> String
resp.knowledge_base.tags #=> Hash
resp.knowledge_base.tags["TagKey"] #=> String
resp.knowledge_base.ingestion_status #=> String, one of "SYNC_FAILED", "SYNCING_IN_PROGRESS", "SYNC_SUCCESS", "CREATE_IN_PROGRESS"
resp.knowledge_base.ingestion_failure_reasons #=> Array
resp.knowledge_base.ingestion_failure_reasons[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :template_uri (required, String) —

    The template URI to update.

Returns:

See Also:



7110
7111
7112
7113
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 7110

def update_knowledge_base_template_uri(params = {}, options = {})
  req = build_request(:update_knowledge_base_template_uri, params)
  req.send_request(options)
end

#update_message_template(params = {}) ⇒ Types::UpdateMessageTemplateResponse

Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the $LATEST qualifier. Any modification will only apply to the message template that is referenced by the $LATEST qualifier. The fields for all available versions will remain unchanged.

Examples:

Request syntax with placeholder values


resp = client.update_message_template({
  knowledge_base_id: "UuidOrArn", # required
  message_template_id: "UuidOrArnOrEitherWithQualifier", # required
  content: {
    email: {
      subject: "NonEmptyUnlimitedString",
      body: {
        plain_text: {
          content: "NonEmptyUnlimitedString",
        },
        html: {
          content: "NonEmptyUnlimitedString",
        },
      },
      headers: [
        {
          name: "EmailHeaderKey",
          value: "EmailHeaderValue",
        },
      ],
    },
    sms: {
      body: {
        plain_text: {
          content: "NonEmptyUnlimitedString",
        },
      },
    },
  },
  language: "LanguageCode",
  default_attributes: {
    system_attributes: {
      name: "MessageTemplateAttributeValue",
      customer_endpoint: {
        address: "MessageTemplateAttributeValue",
      },
      system_endpoint: {
        address: "MessageTemplateAttributeValue",
      },
    },
    agent_attributes: {
      first_name: "MessageTemplateAttributeValue",
      last_name: "MessageTemplateAttributeValue",
    },
    customer_profile_attributes: {
      profile_id: "MessageTemplateAttributeValue",
      profile_arn: "MessageTemplateAttributeValue",
      first_name: "MessageTemplateAttributeValue",
      middle_name: "MessageTemplateAttributeValue",
      last_name: "MessageTemplateAttributeValue",
      account_number: "MessageTemplateAttributeValue",
      email_address: "MessageTemplateAttributeValue",
      phone_number: "MessageTemplateAttributeValue",
      additional_information: "MessageTemplateAttributeValue",
      party_type: "MessageTemplateAttributeValue",
      business_name: "MessageTemplateAttributeValue",
      birth_date: "MessageTemplateAttributeValue",
      gender: "MessageTemplateAttributeValue",
      mobile_phone_number: "MessageTemplateAttributeValue",
      home_phone_number: "MessageTemplateAttributeValue",
      business_phone_number: "MessageTemplateAttributeValue",
      business_email_address: "MessageTemplateAttributeValue",
      address1: "MessageTemplateAttributeValue",
      address2: "MessageTemplateAttributeValue",
      address3: "MessageTemplateAttributeValue",
      address4: "MessageTemplateAttributeValue",
      city: "MessageTemplateAttributeValue",
      county: "MessageTemplateAttributeValue",
      country: "MessageTemplateAttributeValue",
      postal_code: "MessageTemplateAttributeValue",
      province: "MessageTemplateAttributeValue",
      state: "MessageTemplateAttributeValue",
      shipping_address_1: "MessageTemplateAttributeValue",
      shipping_address_2: "MessageTemplateAttributeValue",
      shipping_address_3: "MessageTemplateAttributeValue",
      shipping_address_4: "MessageTemplateAttributeValue",
      shipping_city: "MessageTemplateAttributeValue",
      shipping_county: "MessageTemplateAttributeValue",
      shipping_country: "MessageTemplateAttributeValue",
      shipping_postal_code: "MessageTemplateAttributeValue",
      shipping_province: "MessageTemplateAttributeValue",
      shipping_state: "MessageTemplateAttributeValue",
      mailing_address_1: "MessageTemplateAttributeValue",
      mailing_address_2: "MessageTemplateAttributeValue",
      mailing_address_3: "MessageTemplateAttributeValue",
      mailing_address_4: "MessageTemplateAttributeValue",
      mailing_city: "MessageTemplateAttributeValue",
      mailing_county: "MessageTemplateAttributeValue",
      mailing_country: "MessageTemplateAttributeValue",
      mailing_postal_code: "MessageTemplateAttributeValue",
      mailing_province: "MessageTemplateAttributeValue",
      mailing_state: "MessageTemplateAttributeValue",
      billing_address_1: "MessageTemplateAttributeValue",
      billing_address_2: "MessageTemplateAttributeValue",
      billing_address_3: "MessageTemplateAttributeValue",
      billing_address_4: "MessageTemplateAttributeValue",
      billing_city: "MessageTemplateAttributeValue",
      billing_county: "MessageTemplateAttributeValue",
      billing_country: "MessageTemplateAttributeValue",
      billing_postal_code: "MessageTemplateAttributeValue",
      billing_province: "MessageTemplateAttributeValue",
      billing_state: "MessageTemplateAttributeValue",
      custom: {
        "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
      },
    },
    custom_attributes: {
      "MessageTemplateAttributeKey" => "MessageTemplateAttributeValue",
    },
  },
})

Response structure


resp.message_template.message_template_arn #=> String
resp.message_template.message_template_id #=> String
resp.message_template.knowledge_base_arn #=> String
resp.message_template.knowledge_base_id #=> String
resp.message_template.name #=> String
resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
resp.message_template.created_time #=> Time
resp.message_template.last_modified_time #=> Time
resp.message_template.last_modified_by #=> String
resp.message_template.content.email.subject #=> String
resp.message_template.content.email.body.plain_text.content #=> String
resp.message_template.content.email.body.html.content #=> String
resp.message_template.content.email.headers #=> Array
resp.message_template.content.email.headers[0].name #=> String
resp.message_template.content.email.headers[0].value #=> String
resp.message_template.content.sms.body.plain_text.content #=> String
resp.message_template.description #=> String
resp.message_template.language #=> String
resp.message_template.grouping_configuration.criteria #=> String
resp.message_template.grouping_configuration.values #=> Array
resp.message_template.grouping_configuration.values[0] #=> String
resp.message_template.default_attributes.system_attributes.name #=> String
resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
resp.message_template.default_attributes.agent_attributes.first_name #=> String
resp.message_template.default_attributes.agent_attributes.last_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
resp.message_template.default_attributes.customer_profile_attributes. #=> String
resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.city #=> String
resp.message_template.default_attributes.customer_profile_attributes.county #=> String
resp.message_template.default_attributes.customer_profile_attributes.country #=> String
resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.province #=> String
resp.message_template.default_attributes.customer_profile_attributes.state #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
resp.message_template.default_attributes.custom_attributes #=> Hash
resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
resp.message_template.attribute_types #=> Array
resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
resp.message_template.message_template_content_sha_256 #=> String
resp.message_template.tags #=> Hash
resp.message_template.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :message_template_id (required, String) —

    The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.

  • :content (Types::MessageTemplateContentProvider) —

    The content of the message template.

  • :language (String) —

    The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

  • :default_attributes (Types::MessageTemplateAttributes) —

    An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.

Returns:

See Also:



7363
7364
7365
7366
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 7363

def update_message_template(params = {}, options = {})
  req = build_request(:update_message_template, params)
  req.send_request(options)
end

#update_message_template_metadata(params = {}) ⇒ Types::UpdateMessageTemplateMetadataResponse

Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the $LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.

Examples:

Request syntax with placeholder values


resp = client.update_message_template_metadata({
  knowledge_base_id: "UuidOrArn", # required
  message_template_id: "UuidOrArnOrEitherWithQualifier", # required
  name: "Name",
  description: "Description",
  grouping_configuration: {
    criteria: "GroupingCriteria",
    values: ["GroupingValue"],
  },
})

Response structure


resp.message_template.message_template_arn #=> String
resp.message_template.message_template_id #=> String
resp.message_template.knowledge_base_arn #=> String
resp.message_template.knowledge_base_id #=> String
resp.message_template.name #=> String
resp.message_template.channel_subtype #=> String, one of "EMAIL", "SMS"
resp.message_template.created_time #=> Time
resp.message_template.last_modified_time #=> Time
resp.message_template.last_modified_by #=> String
resp.message_template.content.email.subject #=> String
resp.message_template.content.email.body.plain_text.content #=> String
resp.message_template.content.email.body.html.content #=> String
resp.message_template.content.email.headers #=> Array
resp.message_template.content.email.headers[0].name #=> String
resp.message_template.content.email.headers[0].value #=> String
resp.message_template.content.sms.body.plain_text.content #=> String
resp.message_template.description #=> String
resp.message_template.language #=> String
resp.message_template.grouping_configuration.criteria #=> String
resp.message_template.grouping_configuration.values #=> Array
resp.message_template.grouping_configuration.values[0] #=> String
resp.message_template.default_attributes.system_attributes.name #=> String
resp.message_template.default_attributes.system_attributes.customer_endpoint.address #=> String
resp.message_template.default_attributes.system_attributes.system_endpoint.address #=> String
resp.message_template.default_attributes.agent_attributes.first_name #=> String
resp.message_template.default_attributes.agent_attributes.last_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.profile_id #=> String
resp.message_template.default_attributes.customer_profile_attributes.profile_arn #=> String
resp.message_template.default_attributes.customer_profile_attributes.first_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.middle_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.last_name #=> String
resp.message_template.default_attributes.customer_profile_attributes. #=> String
resp.message_template.default_attributes.customer_profile_attributes.email_address #=> String
resp.message_template.default_attributes.customer_profile_attributes.phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.additional_information #=> String
resp.message_template.default_attributes.customer_profile_attributes.party_type #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_name #=> String
resp.message_template.default_attributes.customer_profile_attributes.birth_date #=> String
resp.message_template.default_attributes.customer_profile_attributes.gender #=> String
resp.message_template.default_attributes.customer_profile_attributes.mobile_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.home_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_phone_number #=> String
resp.message_template.default_attributes.customer_profile_attributes.business_email_address #=> String
resp.message_template.default_attributes.customer_profile_attributes.address1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.address4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.city #=> String
resp.message_template.default_attributes.customer_profile_attributes.county #=> String
resp.message_template.default_attributes.customer_profile_attributes.country #=> String
resp.message_template.default_attributes.customer_profile_attributes.postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.province #=> String
resp.message_template.default_attributes.customer_profile_attributes.state #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.shipping_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.mailing_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_1 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_2 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_3 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_address_4 #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_city #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_county #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_country #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_postal_code #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_province #=> String
resp.message_template.default_attributes.customer_profile_attributes.billing_state #=> String
resp.message_template.default_attributes.customer_profile_attributes.custom #=> Hash
resp.message_template.default_attributes.customer_profile_attributes.custom["MessageTemplateAttributeKey"] #=> String
resp.message_template.default_attributes.custom_attributes #=> Hash
resp.message_template.default_attributes.custom_attributes["MessageTemplateAttributeKey"] #=> String
resp.message_template.attribute_types #=> Array
resp.message_template.attribute_types[0] #=> String, one of "SYSTEM", "AGENT", "CUSTOMER_PROFILE", "CUSTOM"
resp.message_template.message_template_content_sha_256 #=> String
resp.message_template.tags #=> Hash
resp.message_template.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :message_template_id (required, String) —

    The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.

  • :name (String) —

    The name of the message template.

  • :description (String) —

    The description of the message template.

  • :grouping_configuration (Types::GroupingConfiguration) —

    The configuration information of the grouping of Amazon Q in Connect users.

Returns:

See Also:



7509
7510
7511
7512
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 7509

def update_message_template_metadata(params = {}, options = {})
  req = build_request(:update_message_template_metadata, params)
  req.send_request(options)
end

#update_quick_response(params = {}) ⇒ Types::UpdateQuickResponseResponse

Updates an existing Amazon Q in Connect quick response.

Examples:

Request syntax with placeholder values


resp = client.update_quick_response({
  knowledge_base_id: "UuidOrArn", # required
  quick_response_id: "UuidOrArn", # required
  name: "QuickResponseName",
  content: {
    content: "QuickResponseContent",
  },
  content_type: "QuickResponseType",
  grouping_configuration: {
    criteria: "GroupingCriteria",
    values: ["GroupingValue"],
  },
  remove_grouping_configuration: false,
  description: "QuickResponseDescription",
  remove_description: false,
  shortcut_key: "ShortCutKey",
  remove_shortcut_key: false,
  is_active: false,
  channels: ["Channel"],
  language: "LanguageCode",
})

Response structure


resp.quick_response.quick_response_arn #=> String
resp.quick_response.quick_response_id #=> String
resp.quick_response.knowledge_base_arn #=> String
resp.quick_response.knowledge_base_id #=> String
resp.quick_response.name #=> String
resp.quick_response.content_type #=> String
resp.quick_response.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "CREATED", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
resp.quick_response.created_time #=> Time
resp.quick_response.last_modified_time #=> Time
resp.quick_response.contents.plain_text.content #=> String
resp.quick_response.contents.markdown.content #=> String
resp.quick_response.description #=> String
resp.quick_response.grouping_configuration.criteria #=> String
resp.quick_response.grouping_configuration.values #=> Array
resp.quick_response.grouping_configuration.values[0] #=> String
resp.quick_response.shortcut_key #=> String
resp.quick_response.last_modified_by #=> String
resp.quick_response.is_active #=> Boolean
resp.quick_response.channels #=> Array
resp.quick_response.channels[0] #=> String
resp.quick_response.language #=> String
resp.quick_response.tags #=> Hash
resp.quick_response.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :quick_response_id (required, String) —

    The identifier of the quick response.

  • :name (String) —

    The name of the quick response.

  • :content (Types::QuickResponseDataProvider) —

    The updated content of the quick response.

  • :content_type (String) —

    The media type of the quick response content.

    • Use application/x.quickresponse;format=plain for quick response written in plain text.

    • Use application/x.quickresponse;format=markdown for quick response written in richtext.

  • :grouping_configuration (Types::GroupingConfiguration) —

    The updated grouping configuration of the quick response.

  • :remove_grouping_configuration (Boolean) —

    Whether to remove the grouping configuration of the quick response.

  • :description (String) —

    The updated description of the quick response.

  • :remove_description (Boolean) —

    Whether to remove the description from the quick response.

  • :shortcut_key (String) —

    The shortcut key of the quick response. The value should be unique across the knowledge base.

  • :remove_shortcut_key (Boolean) —

    Whether to remove the shortcut key of the quick response.

  • :is_active (Boolean) —

    Whether the quick response is active.

  • :channels (Array<String>) —

    The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.

  • :language (String) —

    The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW

Returns:

See Also:



7628
7629
7630
7631
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 7628

def update_quick_response(params = {}, options = {})
  req = build_request(:update_quick_response, params)
  req.send_request(options)
end

#update_session(params = {}) ⇒ Types::UpdateSessionResponse

Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

Examples:

Request syntax with placeholder values


resp = client.update_session({
  assistant_id: "UuidOrArn", # required
  session_id: "UuidOrArn", # required
  description: "Description",
  tag_filter: {
    tag_condition: {
      key: "TagKey", # required
      value: "TagValue",
    },
    and_conditions: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
    or_conditions: [
      {
        and_conditions: [
          {
            key: "TagKey", # required
            value: "TagValue",
          },
        ],
        tag_condition: {
          key: "TagKey", # required
          value: "TagValue",
        },
      },
    ],
  },
  ai_agent_configuration: {
    "MANUAL_SEARCH" => {
      ai_agent_id: "UuidWithQualifier", # required
    },
  },
})

Response structure


resp.session.session_arn #=> String
resp.session.session_id #=> String
resp.session.name #=> String
resp.session.description #=> String
resp.session.tags #=> Hash
resp.session.tags["TagKey"] #=> String
resp.session.integration_configuration.topic_integration_arn #=> String
resp.session.tag_filter.tag_condition.key #=> String
resp.session.tag_filter.tag_condition.value #=> String
resp.session.tag_filter.and_conditions #=> Array
resp.session.tag_filter.and_conditions[0].key #=> String
resp.session.tag_filter.and_conditions[0].value #=> String
resp.session.tag_filter.or_conditions #=> Array
resp.session.tag_filter.or_conditions[0].and_conditions #=> Array
resp.session.tag_filter.or_conditions[0].and_conditions[0].key #=> String
resp.session.tag_filter.or_conditions[0].and_conditions[0].value #=> String
resp.session.tag_filter.or_conditions[0].tag_condition.key #=> String
resp.session.tag_filter.or_conditions[0].tag_condition.value #=> String
resp.session.ai_agent_configuration #=> Hash
resp.session.ai_agent_configuration["AIAgentType"].ai_agent_id #=> String
resp.session.origin #=> String, one of "SYSTEM", "CUSTOMER"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :session_id (required, String) —

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :description (String) —

    The description.

  • :tag_filter (Types::TagFilter) —

    An object that can be used to specify Tag conditions.

  • :ai_agent_configuration (Hash<String,Types::AIAgentConfigurationData>) —

    The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

Returns:

See Also:



7728
7729
7730
7731
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 7728

def update_session(params = {}, options = {})
  req = build_request(:update_session, params)
  req.send_request(options)
end

#update_session_data(params = {}) ⇒ Types::UpdateSessionDataResponse

Updates the data stored on an Amazon Q in Connect Session.

Examples:

Request syntax with placeholder values


resp = client.update_session_data({
  assistant_id: "UuidOrArn", # required
  session_id: "UuidOrArn", # required
  namespace: "Custom", # accepts Custom
  data: [ # required
    {
      key: "NonEmptySensitiveString", # required
      value: { # required
        string_value: "NonEmptySensitiveString",
      },
    },
  ],
})

Response structure


resp.session_arn #=> String
resp.session_id #=> String
resp.namespace #=> String, one of "Custom"
resp.data #=> Array
resp.data[0].key #=> String
resp.data[0].value.string_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :session_id (required, String) —

    The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :namespace (String) —

    The namespace into which the session data is stored. Supported namespaces are: Custom

  • :data (required, Array<Types::RuntimeSessionData>) —

    The data stored on the Amazon Q in Connect Session.

Returns:

See Also:



7786
7787
7788
7789
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/client.rb', line 7786

def update_session_data(params = {}, options = {})
  req = build_request(:update_session_data, params)
  req.send_request(options)
end