connectwisdomservice function

Amazon Connect Wisdom Service

Amazon Connect Wisdom Service

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.

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.

Returns

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_assistantCreates an Amazon Connect Wisdom assistant
create_assistant_associationCreates an association between an Amazon Connect Wisdom assistant and another resource
create_contentCreates Wisdom content
create_knowledge_baseCreates a knowledge base
create_quick_responseCreates a Wisdom quick response
create_sessionCreates a session
delete_assistantDeletes an assistant
delete_assistant_associationDeletes an assistant association
delete_contentDeletes the content
delete_import_jobDeletes the quick response import job
delete_knowledge_baseDeletes the knowledge base
delete_quick_responseDeletes a quick response
get_assistantRetrieves information about an assistant
get_assistant_associationRetrieves information about an assistant association
get_contentRetrieves content, including a pre-signed URL to download the content
get_content_summaryRetrieves summary information about the content
get_import_jobRetrieves the started import job
get_knowledge_baseRetrieves information about the knowledge base
get_quick_responseRetrieves the quick response
get_recommendationsRetrieves recommendations for the specified session
get_sessionRetrieves information for a specified session
list_assistant_associationsLists information about assistant associations
list_assistantsLists information about assistants
list_contentsLists the content
list_import_jobsLists information about import jobs
list_knowledge_basesLists the knowledge bases
list_quick_responsesLists information about quick response
list_tags_for_resourceLists the tags for the specified resource
notify_recommendations_receivedRemoves the specified recommendations from the specified assistant's queue of newly available recommendations
query_assistantPerforms a manual search against the specified assistant
remove_knowledge_base_template_uriRemoves a URI template from a knowledge base
search_contentSearches for content in a specified knowledge base
search_quick_responsesSearches existing Wisdom quick responses in a Wisdom knowledge base
search_sessionsSearches for sessions
start_content_uploadGet a URL to upload content to a knowledge base
start_import_jobStart an asynchronous job to import Wisdom resources from an uploaded source file
tag_resourceAdds the specified tags to the specified resource
untag_resourceRemoves the specified tags from the specified resource
update_contentUpdates information about the content
update_knowledge_base_template_uriUpdates the template URI of a knowledge base
update_quick_responseUpdates an existing Wisdom quick response

Examples

## Not run: svc <- connectwisdomservice() svc$create_assistant( Foo = 123 ) ## End(Not run)
  • Maintainer: Dyfan Jones
  • License: Apache License (>= 2.0)
  • Last published: 2025-03-17