Class: Aws::ConnectWisdomService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ConnectWisdomService::Client
- 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
API Operations collapse
-
#create_assistant(params = {}) ⇒ Types::CreateAssistantResponse
Creates an Amazon Connect Wisdom assistant.
-
#create_assistant_association(params = {}) ⇒ Types::CreateAssistantAssociationResponse
Creates an association between an Amazon Connect Wisdom assistant and another resource.
-
#create_content(params = {}) ⇒ Types::CreateContentResponse
Creates Wisdom content.
-
#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse
Creates a knowledge base.
-
#create_quick_response(params = {}) ⇒ Types::CreateQuickResponseResponse
Creates a Wisdom quick response.
-
#create_session(params = {}) ⇒ Types::CreateSessionResponse
Creates a session.
-
#delete_assistant(params = {}) ⇒ Struct
Deletes an assistant.
-
#delete_assistant_association(params = {}) ⇒ Struct
Deletes an assistant association.
-
#delete_content(params = {}) ⇒ Struct
Deletes the content.
-
#delete_import_job(params = {}) ⇒ Struct
Deletes the quick response import job.
-
#delete_knowledge_base(params = {}) ⇒ Struct
Deletes the knowledge base.
-
#delete_quick_response(params = {}) ⇒ Struct
Deletes a quick response.
-
#get_assistant(params = {}) ⇒ Types::GetAssistantResponse
Retrieves information about an assistant.
-
#get_assistant_association(params = {}) ⇒ Types::GetAssistantAssociationResponse
Retrieves information about an assistant association.
-
#get_content(params = {}) ⇒ Types::GetContentResponse
Retrieves content, including a pre-signed URL to download the content.
-
#get_content_summary(params = {}) ⇒ Types::GetContentSummaryResponse
Retrieves summary information about the content.
-
#get_import_job(params = {}) ⇒ Types::GetImportJobResponse
Retrieves the started import job.
-
#get_knowledge_base(params = {}) ⇒ Types::GetKnowledgeBaseResponse
Retrieves information about the knowledge base.
-
#get_quick_response(params = {}) ⇒ Types::GetQuickResponseResponse
Retrieves the quick response.
-
#get_recommendations(params = {}) ⇒ Types::GetRecommendationsResponse
Retrieves recommendations for the specified session.
-
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves information for a specified session.
-
#list_assistant_associations(params = {}) ⇒ Types::ListAssistantAssociationsResponse
Lists information about assistant associations.
-
#list_assistants(params = {}) ⇒ Types::ListAssistantsResponse
Lists information about assistants.
-
#list_contents(params = {}) ⇒ Types::ListContentsResponse
Lists the content.
-
#list_import_jobs(params = {}) ⇒ Types::ListImportJobsResponse
Lists information about import jobs.
-
#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse
Lists the knowledge bases.
-
#list_quick_responses(params = {}) ⇒ Types::ListQuickResponsesResponse
Lists information about quick response.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
-
#notify_recommendations_received(params = {}) ⇒ Types::NotifyRecommendationsReceivedResponse
Removes the specified recommendations from the specified assistant's queue of newly available recommendations.
-
#query_assistant(params = {}) ⇒ Types::QueryAssistantResponse
Performs a manual search against the specified assistant.
-
#remove_knowledge_base_template_uri(params = {}) ⇒ Struct
Removes a URI template from a knowledge base.
-
#search_content(params = {}) ⇒ Types::SearchContentResponse
Searches for content in a specified knowledge base.
-
#search_quick_responses(params = {}) ⇒ Types::SearchQuickResponsesResponse
Searches existing Wisdom quick responses in a Wisdom knowledge base.
-
#search_sessions(params = {}) ⇒ Types::SearchSessionsResponse
Searches for sessions.
-
#start_content_upload(params = {}) ⇒ Types::StartContentUploadResponse
Get a URL to upload content to a knowledge base.
-
#start_import_job(params = {}) ⇒ Types::StartImportJobResponse
Start an asynchronous job to import Wisdom resources from an uploaded source file.
-
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
-
#update_content(params = {}) ⇒ Types::UpdateContentResponse
Updates information about the content.
-
#update_knowledge_base_template_uri(params = {}) ⇒ Types::UpdateKnowledgeBaseTemplateUriResponse
Updates the template URI of a knowledge base.
-
#update_quick_response(params = {}) ⇒ Types::UpdateQuickResponseResponse
Updates an existing Wisdom quick response.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
440 441 442 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 440 def initialize(*args) super end |
Instance Method Details
#create_assistant(params = {}) ⇒ Types::CreateAssistantResponse
Creates an Amazon Connect Wisdom assistant.
528 529 530 531 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 528 def create_assistant(params = {}, = {}) req = build_request(:create_assistant, params) req.send_request() 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.
597 598 599 600 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 597 def create_assistant_association(params = {}, = {}) req = build_request(:create_assistant_association, params) req.send_request() end |
#create_content(params = {}) ⇒ Types::CreateContentResponse
Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.
706 707 708 709 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 706 def create_content(params = {}, = {}) req = build_request(:create_content, params) req.send_request() end |
#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse
Creates a knowledge base.
InvalidRequestException
error.
For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
Call DeleteKnowledgeBase.
Call DeleteDataIntegration.
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
Call CreateKnowledgeBase.
837 838 839 840 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 837 def create_knowledge_base(params = {}, = {}) req = build_request(:create_knowledge_base, params) req.send_request() end |
#create_quick_response(params = {}) ⇒ Types::CreateQuickResponseResponse
Creates a Wisdom quick response.
962 963 964 965 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 962 def create_quick_response(params = {}, = {}) req = build_request(:create_quick_response, params) req.send_request() 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.
1027 1028 1029 1030 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1027 def create_session(params = {}, = {}) req = build_request(:create_session, params) req.send_request() end |
#delete_assistant(params = {}) ⇒ Struct
Deletes an assistant.
1050 1051 1052 1053 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1050 def delete_assistant(params = {}, = {}) req = build_request(:delete_assistant, params) req.send_request() end |
#delete_assistant_association(params = {}) ⇒ Struct
Deletes an assistant association.
1078 1079 1080 1081 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1078 def delete_assistant_association(params = {}, = {}) req = build_request(:delete_assistant_association, params) req.send_request() end |
#delete_content(params = {}) ⇒ Struct
Deletes the content.
1108 1109 1110 1111 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1108 def delete_content(params = {}, = {}) req = build_request(:delete_content, params) req.send_request() end |
#delete_import_job(params = {}) ⇒ Struct
Deletes the quick response import job.
1136 1137 1138 1139 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1136 def delete_import_job(params = {}, = {}) req = build_request(:delete_import_job, params) req.send_request() end |
#delete_knowledge_base(params = {}) ⇒ Struct
Deletes the knowledge base.
1175 1176 1177 1178 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1175 def delete_knowledge_base(params = {}, = {}) req = build_request(:delete_knowledge_base, params) req.send_request() end |
#delete_quick_response(params = {}) ⇒ Struct
Deletes a quick response.
1204 1205 1206 1207 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1204 def delete_quick_response(params = {}, = {}) req = build_request(:delete_quick_response, params) req.send_request() end |
#get_assistant(params = {}) ⇒ Types::GetAssistantResponse
Retrieves information about an assistant.
1242 1243 1244 1245 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1242 def get_assistant(params = {}, = {}) req = build_request(:get_assistant, params) req.send_request() end |
#get_assistant_association(params = {}) ⇒ Types::GetAssistantAssociationResponse
Retrieves information about an assistant association.
1284 1285 1286 1287 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1284 def get_assistant_association(params = {}, = {}) req = build_request(:get_assistant_association, params) req.send_request() end |
#get_content(params = {}) ⇒ Types::GetContentResponse
Retrieves content, including a pre-signed URL to download the content.
1335 1336 1337 1338 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1335 def get_content(params = {}, = {}) req = build_request(:get_content, params) req.send_request() end |
#get_content_summary(params = {}) ⇒ Types::GetContentSummaryResponse
Retrieves summary information about the content.
1383 1384 1385 1386 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1383 def get_content_summary(params = {}, = {}) req = build_request(:get_content_summary, params) req.send_request() end |
#get_import_job(params = {}) ⇒ Types::GetImportJobResponse
Retrieves the started import job.
1429 1430 1431 1432 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1429 def get_import_job(params = {}, = {}) req = build_request(:get_import_job, params) req.send_request() end |
#get_knowledge_base(params = {}) ⇒ Types::GetKnowledgeBaseResponse
Retrieves information about the knowledge base.
1473 1474 1475 1476 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1473 def get_knowledge_base(params = {}, = {}) req = build_request(:get_knowledge_base, params) req.send_request() end |
#get_quick_response(params = {}) ⇒ Types::GetQuickResponseResponse
Retrieves the quick response.
1528 1529 1530 1531 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1528 def get_quick_response(params = {}, = {}) req = build_request(:get_quick_response, params) req.send_request() 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.
1609 1610 1611 1612 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1609 def get_recommendations(params = {}, = {}) req = build_request(:get_recommendations, params) req.send_request() end |
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves information for a specified session.
1649 1650 1651 1652 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1649 def get_session(params = {}, = {}) req = build_request(:get_session, params) req.send_request() 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.
1701 1702 1703 1704 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1701 def list_assistant_associations(params = {}, = {}) req = build_request(:list_assistant_associations, params) req.send_request() 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.
1749 1750 1751 1752 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1749 def list_assistants(params = {}, = {}) req = build_request(:list_assistants, params) req.send_request() 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.
1807 1808 1809 1810 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1807 def list_contents(params = {}, = {}) req = build_request(:list_contents, params) req.send_request() end |
#list_import_jobs(params = {}) ⇒ Types::ListImportJobsResponse
Lists information about import jobs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1864 1865 1866 1867 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1864 def list_import_jobs(params = {}, = {}) req = build_request(:list_import_jobs, params) req.send_request() 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.
1915 1916 1917 1918 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1915 def list_knowledge_bases(params = {}, = {}) req = build_request(:list_knowledge_bases, params) req.send_request() end |
#list_quick_responses(params = {}) ⇒ Types::ListQuickResponsesResponse
Lists information about quick response.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1976 1977 1978 1979 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1976 def list_quick_responses(params = {}, = {}) req = build_request(:list_quick_responses, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags for the specified resource.
2005 2006 2007 2008 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2005 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() 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.
2055 2056 2057 2058 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2055 def notify_recommendations_received(params = {}, = {}) req = build_request(:notify_recommendations_received, params) req.send_request() 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.
2121 2122 2123 2124 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2121 def query_assistant(params = {}, = {}) req = build_request(:query_assistant, params) req.send_request() end |
#remove_knowledge_base_template_uri(params = {}) ⇒ Struct
Removes a URI template from a knowledge base.
2146 2147 2148 2149 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2146 def remove_knowledge_base_template_uri(params = {}, = {}) req = build_request(:remove_knowledge_base_template_uri, params) req.send_request() 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.
2217 2218 2219 2220 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2217 def search_content(params = {}, = {}) req = build_request(:search_content, params) req.send_request() end |
#search_quick_responses(params = {}) ⇒ Types::SearchQuickResponsesResponse
Searches existing Wisdom quick responses in a Wisdom knowledge base.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2325 2326 2327 2328 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2325 def search_quick_responses(params = {}, = {}) req = build_request(:search_quick_responses, params) req.send_request() 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.
2384 2385 2386 2387 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2384 def search_sessions(params = {}, = {}) req = build_request(:search_sessions, params) req.send_request() 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.
2441 2442 2443 2444 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2441 def start_content_upload(params = {}, = {}) req = build_request(:start_content_upload, params) req.send_request() end |
#start_import_job(params = {}) ⇒ Types::StartImportJobResponse
Start an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.
- For importing Wisdom quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
^
2548 2549 2550 2551 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2548 def start_import_job(params = {}, = {}) req = build_request(:start_import_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds the specified tags to the specified resource.
2576 2577 2578 2579 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2576 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes the specified tags from the specified resource.
2602 2603 2604 2605 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2602 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_content(params = {}) ⇒ Types::UpdateContentResponse
Updates information about the content.
2693 2694 2695 2696 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2693 def update_content(params = {}, = {}) req = build_request(:update_content, params) req.send_request() 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
.
2746 2747 2748 2749 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2746 def update_knowledge_base_template_uri(params = {}, = {}) req = build_request(:update_knowledge_base_template_uri, params) req.send_request() end |
#update_quick_response(params = {}) ⇒ Types::UpdateQuickResponseResponse
Updates an existing Wisdom quick response.
2867 2868 2869 2870 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2867 def update_quick_response(params = {}, = {}) req = build_request(:update_quick_response, params) req.send_request() end |