Client

connectwisdomservice

R Documentation

Amazon Connect Wisdom Service¶

Description¶

Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across connected repositories from within their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a knowledge base, for example, or manage content by uploading custom files.

Usage¶

connectwisdomservice(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- connectwisdomservice(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

create_assistant: Creates an Amazon Connect Wisdom assistant
create_assistant_association: Creates an association between an Amazon Connect Wisdom assistant and another resource
create_content: Creates Wisdom content
create_knowledge_base: Creates a knowledge base
create_quick_response: Creates a Wisdom quick response
create_session: Creates a session
delete_assistant: Deletes an assistant
delete_assistant_association: Deletes an assistant association
delete_content: Deletes the content
delete_import_job: Deletes the quick response import job
delete_knowledge_base: Deletes the knowledge base
delete_quick_response: Deletes a quick response
get_assistant: Retrieves information about an assistant
get_assistant_association: Retrieves information about an assistant association
get_content: Retrieves content, including a pre-signed URL to download the content
get_content_summary: Retrieves summary information about the content
get_import_job: Retrieves the started import job
get_knowledge_base: Retrieves information about the knowledge base
get_quick_response: Retrieves the quick response
get_recommendations: Retrieves recommendations for the specified session
get_session: Retrieves information for a specified session
list_assistant_associations: Lists information about assistant associations
list_assistants: Lists information about assistants
list_contents: Lists the content
list_import_jobs: Lists information about import jobs
list_knowledge_bases: Lists the knowledge bases
list_quick_responses: Lists information about quick response
list_tags_for_resource: Lists the tags for the specified resource
notify_recommendations_received: Removes the specified recommendations from the specified assistant's queue of newly available recommendations
query_assistant: Performs a manual search against the specified assistant
remove_knowledge_base_template_uri: Removes a URI template from a knowledge base
search_content: Searches for content in a specified knowledge base
search_quick_responses: Searches existing Wisdom quick responses in a Wisdom knowledge base
search_sessions: Searches for sessions
start_content_upload: Get a URL to upload content to a knowledge base
start_import_job: Start an asynchronous job to import Wisdom resources from an uploaded source file
tag_resource: Adds the specified tags to the specified resource
untag_resource: Removes the specified tags from the specified resource
update_content: Updates information about the content
update_knowledge_base_template_uri: Updates the template URI of a knowledge base
update_quick_response: Updates an existing Wisdom quick response

Examples¶

## Not run: 
svc <- connectwisdomservice()
svc$create_assistant(
  Foo = 123
)

## End(Not run)