class Aws::ConnectWisdomService::Client
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See {#initialize} for a full list of supported configuration options.
Attributes
@api private
Public Class Methods
@api private
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1960 def errors_module Errors end
@overload initialize(options)
@param [Hash] options @option options [required, Aws::CredentialProvider] :credentials 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. @option options [required, String] :region 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` @option options [String] :access_key_id @option options [Boolean] :active_endpoint_cache (false) When set to `true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`. @option options [Boolean] :adaptive_retry_wait_to_fill (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. @option options [Boolean] :client_side_monitoring (false) When `true`, client-side metrics will be collected for all API requests from this client. @option options [String] :client_side_monitoring_client_id ("") Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string. @option options [String] :client_side_monitoring_host ("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. @option options [Integer] :client_side_monitoring_port (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. @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher. @option options [Boolean] :convert_params (true) When `true`, an attempt is made to coerce request parameters into the required types. @option options [Boolean] :correct_clock_skew (true) Used only in `standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. @option options [String] :defaults_mode ("legacy") See {Aws::DefaultsModeConfiguration} for a list of the accepted modes and the configuration defaults that are included. @option options [Boolean] :disable_host_prefix_injection (false) Set to true to disable SDK automatically adding host prefix to default service endpoint when available. @option options [String] :endpoint 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. @option options [Integer] :endpoint_cache_max_entries (1000) Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. @option options [Integer] :endpoint_cache_max_threads (10) Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. @option options [Integer] :endpoint_cache_poll_interval (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. @option options [Boolean] :endpoint_discovery (false) When set to `true`, endpoint discovery will be enabled for operations when available. @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) The log formatter. @option options [Symbol] :log_level (:info) The log level to send messages to the `:logger` at. @option options [Logger] :logger The Logger instance to send log messages to. If this option is not set, logging will be disabled. @option options [Integer] :max_attempts (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. @option options [String] :profile ("default") Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. @option options [Proc] :retry_backoff A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the `legacy` retry mode. @option options [Float] :retry_base_delay (0.3) The base delay in seconds used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [Symbol] :retry_jitter (: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 @option options [Integer] :retry_limit (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. @option options [Integer] :retry_max_delay (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. @option options [String] :retry_mode ("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. @option options [String] :secret_access_key @option options [String] :session_token @option options [Boolean] :stub_responses (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. @option options [Boolean] :use_dualstack_endpoint When set to `true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available. @option options [Boolean] :use_fips_endpoint 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`. @option options [Boolean] :validate_params (true) When `true`, request parameters are validated before sending the request. @option options [URI::HTTP,String] :http_proxy A proxy to send requests through. Formatted like 'http://proxy.com:123'. @option options [Float] :http_open_timeout (15) The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`. @option options [Float] :http_read_timeout (60) The default number of seconds to wait for response data. This value can safely be set per-request on the session. @option options [Float] :http_idle_timeout (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. @option options [Float] :http_continue_timeout (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. @option options [Float] :ssl_timeout (nil) Sets the SSL timeout in seconds. @option options [Boolean] :http_wire_trace (false) When `true`, HTTP debug output will be sent to the `:logger`. @option options [Boolean] :ssl_verify_peer (true) When `true`, SSL peer certificates are verified when establishing a connection. @option options [String] :ssl_ca_bundle 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. @option options [String] :ssl_ca_directory 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.
# File lib/aws-sdk-connectwisdomservice/client.rb, line 348 def initialize(*args) super end
Public Instance Methods
@param params ({}) @api private
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1935 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-connectwisdomservice' context[:gem_version] = '1.6.0' Seahorse::Client::Request.new(handlers, context) end
Creates an Amazon Connect Wisdom assistant.
@option params [String] :client_token
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.**
@option params [String] :description
The description of the assistant.
@option params [required, String] :name
The name of the assistant.
@option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
The KMS key used for encryption.
@option params [Hash<String,String>] :tags
The tags used to organize, track, or control access for this resource.
@option params [required, String] :type
The type of assistant.
@return [Types::CreateAssistantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateAssistantResponse#assistant #assistant} => Types::AssistantData
@example 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 })
@example 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"
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateAssistant AWS API Documentation
@overload create_assistant
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 413 def create_assistant(params = {}, options = {}) req = build_request(:create_assistant, params) req.send_request(options) end
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.
@option params [required, String] :assistant_id
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [required, Types::AssistantAssociationInputData
] :association
The identifier of the associated resource.
@option params [required, String] :association_type
The type of association.
@option params [String] :client_token
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.**
@option params [Hash<String,String>] :tags
The tags used to organize, track, or control access for this resource.
@return [Types::CreateAssistantAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateAssistantAssociationResponse#assistant_association #assistant_association} => Types::AssistantAssociationData
@example 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", }, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateAssistantAssociation AWS API Documentation
@overload create_assistant_association
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 476 def create_assistant_association(params = {}, options = {}) req = build_request(:create_assistant_association, params) req.send_request(options) end
Creates Wisdom content. Before to calling this API, use
- StartContentUpload][1
-
to upload an asset.
[1]: docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
@option params [String] :client_token
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.**
@option params [required, String] :knowledge_base_id
The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [Hash<String,String>] :metadata
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.
@option params [required, String] :name
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][1] API. [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_SearchContent.html
@option params [String] :override_link_out_uri
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.
@option params [Hash<String,String>] :tags
The tags used to organize, track, or control access for this resource.
@option params [String] :title
The title of the content. If not set, the title is equal to the name.
@option params [required, String] :upload_id
A pointer to the uploaded asset. This value is returned by [StartContentUpload][1]. [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
@return [Types::CreateContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateContentResponse#content #content} => Types::ContentData
@example 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: "NonEmptyString", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateContent AWS API Documentation
@overload create_content
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 577 def create_content(params = {}, options = {}) req = build_request(:create_content, params) req.send_request(options) end
Creates a knowledge base.
<note markdown=“1”> 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> </note>
[1]: docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html
@option params [String] :client_token
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.**
@option params [String] :description
The description.
@option params [required, String] :knowledge_base_type
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.
@option params [required, String] :name
The name of the knowledge base.
@option params [Types::RenderingConfiguration] :rendering_configuration
Information about how to render the content.
@option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
The KMS key used for encryption.
@option params [Types::SourceConfiguration] :source_configuration
The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
@option params [Hash<String,String>] :tags
The tags used to organize, track, or control access for this resource.
@return [Types::CreateKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateKnowledgeBaseResponse#knowledge_base #knowledge_base} => Types::KnowledgeBaseData
@example 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", }, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateKnowledgeBase AWS API Documentation
@overload create_knowledge_base
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 676 def create_knowledge_base(params = {}, options = {}) req = build_request(:create_knowledge_base, params) req.send_request(options) end
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.
@option params [required, String] :assistant_id
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [String] :client_token
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.**
@option params [String] :description
The description.
@option params [required, String] :name
The name of the session.
@option params [Hash<String,String>] :tags
The tags used to organize, track, or control access for this resource.
@return [Types::CreateSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateSessionResponse#session #session} => Types::SessionData
@example Request syntax with placeholder values
resp = client.create_session({ assistant_id: "UuidOrArn", # required client_token: "ClientToken", description: "Description", name: "Name", # required tags: { "TagKey" => "TagValue", }, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/CreateSession AWS API Documentation
@overload create_session
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 734 def create_session(params = {}, options = {}) req = build_request(:create_session, params) req.send_request(options) end
Deletes an assistant.
@option params [required, String] :assistant_id
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_assistant({ assistant_id: "UuidOrArn", # required })
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteAssistant AWS API Documentation
@overload delete_assistant
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 757 def delete_assistant(params = {}, options = {}) req = build_request(:delete_assistant, params) req.send_request(options) end
Deletes an assistant association.
@option params [required, String] :assistant_association_id
The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [required, String] :assistant_id
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_assistant_association({ assistant_association_id: "UuidOrArn", # required assistant_id: "UuidOrArn", # required })
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteAssistantAssociation AWS API Documentation
@overload delete_assistant_association
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 785 def delete_assistant_association(params = {}, options = {}) req = build_request(:delete_assistant_association, params) req.send_request(options) end
Deletes the content.
@option params [required, String] :content_id
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [required, String] :knowledge_base_id
The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_content({ content_id: "UuidOrArn", # required knowledge_base_id: "UuidOrArn", # required })
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteContent AWS API Documentation
@overload delete_content
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 813 def delete_content(params = {}, options = {}) req = build_request(:delete_content, params) req.send_request(options) end
Deletes the knowledge base.
<note markdown=“1”> 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][2
-
and [CreateDataIntegration] in the
*Amazon AppIntegrations API Reference*.
</note>
[1]: docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html [2]: docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html [3]: docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html
@option params [required, String] :knowledge_base_id
The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.delete_knowledge_base({ knowledge_base_id: "UuidOrArn", # required })
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/DeleteKnowledgeBase AWS API Documentation
@overload delete_knowledge_base
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 852 def delete_knowledge_base(params = {}, options = {}) req = build_request(:delete_knowledge_base, params) req.send_request(options) end
Retrieves information about an assistant.
@option params [required, String] :assistant_id
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
@return [Types::GetAssistantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetAssistantResponse#assistant #assistant} => Types::AssistantData
@example Request syntax with placeholder values
resp = client.get_assistant({ assistant_id: "UuidOrArn", # required })
@example 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"
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetAssistant AWS API Documentation
@overload get_assistant
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 889 def get_assistant(params = {}, options = {}) req = build_request(:get_assistant, params) req.send_request(options) end
Retrieves information about an assistant association.
@option params [required, String] :assistant_association_id
The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [required, String] :assistant_id
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
@return [Types::GetAssistantAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetAssistantAssociationResponse#assistant_association #assistant_association} => Types::AssistantAssociationData
@example Request syntax with placeholder values
resp = client.get_assistant_association({ assistant_association_id: "UuidOrArn", # required assistant_id: "UuidOrArn", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetAssistantAssociation AWS API Documentation
@overload get_assistant_association
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 931 def get_assistant_association(params = {}, options = {}) req = build_request(:get_assistant_association, params) req.send_request(options) end
Retrieves content, including a pre-signed URL to download the content.
@option params [required, String] :content_id
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [required, String] :knowledge_base_id
The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
@return [Types::GetContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetContentResponse#content #content} => Types::ContentData
@example Request syntax with placeholder values
resp = client.get_content({ content_id: "UuidOrArn", # required knowledge_base_id: "UuidOrArn", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetContent AWS API Documentation
@overload get_content
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 980 def get_content(params = {}, options = {}) req = build_request(:get_content, params) req.send_request(options) end
Retrieves summary information about the content.
@option params [required, String] :content_id
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [required, String] :knowledge_base_id
The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
@return [Types::GetContentSummaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetContentSummaryResponse#content_summary #content_summary} => Types::ContentSummary
@example Request syntax with placeholder values
resp = client.get_content_summary({ content_id: "UuidOrArn", # required knowledge_base_id: "UuidOrArn", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetContentSummary AWS API Documentation
@overload get_content_summary
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1026 def get_content_summary(params = {}, options = {}) req = build_request(:get_content_summary, params) req.send_request(options) end
Retrieves information about the knowledge base.
@option params [required, String] :knowledge_base_id
The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
@return [Types::GetKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetKnowledgeBaseResponse#knowledge_base #knowledge_base} => Types::KnowledgeBaseData
@example Request syntax with placeholder values
resp = client.get_knowledge_base({ knowledge_base_id: "UuidOrArn", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetKnowledgeBase AWS API Documentation
@overload get_knowledge_base
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1068 def get_knowledge_base(params = {}, options = {}) req = build_request(:get_knowledge_base, params) req.send_request(options) end
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].
[1]: docs.aws.amazon.com/wisdom/latest/APIReference/API_NotifyRecommendationsReceived.html [2]: docs.aws.amazon.com/wisdom/latest/APIReference/API_QueryAssistant.html
@option params [required, String] :assistant_id
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [required, String] :session_id
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [Integer] :wait_time_seconds
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.
@return [Types::GetRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetRecommendationsResponse#recommendations #recommendations} => Array<Types::RecommendationData>
@example Request syntax with placeholder values
resp = client.get_recommendations({ assistant_id: "UuidOrArn", # required max_results: 1, session_id: "UuidOrArn", # required wait_time_seconds: 1, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetRecommendations AWS API Documentation
@overload get_recommendations
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1140 def get_recommendations(params = {}, options = {}) req = build_request(:get_recommendations, params) req.send_request(options) end
Retrieves information for a specified session.
@option params [required, String] :assistant_id
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [required, String] :session_id
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
@return [Types::GetSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetSessionResponse#session #session} => Types::SessionData
@example Request syntax with placeholder values
resp = client.get_session({ assistant_id: "UuidOrArn", # required session_id: "UuidOrArn", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/GetSession AWS API Documentation
@overload get_session
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1179 def get_session(params = {}, options = {}) req = build_request(:get_session, params) req.send_request(options) end
Lists information about assistant associations.
@option params [required, String] :assistant_id
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [String] :next_token
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.
@return [Types::ListAssistantAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListAssistantAssociationsResponse#assistant_association_summaries #assistant_association_summaries} => Array<Types::AssistantAssociationSummary> * {Types::ListAssistantAssociationsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_assistant_associations({ assistant_id: "UuidOrArn", # required max_results: 1, next_token: "NextToken", })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListAssistantAssociations AWS API Documentation
@overload list_assistant_associations
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1231 def list_assistant_associations(params = {}, options = {}) req = build_request(:list_assistant_associations, params) req.send_request(options) end
Lists information about assistants.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [String] :next_token
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.
@return [Types::ListAssistantsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListAssistantsResponse#assistant_summaries #assistant_summaries} => Array<Types::AssistantSummary> * {Types::ListAssistantsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_assistants({ max_results: 1, next_token: "NextToken", })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListAssistants AWS API Documentation
@overload list_assistants
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1278 def list_assistants(params = {}, options = {}) req = build_request(:list_assistants, params) req.send_request(options) end
Lists the content.
@option params [required, String] :knowledge_base_id
The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [String] :next_token
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.
@return [Types::ListContentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListContentsResponse#content_summaries #content_summaries} => Array<Types::ContentSummary> * {Types::ListContentsResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_contents({ knowledge_base_id: "UuidOrArn", # required max_results: 1, next_token: "NextToken", })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListContents AWS API Documentation
@overload list_contents
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1334 def list_contents(params = {}, options = {}) req = build_request(:list_contents, params) req.send_request(options) end
Lists the knowledge bases.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [String] :next_token
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.
@return [Types::ListKnowledgeBasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListKnowledgeBasesResponse#knowledge_base_summaries #knowledge_base_summaries} => Array<Types::KnowledgeBaseSummary> * {Types::ListKnowledgeBasesResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_knowledge_bases({ max_results: 1, next_token: "NonEmptyString", })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/ListKnowledgeBases AWS API Documentation
@overload list_knowledge_bases
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1385 def list_knowledge_bases(params = {}, options = {}) req = build_request(:list_knowledge_bases, params) req.send_request(options) end
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.
[1]: docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html
@option params [required, String] :assistant_id
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [required, Array<String>] :recommendation_ids
The identifiers of the recommendations.
@option params [required, String] :session_id
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
@return [Types::NotifyRecommendationsReceivedResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::NotifyRecommendationsReceivedResponse#errors #errors} => Array<Types::NotifyRecommendationsReceivedError> * {Types::NotifyRecommendationsReceivedResponse#recommendation_ids #recommendation_ids} => Array<String>
@example Request syntax with placeholder values
resp = client.notify_recommendations_received({ assistant_id: "UuidOrArn", # required recommendation_ids: ["String"], # required session_id: "UuidOrArn", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/NotifyRecommendationsReceived AWS API Documentation
@overload notify_recommendations_received
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1464 def notify_recommendations_received(params = {}, options = {}) req = build_request(:notify_recommendations_received, params) req.send_request(options) end
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use [GetRecommendations].
[1]: docs.aws.amazon.com/wisdom/latest/APIReference/API_GetRecommendations.html
@option params [required, String] :assistant_id
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [String] :next_token
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.
@option params [required, String] :query_text
The text to search for.
@return [Types::QueryAssistantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::QueryAssistantResponse#next_token #next_token} => String * {Types::QueryAssistantResponse#results #results} => Array<Types::ResultData>
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.query_assistant({ assistant_id: "UuidOrArn", # required max_results: 1, next_token: "NextToken", query_text: "QueryText", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/QueryAssistant AWS API Documentation
@overload query_assistant
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1530 def query_assistant(params = {}, options = {}) req = build_request(:query_assistant, params) req.send_request(options) end
Removes a URI template from a knowledge base.
@option params [required, String] :knowledge_base_id
The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.remove_knowledge_base_template_uri({ knowledge_base_id: "UuidOrArn", # required })
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/RemoveKnowledgeBaseTemplateUri AWS API Documentation
@overload remove_knowledge_base_template_uri
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1553 def remove_knowledge_base_template_uri(params = {}, options = {}) req = build_request(:remove_knowledge_base_template_uri, params) req.send_request(options) end
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
@option params [required, String] :knowledge_base_id
The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [String] :next_token
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.
@option params [required, Types::SearchExpression
] :search_expression
The search expression to filter results.
@return [Types::SearchContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::SearchContentResponse#content_summaries #content_summaries} => Array<Types::ContentSummary> * {Types::SearchContentResponse#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example 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 }, ], }, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchContent AWS API Documentation
@overload search_content
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1622 def search_content(params = {}, options = {}) req = build_request(:search_content, params) req.send_request(options) end
Searches for sessions.
@option params [required, String] :assistant_id
The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [String] :next_token
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.
@option params [required, Types::SearchExpression
] :search_expression
The search expression to filter results.
@return [Types::SearchSessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::SearchSessionsResponse#next_token #next_token} => String * {Types::SearchSessionsResponse#session_summaries #session_summaries} => Array<Types::SessionSummary>
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example 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 }, ], }, })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/SearchSessions AWS API Documentation
@overload search_sessions
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1681 def search_sessions(params = {}, options = {}) req = build_request(:search_sessions, params) req.send_request(options) end
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.
[1]: docs.aws.amazon.com/wisdom/latest/APIReference/API_CreateContent.html [2]: docs.aws.amazon.com/wisdom/latest/APIReference/API_UpdateContent.html
@option params [required, String] :content_type
The type of content to upload.
@option params [required, String] :knowledge_base_id
The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
@return [Types::StartContentUploadResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::StartContentUploadResponse#headers_to_include #headers_to_include} => Hash<String,String> * {Types::StartContentUploadResponse#upload_id #upload_id} => String * {Types::StartContentUploadResponse#url #url} => String * {Types::StartContentUploadResponse#url_expiry #url_expiry} => Time
@example Request syntax with placeholder values
resp = client.start_content_upload({ content_type: "ContentType", # required knowledge_base_id: "UuidOrArn", # required })
@example Response structure
resp.headers_to_include #=> Hash resp.headers_to_include["NonEmptyString"] #=> String resp.upload_id #=> String resp.url #=> String resp.url_expiry #=> Time
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/StartContentUpload AWS API Documentation
@overload start_content_upload
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1731 def start_content_upload(params = {}, options = {}) req = build_request(:start_content_upload, params) req.send_request(options) end
Adds the specified tags to the specified resource.
@option params [required, String] :resource_arn
The Amazon Resource Name (ARN) of the resource.
@option params [required, Hash<String,String>] :tags
The tags used to organize, track, or control access for this resource.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.tag_resource({ resource_arn: "Arn", # required tags: { # required "TagKey" => "TagValue", }, })
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/TagResource AWS API Documentation
@overload tag_resource
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1759 def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end
Removes the specified tags from the specified resource.
@option params [required, String] :resource_arn
The Amazon Resource Name (ARN) of the resource.
@option params [required, Array<String>] :tag_keys
The tag keys.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.untag_resource({ resource_arn: "Arn", # required tag_keys: ["TagKey"], # required })
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UntagResource AWS API Documentation
@overload untag_resource
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1785 def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end
Updates information about the content.
@option params [required, String] :content_id
The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [required, String] :knowledge_base_id
The the identifier of the knowledge base. Can be either the ID or the ARN
@option params [Hash<String,String>] :metadata
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.
@option params [String] :override_link_out_uri
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.
@option params [Boolean] :remove_override_link_out_uri
Unset the existing `overrideLinkOutUri` if it exists.
@option params [String] :revision_id
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`.
@option params [String] :title
The title of the content.
@option params [String] :upload_id
A pointer to the uploaded asset. This value is returned by [StartContentUpload][1]. [1]: https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html
@return [Types::UpdateContentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::UpdateContentResponse#content #content} => Types::ContentData
@example 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: "NonEmptyString", })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateContent AWS API Documentation
@overload update_content
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1875 def update_content(params = {}, options = {}) req = build_request(:update_content, params) req.send_request(options) end
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 `myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view`.
@option params [required, String] :knowledge_base_id
The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
@option params [required, String] :template_uri
The template URI to update.
@return [Types::UpdateKnowledgeBaseTemplateUriResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::UpdateKnowledgeBaseTemplateUriResponse#knowledge_base #knowledge_base} => Types::KnowledgeBaseData
@example Request syntax with placeholder values
resp = client.update_knowledge_base_template_uri({ knowledge_base_id: "UuidOrArn", # required template_uri: "Uri", # required })
@example 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
@see docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19/UpdateKnowledgeBaseTemplateUri AWS API Documentation
@overload update_knowledge_base_template_uri
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1926 def update_knowledge_base_template_uri(params = {}, options = {}) req = build_request(:update_knowledge_base_template_uri, params) req.send_request(options) end
@api private @deprecated
# File lib/aws-sdk-connectwisdomservice/client.rb, line 1950 def waiter_names [] end