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.
409 410 411 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#create_assistant(params = {}) ⇒ Types::CreateAssistantResponse
Creates an Amazon Connect Wisdom assistant.
497 498 499 500 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 497 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.
566 567 568 569 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 566 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.
675 676 677 678 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 675 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.
806 807 808 809 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 806 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.
931 932 933 934 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 931 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.
996 997 998 999 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 996 def create_session(params = {}, = {}) req = build_request(:create_session, params) req.send_request() end |
#delete_assistant(params = {}) ⇒ Struct
Deletes an assistant.
1019 1020 1021 1022 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1019 def delete_assistant(params = {}, = {}) req = build_request(:delete_assistant, params) req.send_request() end |
#delete_assistant_association(params = {}) ⇒ Struct
Deletes an assistant association.
1047 1048 1049 1050 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1047 def delete_assistant_association(params = {}, = {}) req = build_request(:delete_assistant_association, params) req.send_request() end |
#delete_content(params = {}) ⇒ Struct
Deletes the content.
1077 1078 1079 1080 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1077 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.
1105 1106 1107 1108 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1105 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.
1144 1145 1146 1147 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1144 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.
1173 1174 1175 1176 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1173 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.
1211 1212 1213 1214 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1211 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.
1253 1254 1255 1256 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1253 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.
1304 1305 1306 1307 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1304 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.
1352 1353 1354 1355 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1352 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.
1398 1399 1400 1401 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1398 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.
1442 1443 1444 1445 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1442 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.
1497 1498 1499 1500 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1497 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.
1578 1579 1580 1581 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1578 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.
1618 1619 1620 1621 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1618 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.
1670 1671 1672 1673 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1670 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.
1718 1719 1720 1721 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1718 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.
1776 1777 1778 1779 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1776 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.
1833 1834 1835 1836 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1833 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.
1884 1885 1886 1887 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1884 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.
1945 1946 1947 1948 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1945 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.
1974 1975 1976 1977 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 1974 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.
2024 2025 2026 2027 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2024 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.
2090 2091 2092 2093 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2090 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.
2115 2116 2117 2118 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2115 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.
2186 2187 2188 2189 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2186 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.
2294 2295 2296 2297 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2294 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.
2353 2354 2355 2356 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2353 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.
2410 2411 2412 2413 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2410 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.
^
2517 2518 2519 2520 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2517 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.
2545 2546 2547 2548 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2545 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.
2571 2572 2573 2574 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2571 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_content(params = {}) ⇒ Types::UpdateContentResponse
Updates information about the content.
2662 2663 2664 2665 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2662 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
.
2715 2716 2717 2718 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2715 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.
2836 2837 2838 2839 |
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/client.rb', line 2836 def update_quick_response(params = {}, = {}) req = build_request(:update_quick_response, params) req.send_request() end |