Class: Aws::ConnectWisdomService::Client

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

Overview

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

client = Aws::ConnectWisdomService::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 Aws::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):

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

    Your AWS credentials. This can be an 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, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.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::InstanceProfileCredentails 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)
  • :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.

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

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

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

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

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

  • :secret_access_key (String)
  • :session_token (String)
  • :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 Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

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

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an 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::ConnectWisdomService::EndpointProvider) —

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

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

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

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

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

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

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



365
366
367
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 365

def initialize(*args)
  super
end

Instance Method Details

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

Creates an Amazon Connect Wisdom assistant.

Examples:

Request syntax with placeholder values


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

Response structure


resp.assistant.assistant_arn #=> String
resp.assistant.assistant_id #=> String
resp.assistant.description #=> String
resp.assistant.name #=> String
resp.assistant.server_side_encryption_configuration.kms_key_id #=> String
resp.assistant.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.assistant.tags #=> Hash
resp.assistant.tags["TagKey"] #=> String
resp.assistant.type #=> String, one of "AGENT"

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.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    The description of the assistant.

  • :name (required, String) —

    The name of the assistant.

  • :server_side_encryption_configuration (Types::ServerSideEncryptionConfiguration) —

    The KMS key used for encryption.

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

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

  • :type (required, String) —

    The type of assistant.

Returns:

See Also:



430
431
432
433
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 430

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 Connect Wisdom 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: { # required
    knowledge_base_id: "Uuid",
  },
  association_type: "KNOWLEDGE_BASE", # required, accepts KNOWLEDGE_BASE
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.assistant_association.assistant_arn #=> String
resp.assistant_association.assistant_association_arn #=> String
resp.assistant_association.assistant_association_id #=> String
resp.assistant_association.assistant_id #=> String
resp.assistant_association.association_data.knowledge_base_association.knowledge_base_arn #=> String
resp.assistant_association.association_data.knowledge_base_association.knowledge_base_id #=> String
resp.assistant_association.association_type #=> String, one of "KNOWLEDGE_BASE"
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 Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

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

    The identifier of the associated resource.

  • :association_type (required, String) —

    The type of association.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    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:



493
494
495
496
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 493

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

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

Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.

Examples:

Request syntax with placeholder values


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

Response structure


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

    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. Can be either the ID or the ARN. URLs cannot contain the ARN.

  • :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 Wisdom, you can store an external version identifier as metadata to utilize for determining drift.

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

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

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

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

  • :title (String) —

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

  • :upload_id (required, String) —

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

Returns:

See Also:



594
595
596
597
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 594

def create_content(params = {}, options = {})
  req = build_request(:create_content, 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.

  <p>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:</p> <ol> <li> <p>Call <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_DeleteKnowledgeBase.html">DeleteKnowledgeBase</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html">DeleteDataIntegration</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html">CreateDataIntegration</a> to recreate the DataIntegration or a create different one.</p> </li> <li> <p>Call CreateKnowledgeBase.</p> </li> </ol> </note>

Examples:

Request syntax with placeholder values


resp = client.create_knowledge_base({
  client_token: "NonEmptyString",
  description: "Description",
  knowledge_base_type: "EXTERNAL", # required, accepts EXTERNAL, CUSTOM
  name: "Name", # required
  rendering_configuration: {
    template_uri: "Uri",
  },
  server_side_encryption_configuration: {
    kms_key_id: "NonEmptyString",
  },
  source_configuration: {
    app_integrations: {
      app_integration_arn: "GenericArn", # required
      object_fields: ["NonEmptyString"], # required
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.knowledge_base.description #=> String
resp.knowledge_base.knowledge_base_arn #=> String
resp.knowledge_base.knowledge_base_id #=> String
resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM"
resp.knowledge_base.last_content_modification_time #=> Time
resp.knowledge_base.name #=> String
resp.knowledge_base.rendering_configuration.template_uri #=> String
resp.knowledge_base.server_side_encryption_configuration.kms_key_id #=> 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.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.knowledge_base.tags #=> Hash
resp.knowledge_base.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.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    The description.

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

  • :name (required, String) —

    The name of the knowledge base.

  • :rendering_configuration (Types::RenderingConfiguration) —

    Information about how to render the content.

  • :server_side_encryption_configuration (Types::ServerSideEncryptionConfiguration) —

    The KMS key used for encryption.

  • :source_configuration (Types::SourceConfiguration) —

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

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

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

Returns:

See Also:



693
694
695
696
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 693

def create_knowledge_base(params = {}, options = {})
  req = build_request(:create_knowledge_base, 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 Wisdom session for each contact on which Wisdom is enabled.

Examples:

Request syntax with placeholder values


resp = client.create_session({
  assistant_id: "UuidOrArn", # required
  client_token: "ClientToken",
  description: "Description",
  name: "Name", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.session.description #=> String
resp.session.name #=> String
resp.session.session_arn #=> String
resp.session.session_id #=> String
resp.session.tags #=> Hash
resp.session.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    The description.

  • :name (required, String) —

    The name of the session.

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

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

Returns:

See Also:



751
752
753
754
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 751

def create_session(params = {}, options = {})
  req = build_request(:create_session, 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 Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



774
775
776
777
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 774

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 Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



802
803
804
805
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 802

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({
  content_id: "UuidOrArn", # required
  knowledge_base_id: "UuidOrArn", # required
})

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:

  • (Struct) —

    Returns an empty response.

See Also:



830
831
832
833
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 830

def delete_content(params = {}, options = {})
  req = build_request(:delete_content, 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:



869
870
871
872
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 869

def delete_knowledge_base(params = {}, options = {})
  req = build_request(:delete_knowledge_base, 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_arn #=> String
resp.assistant.assistant_id #=> String
resp.assistant.description #=> String
resp.assistant.name #=> String
resp.assistant.server_side_encryption_configuration.kms_key_id #=> String
resp.assistant.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.assistant.tags #=> Hash
resp.assistant.tags["TagKey"] #=> String
resp.assistant.type #=> String, one of "AGENT"

Parameters:

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

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

Returns:

See Also:



906
907
908
909
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 906

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_arn #=> String
resp.assistant_association.assistant_association_arn #=> String
resp.assistant_association.assistant_association_id #=> String
resp.assistant_association.assistant_id #=> String
resp.assistant_association.association_data.knowledge_base_association.knowledge_base_arn #=> String
resp.assistant_association.association_data.knowledge_base_association.knowledge_base_id #=> String
resp.assistant_association.association_type #=> String, one of "KNOWLEDGE_BASE"
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 Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



948
949
950
951
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 948

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.content_type #=> String
resp.content.knowledge_base_arn #=> String
resp.content.knowledge_base_id #=> String
resp.content.link_out_uri #=> String
resp.content.metadata #=> Hash
resp.content.metadata["NonEmptyString"] #=> String
resp.content.name #=> String
resp.content.revision_id #=> String
resp.content.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
resp.content.tags #=> Hash
resp.content.tags["TagKey"] #=> String
resp.content.title #=> 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. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

See Also:



997
998
999
1000
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 997

def get_content(params = {}, options = {})
  req = build_request(:get_content, 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.content_type #=> String
resp.content_summary.knowledge_base_arn #=> String
resp.content_summary.knowledge_base_id #=> String
resp.content_summary.metadata #=> Hash
resp.content_summary.metadata["NonEmptyString"] #=> String
resp.content_summary.name #=> String
resp.content_summary.revision_id #=> 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.tags #=> Hash
resp.content_summary.tags["TagKey"] #=> String
resp.content_summary.title #=> 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:



1043
1044
1045
1046
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1043

def get_content_summary(params = {}, options = {})
  req = build_request(:get_content_summary, 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.description #=> String
resp.knowledge_base.knowledge_base_arn #=> String
resp.knowledge_base.knowledge_base_id #=> String
resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM"
resp.knowledge_base.last_content_modification_time #=> Time
resp.knowledge_base.name #=> String
resp.knowledge_base.rendering_configuration.template_uri #=> String
resp.knowledge_base.server_side_encryption_configuration.kms_key_id #=> 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.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.knowledge_base.tags #=> Hash
resp.knowledge_base.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.

Returns:

See Also:



1085
1086
1087
1088
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1085

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

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

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
  max_results: 1,
  session_id: "UuidOrArn", # required
  wait_time_seconds: 1,
})

Response structure


resp.recommendations #=> Array
resp.recommendations[0].document.content_reference.content_arn #=> String
resp.recommendations[0].document.content_reference.content_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.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].document.excerpt.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.title.text #=> String
resp.recommendations[0].recommendation_id #=> String
resp.recommendations[0].relevance_level #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.recommendations[0].relevance_score #=> Float
resp.recommendations[0].type #=> String, one of "KNOWLEDGE_CONTENT"
resp.triggers #=> Array
resp.triggers[0].data.query.text #=> String
resp.triggers[0].id #=> String
resp.triggers[0].recommendation_ids #=> Array
resp.triggers[0].recommendation_ids[0] #=> String
resp.triggers[0].source #=> String, one of "ISSUE_DETECTION", "RULE_EVALUATION", "OTHER"
resp.triggers[0].type #=> String, one of "QUERY"

Parameters:

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

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Wisdom assistant. 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.

  • :session_id (required, String) —

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

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

Returns:

See Also:



1166
1167
1168
1169
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1166

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.description #=> String
resp.session.name #=> String
resp.session.session_arn #=> String
resp.session.session_id #=> String
resp.session.tags #=> Hash
resp.session.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Wisdom 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:



1205
1206
1207
1208
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1205

def get_session(params = {}, options = {})
  req = build_request(:get_session, 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({
  assistant_id: "UuidOrArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.assistant_association_summaries #=> Array
resp.assistant_association_summaries[0].assistant_arn #=> String
resp.assistant_association_summaries[0].assistant_association_arn #=> String
resp.assistant_association_summaries[0].assistant_association_id #=> String
resp.assistant_association_summaries[0].assistant_id #=> String
resp.assistant_association_summaries[0].association_data.knowledge_base_association.knowledge_base_arn #=> String
resp.assistant_association_summaries[0].association_data.knowledge_base_association.knowledge_base_id #=> String
resp.assistant_association_summaries[0].association_type #=> String, one of "KNOWLEDGE_BASE"
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):

  • :assistant_id (required, String) —

    The identifier of the Wisdom assistant. 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.

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

Returns:

See Also:



1257
1258
1259
1260
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1257

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({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return per page.

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

Returns:

See Also:



1304
1305
1306
1307
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1304

def list_assistants(params = {}, options = {})
  req = build_request(:list_assistants, 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({
  knowledge_base_id: "UuidOrArn", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.content_summaries #=> Array
resp.content_summaries[0].content_arn #=> String
resp.content_summaries[0].content_id #=> String
resp.content_summaries[0].content_type #=> String
resp.content_summaries[0].knowledge_base_arn #=> String
resp.content_summaries[0].knowledge_base_id #=> String
resp.content_summaries[0].metadata #=> Hash
resp.content_summaries[0].metadata["NonEmptyString"] #=> String
resp.content_summaries[0].name #=> String
resp.content_summaries[0].revision_id #=> 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].tags #=> Hash
resp.content_summaries[0].tags["TagKey"] #=> String
resp.content_summaries[0].title #=> 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.

  • :max_results (Integer) —

    The maximum number of results to return per page.

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

Returns:

See Also:



1360
1361
1362
1363
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1360

def list_contents(params = {}, options = {})
  req = build_request(:list_contents, 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({
  max_results: 1,
  next_token: "NonEmptyString",
})

Response structure


resp.knowledge_base_summaries #=> Array
resp.knowledge_base_summaries[0].description #=> String
resp.knowledge_base_summaries[0].knowledge_base_arn #=> String
resp.knowledge_base_summaries[0].knowledge_base_id #=> String
resp.knowledge_base_summaries[0].knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM"
resp.knowledge_base_summaries[0].name #=> 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].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].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
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):

  • :max_results (Integer) —

    The maximum number of results to return per page.

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

Returns:

See Also:



1411
1412
1413
1414
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1411

def list_knowledge_bases(params = {}, options = {})
  req = build_request(:list_knowledge_bases, 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:



1440
1441
1442
1443
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1440

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
  recommendation_ids: ["String"], # required
  session_id: "UuidOrArn", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

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

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

    The identifiers of the recommendations.

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



1490
1491
1492
1493
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1490

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

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

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
  max_results: 1,
  next_token: "NextToken",
  query_text: "QueryText", # required
})

Response structure


resp.next_token #=> String
resp.results #=> Array
resp.results[0].document.content_reference.content_arn #=> String
resp.results[0].document.content_reference.content_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.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].document.excerpt.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.title.text #=> String
resp.results[0].relevance_score #=> Float
resp.results[0].result_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Wisdom assistant. 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.

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

  • :query_text (required, String) —

    The text to search for.

Returns:

See Also:



1556
1557
1558
1559
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1556

def query_assistant(params = {}, options = {})
  req = build_request(:query_assistant, 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:



1579
1580
1581
1582
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1579

def remove_knowledge_base_template_uri(params = {}, options = {})
  req = build_request(:remove_knowledge_base_template_uri, 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({
  knowledge_base_id: "UuidOrArn", # required
  max_results: 1,
  next_token: "NextToken",
  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].content_type #=> String
resp.content_summaries[0].knowledge_base_arn #=> String
resp.content_summaries[0].knowledge_base_id #=> String
resp.content_summaries[0].metadata #=> Hash
resp.content_summaries[0].metadata["NonEmptyString"] #=> String
resp.content_summaries[0].name #=> String
resp.content_summaries[0].revision_id #=> 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].tags #=> Hash
resp.content_summaries[0].tags["TagKey"] #=> String
resp.content_summaries[0].title #=> 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.

  • :max_results (Integer) —

    The maximum number of results to return per page.

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

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

    The search expression to filter results.

Returns:

See Also:



1648
1649
1650
1651
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1648

def search_content(params = {}, options = {})
  req = build_request(:search_content, 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({
  assistant_id: "UuidOrArn", # required
  max_results: 1,
  next_token: "NextToken",
  search_expression: { # required
    filters: [ # required
      {
        field: "NAME", # required, accepts NAME
        operator: "EQUALS", # required, accepts EQUALS
        value: "NonEmptyString", # required
      },
    ],
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :assistant_id (required, String) —

    The identifier of the Wisdom assistant. 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.

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

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

    The search expression to filter results.

Returns:

See Also:



1707
1708
1709
1710
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1707

def search_sessions(params = {}, options = {})
  req = build_request(:search_sessions, 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({
  content_type: "ContentType", # required
  knowledge_base_id: "UuidOrArn", # required
})

Response structure


resp.headers_to_include #=> Hash
resp.headers_to_include["NonEmptyString"] #=> String
resp.upload_id #=> String
resp.url #=> String
resp.url_expiry #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :content_type (required, String) —

    The type of content to upload.

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



1757
1758
1759
1760
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1757

def start_content_upload(params = {}, options = {})
  req = build_request(:start_content_upload, 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:



1785
1786
1787
1788
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1785

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:



1811
1812
1813
1814
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1811

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, 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({
  content_id: "UuidOrArn", # required
  knowledge_base_id: "UuidOrArn", # required
  metadata: {
    "NonEmptyString" => "NonEmptyString",
  },
  override_link_out_uri: "Uri",
  remove_override_link_out_uri: false,
  revision_id: "NonEmptyString",
  title: "ContentTitle",
  upload_id: "UploadId",
})

Response structure


resp.content.content_arn #=> String
resp.content.content_id #=> String
resp.content.content_type #=> String
resp.content.knowledge_base_arn #=> String
resp.content.knowledge_base_id #=> String
resp.content.link_out_uri #=> String
resp.content.metadata #=> Hash
resp.content.metadata["NonEmptyString"] #=> String
resp.content.name #=> String
resp.content.revision_id #=> String
resp.content.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED", "UPDATE_FAILED"
resp.content.tags #=> Hash
resp.content.tags["TagKey"] #=> String
resp.content.title #=> 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. Can be either the ID or the ARN

  • :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 Wisdom, you can store an external version identifier as metadata to utilize for determining drift.

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

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

  • :upload_id (String) —

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

Returns:

See Also:



1900
1901
1902
1903
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1900

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 Wisdom 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.description #=> String
resp.knowledge_base.knowledge_base_arn #=> String
resp.knowledge_base.knowledge_base_id #=> String
resp.knowledge_base.knowledge_base_type #=> String, one of "EXTERNAL", "CUSTOM"
resp.knowledge_base.last_content_modification_time #=> Time
resp.knowledge_base.name #=> String
resp.knowledge_base.rendering_configuration.template_uri #=> String
resp.knowledge_base.server_side_encryption_configuration.kms_key_id #=> 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.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_FAILED", "ACTIVE", "DELETE_IN_PROGRESS", "DELETE_FAILED", "DELETED"
resp.knowledge_base.tags #=> Hash
resp.knowledge_base.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.

  • :template_uri (required, String) —

    The template URI to update.

Returns:

See Also:



1951
1952
1953
1954
 
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1951

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