Class: Aws::Kendra::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Kendra::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb
Overview
An API client for Kendra. To construct a client, you need to configure a :region and :credentials.
client = Aws::Kendra::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
-
#associate_entities_to_experience(params = {}) ⇒ Types::AssociateEntitiesToExperienceResponse
Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience.
-
#associate_personas_to_entities(params = {}) ⇒ Types::AssociatePersonasToEntitiesResponse
Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience.
-
#batch_delete_document(params = {}) ⇒ Types::BatchDeleteDocumentResponse
Removes one or more documents from an index.
-
#batch_delete_featured_results_set(params = {}) ⇒ Types::BatchDeleteFeaturedResultsSetResponse
Removes one or more sets of featured results.
-
#batch_get_document_status(params = {}) ⇒ Types::BatchGetDocumentStatusResponse
Returns the indexing status for one or more documents submitted with the [ BatchPutDocument][1] API.
-
#batch_put_document(params = {}) ⇒ Types::BatchPutDocumentResponse
Adds one or more documents to an index.
-
#clear_query_suggestions(params = {}) ⇒ Struct
Clears existing query suggestions from an index.
-
#create_access_control_configuration(params = {}) ⇒ Types::CreateAccessControlConfigurationResponse
Creates an access configuration for your documents.
-
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Creates a data source connector that you want to use with an Amazon Kendra index.
-
#create_experience(params = {}) ⇒ Types::CreateExperienceResponse
Creates an Amazon Kendra experience such as a search application.
-
#create_faq(params = {}) ⇒ Types::CreateFaqResponse
Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
-
#create_featured_results_set(params = {}) ⇒ Types::CreateFeaturedResultsSetResponse
Creates a set of featured results to display at the top of the search results page.
-
#create_index(params = {}) ⇒ Types::CreateIndexResponse
Creates an Amazon Kendra index.
-
#create_query_suggestions_block_list(params = {}) ⇒ Types::CreateQuerySuggestionsBlockListResponse
Creates a block list to exlcude certain queries from suggestions.
-
#create_thesaurus(params = {}) ⇒ Types::CreateThesaurusResponse
Creates a thesaurus for an index.
-
#delete_access_control_configuration(params = {}) ⇒ Struct
Deletes an access control configuration that you created for your documents in an index.
-
#delete_data_source(params = {}) ⇒ Struct
Deletes an Amazon Kendra data source connector.
-
#delete_experience(params = {}) ⇒ Struct
Deletes your Amazon Kendra experience such as a search application.
-
#delete_faq(params = {}) ⇒ Struct
Removes a FAQ from an index.
-
#delete_index(params = {}) ⇒ Struct
Deletes an Amazon Kendra index.
-
#delete_principal_mapping(params = {}) ⇒ Struct
Deletes a group so that all users that belong to the group can no longer access documents only available to that group.
-
#delete_query_suggestions_block_list(params = {}) ⇒ Struct
Deletes a block list used for query suggestions for an index.
-
#delete_thesaurus(params = {}) ⇒ Struct
Deletes an Amazon Kendra thesaurus.
-
#describe_access_control_configuration(params = {}) ⇒ Types::DescribeAccessControlConfigurationResponse
Gets information about an access control configuration that you created for your documents in an index.
-
#describe_data_source(params = {}) ⇒ Types::DescribeDataSourceResponse
Gets information about an Amazon Kendra data source connector.
-
#describe_experience(params = {}) ⇒ Types::DescribeExperienceResponse
Gets information about your Amazon Kendra experience such as a search application.
-
#describe_faq(params = {}) ⇒ Types::DescribeFaqResponse
Gets information about a FAQ.
-
#describe_featured_results_set(params = {}) ⇒ Types::DescribeFeaturedResultsSetResponse
Gets information about a set of featured results.
-
#describe_index(params = {}) ⇒ Types::DescribeIndexResponse
Gets information about an Amazon Kendra index.
-
#describe_principal_mapping(params = {}) ⇒ Types::DescribePrincipalMappingResponse
Describes the processing of
PUTandDELETEactions for mapping users to their groups. -
#describe_query_suggestions_block_list(params = {}) ⇒ Types::DescribeQuerySuggestionsBlockListResponse
Gets information about a block list used for query suggestions for an index.
-
#describe_query_suggestions_config(params = {}) ⇒ Types::DescribeQuerySuggestionsConfigResponse
Gets information on the settings of query suggestions for an index.
-
#describe_thesaurus(params = {}) ⇒ Types::DescribeThesaurusResponse
Gets information about an Amazon Kendra thesaurus.
-
#disassociate_entities_from_experience(params = {}) ⇒ Types::DisassociateEntitiesFromExperienceResponse
Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience.
-
#disassociate_personas_from_entities(params = {}) ⇒ Types::DisassociatePersonasFromEntitiesResponse
Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience.
-
#get_query_suggestions(params = {}) ⇒ Types::GetQuerySuggestionsResponse
Fetches the queries that are suggested to your users.
-
#get_snapshots(params = {}) ⇒ Types::GetSnapshotsResponse
Retrieves search metrics data.
-
#list_access_control_configurations(params = {}) ⇒ Types::ListAccessControlConfigurationsResponse
Lists one or more access control configurations for an index.
-
#list_data_source_sync_jobs(params = {}) ⇒ Types::ListDataSourceSyncJobsResponse
Gets statistics about synchronizing a data source connector.
-
#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
Lists the data source connectors that you have created.
-
#list_entity_personas(params = {}) ⇒ Types::ListEntityPersonasResponse
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
-
#list_experience_entities(params = {}) ⇒ Types::ListExperienceEntitiesResponse
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience.
-
#list_experiences(params = {}) ⇒ Types::ListExperiencesResponse
Lists one or more Amazon Kendra experiences.
-
#list_faqs(params = {}) ⇒ Types::ListFaqsResponse
Gets a list of FAQs associated with an index.
-
#list_featured_results_sets(params = {}) ⇒ Types::ListFeaturedResultsSetsResponse
Lists all your sets of featured results for a given index.
-
#list_groups_older_than_ordering_id(params = {}) ⇒ Types::ListGroupsOlderThanOrderingIdResponse
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
-
#list_indices(params = {}) ⇒ Types::ListIndicesResponse
Lists the Amazon Kendra indexes that you created.
-
#list_query_suggestions_block_lists(params = {}) ⇒ Types::ListQuerySuggestionsBlockListsResponse
Lists the block lists used for query suggestions for an index.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets a list of tags associated with a resource.
-
#list_thesauri(params = {}) ⇒ Types::ListThesauriResponse
Lists the thesauri for an index.
-
#put_principal_mapping(params = {}) ⇒ Struct
Maps users to their groups so that you only need to provide the user ID when you issue the query.
-
#query(params = {}) ⇒ Types::QueryResult
Searches an index given an input query.
-
#retrieve(params = {}) ⇒ Types::RetrieveResult
Retrieves relevant passages or text excerpts given an input query.
-
#start_data_source_sync_job(params = {}) ⇒ Types::StartDataSourceSyncJobResponse
Starts a synchronization job for a data source connector.
-
#stop_data_source_sync_job(params = {}) ⇒ Struct
Stops a synchronization job that is currently running.
-
#submit_feedback(params = {}) ⇒ Struct
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
-
#tag_resource(params = {}) ⇒ Struct
Adds the specified tag to the specified index, FAQ, data source, or other resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes a tag from an index, FAQ, data source, or other resource.
-
#update_access_control_configuration(params = {}) ⇒ Struct
Updates an access control configuration for your documents in an index.
-
#update_data_source(params = {}) ⇒ Struct
Updates an Amazon Kendra data source connector.
-
#update_experience(params = {}) ⇒ Struct
Updates your Amazon Kendra experience such as a search application.
-
#update_featured_results_set(params = {}) ⇒ Types::UpdateFeaturedResultsSetResponse
Updates a set of featured results.
-
#update_index(params = {}) ⇒ Struct
Updates an Amazon Kendra index.
-
#update_query_suggestions_block_list(params = {}) ⇒ Struct
Updates a block list used for query suggestions for an index.
-
#update_query_suggestions_config(params = {}) ⇒ Struct
Updates the settings of query suggestions for an index.
-
#update_thesaurus(params = {}) ⇒ Struct
Updates a thesaurus for an index.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from 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.
486 487 488 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 486 def initialize(*args) super end |
Instance Method Details
#associate_entities_to_experience(params = {}) ⇒ Types::AssociateEntitiesToExperienceResponse
Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
538 539 540 541 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 538 def associate_entities_to_experience(params = {}, = {}) req = build_request(:associate_entities_to_experience, params) req.send_request() end |
#associate_personas_to_entities(params = {}) ⇒ Types::AssociatePersonasToEntitiesResponse
Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
597 598 599 600 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 597 def associate_personas_to_entities(params = {}, = {}) req = build_request(:associate_personas_to_entities, params) req.send_request() end |
#batch_delete_document(params = {}) ⇒ Types::BatchDeleteDocumentResponse
Removes one or more documents from an index. The documents must have
been added with the BatchPutDocument API.
The documents are deleted asynchronously. You can see the progress of
the deletion by using Amazon Web Services CloudWatch. Any error
messages related to the processing of the batch are sent to your
Amazon Web Services CloudWatch log. You can also use the
BatchGetDocumentStatus API to monitor the progress of deleting your
documents.
Deleting documents from an index using BatchDeleteDocument could
take up to an hour or more, depending on the number of documents you
want to delete.
652 653 654 655 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 652 def batch_delete_document(params = {}, = {}) req = build_request(:batch_delete_document, params) req.send_request() end |
#batch_delete_featured_results_set(params = {}) ⇒ Types::BatchDeleteFeaturedResultsSetResponse
Removes one or more sets of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
690 691 692 693 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 690 def batch_delete_featured_results_set(params = {}, = {}) req = build_request(:batch_delete_featured_results_set, params) req.send_request() end |
#batch_get_document_status(params = {}) ⇒ Types::BatchGetDocumentStatusResponse
Returns the indexing status for one or more documents submitted with the BatchPutDocument API.
When you use the BatchPutDocument API, documents are indexed
asynchronously. You can use the BatchGetDocumentStatus API to get
the current status of a list of documents so that you can determine if
they have been successfully indexed.
You can also use the BatchGetDocumentStatus API to check the status
of the BatchDeleteDocument API. When a document is deleted from
the index, Amazon Kendra returns NOT_FOUND as the status.
769 770 771 772 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 769 def batch_get_document_status(params = {}, = {}) req = build_request(:batch_get_document_status, params) req.send_request() end |
#batch_put_document(params = {}) ⇒ Types::BatchPutDocumentResponse
Adds one or more documents to an index.
The BatchPutDocument API enables you to ingest inline documents or a
set of documents stored in an Amazon S3 bucket. Use this API to ingest
your text and unstructured text into an index, add custom attributes
to the documents, and to attach an access control list to the
documents added to the index.
The documents are indexed asynchronously. You can see the progress of
the batch using Amazon Web Services CloudWatch. Any error messages
related to processing the batch are sent to your Amazon Web Services
CloudWatch log. You can also use the BatchGetDocumentStatus API to
monitor the progress of indexing your documents.
For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
960 961 962 963 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 960 def batch_put_document(params = {}, = {}) req = build_request(:batch_put_document, params) req.send_request() end |
#clear_query_suggestions(params = {}) ⇒ Struct
Clears existing query suggestions from an index.
This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.
ClearQuerySuggestions is currently not supported in the Amazon Web
Services GovCloud (US-West) region.
991 992 993 994 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 991 def clear_query_suggestions(params = {}, = {}) req = build_request(:clear_query_suggestions, params) req.send_request() end |
#create_access_control_configuration(params = {}) ⇒ Types::CreateAccessControlConfigurationResponse
Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.
To apply your access control configuration to certain documents, you
call the BatchPutDocument API with the
AccessControlConfigurationId included in the Document object.
If you use an S3 bucket as a data source, you update the
.metadata.json with the AccessControlConfigurationId and
synchronize your data source. Amazon Kendra currently only supports
access control configuration for S3 data sources and documents indexed
using the BatchPutDocument API.
You can't configure access control using
CreateAccessControlConfiguration for an Amazon Kendra Gen AI
Enterprise Edition index. Amazon Kendra will return a
ValidationException error for a Gen_AI_ENTERPRISE_EDITION index.
1107 1108 1109 1110 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 1107 def create_access_control_configuration(params = {}, = {}) req = build_request(:create_access_control_configuration, params) req.send_request() end |
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Creates a data source connector that you want to use with an Amazon Kendra index.
You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.
CreateDataSource is a synchronous operation. The operation returns
200 if the data source was successfully created. Otherwise, an
exception is raised.
For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
1952 1953 1954 1955 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 1952 def create_data_source(params = {}, = {}) req = build_request(:create_data_source, params) req.send_request() end |
#create_experience(params = {}) ⇒ Types::CreateExperienceResponse
Creates an Amazon Kendra experience such as a search application. For more information on creating a search application experience, including using the Python and Java SDKs, see Building a search experience with no code.
2033 2034 2035 2036 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2033 def create_experience(params = {}, = {}) req = build_request(:create_experience, params) req.send_request() end |
#create_faq(params = {}) ⇒ Types::CreateFaqResponse
Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.
Adding FAQs to an index is an asynchronous operation.
For an example of adding an FAQ to an index using Python and Java SDKs, see Using your FAQ file.
2144 2145 2146 2147 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2144 def create_faq(params = {}, = {}) req = build_request(:create_faq, params) req.send_request() end |
#create_featured_results_set(params = {}) ⇒ Types::CreateFeaturedResultsSetResponse
Creates a set of featured results to display at the top of the search results page. Featured results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match, then one or more specific documents are featured in the search results.
You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting Support.
2257 2258 2259 2260 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2257 def create_featured_results_set(params = {}, = {}) req = build_request(:create_featured_results_set, params) req.send_request() end |
#create_index(params = {}) ⇒ Types::CreateIndexResponse
Creates an Amazon Kendra index. Index creation is an asynchronous API.
To determine if index creation has completed, check the Status field
returned from a call to DescribeIndex. The Status field is set to
ACTIVE when the index is ready to use.
Once the index is active, you can index your documents using the
BatchPutDocument API or using one of the supported data
sources.
For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.
2427 2428 2429 2430 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2427 def create_index(params = {}, = {}) req = build_request(:create_index, params) req.send_request() end |
#create_query_suggestions_block_list(params = {}) ⇒ Types::CreateQuerySuggestionsBlockListResponse
Creates a block list to exlcude certain queries from suggestions.
Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.
You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
CreateQuerySuggestionsBlockList is currently not supported in the
Amazon Web Services GovCloud (US-West) region.
For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.
2537 2538 2539 2540 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2537 def create_query_suggestions_block_list(params = {}, = {}) req = build_request(:create_query_suggestions_block_list, params) req.send_request() end |
#create_thesaurus(params = {}) ⇒ Types::CreateThesaurusResponse
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
For an example of adding a thesaurus file to an index, see Adding custom synonyms to an index.
2619 2620 2621 2622 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2619 def create_thesaurus(params = {}, = {}) req = build_request(:create_thesaurus, params) req.send_request() end |
#delete_access_control_configuration(params = {}) ⇒ Struct
Deletes an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
2649 2650 2651 2652 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2649 def delete_access_control_configuration(params = {}, = {}) req = build_request(:delete_access_control_configuration, params) req.send_request() end |
#delete_data_source(params = {}) ⇒ Struct
Deletes an Amazon Kendra data source connector. An exception is not
thrown if the data source is already being deleted. While the data
source is being deleted, the Status field returned by a call to the
DescribeDataSource API is set to DELETING. For more information,
see Deleting Data Sources.
Deleting an entire data source or re-syncing your index after deleting specific documents from a data source could take up to an hour or more, depending on the number of documents you want to delete.
2687 2688 2689 2690 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2687 def delete_data_source(params = {}, = {}) req = build_request(:delete_data_source, params) req.send_request() end |
#delete_experience(params = {}) ⇒ Struct
Deletes your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
2719 2720 2721 2722 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2719 def delete_experience(params = {}, = {}) req = build_request(:delete_experience, params) req.send_request() end |
#delete_faq(params = {}) ⇒ Struct
Removes a FAQ from an index.
2745 2746 2747 2748 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2745 def delete_faq(params = {}, = {}) req = build_request(:delete_faq, params) req.send_request() end |
#delete_index(params = {}) ⇒ Struct
Deletes an Amazon Kendra index. An exception is not thrown if the
index is already being deleted. While the index is being deleted, the
Status field returned by a call to the DescribeIndex API is set to
DELETING.
2770 2771 2772 2773 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2770 def delete_index(params = {}, = {}) req = build_request(:delete_index, params) req.send_request() end |
#delete_principal_mapping(params = {}) ⇒ Struct
Deletes a group so that all users that belong to the group can no longer access documents only available to that group.
For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.
If you want to delete or replace users or sub groups of a group, you
need to use the PutPrincipalMapping operation. For example, if a
user in the group "Engineering" leaves the engineering team and
another user takes their place, you provide an updated list of users
or sub groups that belong to the "Engineering" group when calling
PutPrincipalMapping. You can update your internal list of users or
sub groups and input this list when calling PutPrincipalMapping.
DeletePrincipalMapping is currently not supported in the Amazon Web
Services GovCloud (US-West) region.
2844 2845 2846 2847 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2844 def delete_principal_mapping(params = {}, = {}) req = build_request(:delete_principal_mapping, params) req.send_request() end |
#delete_query_suggestions_block_list(params = {}) ⇒ Struct
Deletes a block list used for query suggestions for an index.
A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.
DeleteQuerySuggestionsBlockList is currently not supported in the
Amazon Web Services GovCloud (US-West) region.
2877 2878 2879 2880 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2877 def delete_query_suggestions_block_list(params = {}, = {}) req = build_request(:delete_query_suggestions_block_list, params) req.send_request() end |
#delete_thesaurus(params = {}) ⇒ Struct
Deletes an Amazon Kendra thesaurus.
2903 2904 2905 2906 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2903 def delete_thesaurus(params = {}, = {}) req = build_request(:delete_thesaurus, params) req.send_request() end |
#describe_access_control_configuration(params = {}) ⇒ Types::DescribeAccessControlConfigurationResponse
Gets information about an access control configuration that you created for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
2957 2958 2959 2960 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 2957 def describe_access_control_configuration(params = {}, = {}) req = build_request(:describe_access_control_configuration, params) req.send_request() end |
#describe_data_source(params = {}) ⇒ Types::DescribeDataSourceResponse
Gets information about an Amazon Kendra data source connector.
3510 3511 3512 3513 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 3510 def describe_data_source(params = {}, = {}) req = build_request(:describe_data_source, params) req.send_request() end |
#describe_experience(params = {}) ⇒ Types::DescribeExperienceResponse
Gets information about your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
3576 3577 3578 3579 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 3576 def describe_experience(params = {}, = {}) req = build_request(:describe_experience, params) req.send_request() end |
#describe_faq(params = {}) ⇒ Types::DescribeFaqResponse
Gets information about a FAQ.
3631 3632 3633 3634 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 3631 def describe_faq(params = {}, = {}) req = build_request(:describe_faq, params) req.send_request() end |
#describe_featured_results_set(params = {}) ⇒ Types::DescribeFeaturedResultsSetResponse
Gets information about a set of featured results. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
3688 3689 3690 3691 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 3688 def describe_featured_results_set(params = {}, = {}) req = build_request(:describe_featured_results_set, params) req.send_request() end |
#describe_index(params = {}) ⇒ Types::DescribeIndexResponse
Gets information about an Amazon Kendra index.
3770 3771 3772 3773 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 3770 def describe_index(params = {}, = {}) req = build_request(:describe_index, params) req.send_request() end |
#describe_principal_mapping(params = {}) ⇒ Types::DescribePrincipalMappingResponse
Describes the processing of PUT and DELETE actions for mapping
users to their groups. This includes information on the status of
actions currently processing or yet to be processed, when actions were
last updated, when actions were received by Amazon Kendra, the latest
action that should process and apply after other actions, and useful
error messages if an action could not be processed.
DescribePrincipalMapping is currently not supported in the Amazon
Web Services GovCloud (US-West) region.
3828 3829 3830 3831 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 3828 def describe_principal_mapping(params = {}, = {}) req = build_request(:describe_principal_mapping, params) req.send_request() end |
#describe_query_suggestions_block_list(params = {}) ⇒ Types::DescribeQuerySuggestionsBlockListResponse
Gets information about a block list used for query suggestions for an index.
This is used to check the current settings that are applied to a block list.
DescribeQuerySuggestionsBlockList is currently not supported in the
Amazon Web Services GovCloud (US-West) region.
3890 3891 3892 3893 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 3890 def describe_query_suggestions_block_list(params = {}, = {}) req = build_request(:describe_query_suggestions_block_list, params) req.send_request() end |
#describe_query_suggestions_config(params = {}) ⇒ Types::DescribeQuerySuggestionsConfigResponse
Gets information on the settings of query suggestions for an index.
This is used to check the current settings applied to query suggestions.
DescribeQuerySuggestionsConfig is currently not supported in the
Amazon Web Services GovCloud (US-West) region.
3946 3947 3948 3949 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 3946 def describe_query_suggestions_config(params = {}, = {}) req = build_request(:describe_query_suggestions_config, params) req.send_request() end |
#describe_thesaurus(params = {}) ⇒ Types::DescribeThesaurusResponse
Gets information about an Amazon Kendra thesaurus.
4003 4004 4005 4006 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4003 def describe_thesaurus(params = {}, = {}) req = build_request(:describe_thesaurus, params) req.send_request() end |
#disassociate_entities_from_experience(params = {}) ⇒ Types::DisassociateEntitiesFromExperienceResponse
Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
4054 4055 4056 4057 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4054 def disassociate_entities_from_experience(params = {}, = {}) req = build_request(:disassociate_entities_from_experience, params) req.send_request() end |
#disassociate_personas_from_entities(params = {}) ⇒ Types::DisassociatePersonasFromEntitiesResponse
Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
4102 4103 4104 4105 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4102 def disassociate_personas_from_entities(params = {}, = {}) req = build_request(:disassociate_personas_from_entities, params) req.send_request() end |
#get_query_suggestions(params = {}) ⇒ Types::GetQuerySuggestionsResponse
Fetches the queries that are suggested to your users.
GetQuerySuggestions is currently not supported in the Amazon Web
Services GovCloud (US-West) region.
4279 4280 4281 4282 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4279 def get_query_suggestions(params = {}, = {}) req = build_request(:get_query_suggestions, params) req.send_request() end |
#get_snapshots(params = {}) ⇒ Types::GetSnapshotsResponse
Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4368 4369 4370 4371 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4368 def get_snapshots(params = {}, = {}) req = build_request(:get_snapshots, params) req.send_request() end |
#list_access_control_configurations(params = {}) ⇒ Types::ListAccessControlConfigurationsResponse
Lists one or more access control configurations for an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4415 4416 4417 4418 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4415 def list_access_control_configurations(params = {}, = {}) req = build_request(:list_access_control_configurations, params) req.send_request() end |
#list_data_source_sync_jobs(params = {}) ⇒ Types::ListDataSourceSyncJobsResponse
Gets statistics about synchronizing a data source connector.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4488 4489 4490 4491 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4488 def list_data_source_sync_jobs(params = {}, = {}) req = build_request(:list_data_source_sync_jobs, params) req.send_request() end |
#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
Lists the data source connectors that you have created.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4539 4540 4541 4542 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4539 def list_data_sources(params = {}, = {}) req = build_request(:list_data_sources, params) req.send_request() end |
#list_entity_personas(params = {}) ⇒ Types::ListEntityPersonasResponse
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4591 4592 4593 4594 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4591 def list_entity_personas(params = {}, = {}) req = build_request(:list_entity_personas, params) req.send_request() end |
#list_experience_entities(params = {}) ⇒ Types::ListExperienceEntitiesResponse
Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4649 4650 4651 4652 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4649 def list_experience_entities(params = {}, = {}) req = build_request(:list_experience_entities, params) req.send_request() end |
#list_experiences(params = {}) ⇒ Types::ListExperiencesResponse
Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4706 4707 4708 4709 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4706 def list_experiences(params = {}, = {}) req = build_request(:list_experiences, params) req.send_request() end |
#list_faqs(params = {}) ⇒ Types::ListFaqsResponse
Gets a list of FAQs associated with an index.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4757 4758 4759 4760 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4757 def list_faqs(params = {}, = {}) req = build_request(:list_faqs, params) req.send_request() end |
#list_featured_results_sets(params = {}) ⇒ Types::ListFeaturedResultsSetsResponse
Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.
4805 4806 4807 4808 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4805 def list_featured_results_sets(params = {}, = {}) req = build_request(:list_featured_results_sets, params) req.send_request() end |
#list_groups_older_than_ordering_id(params = {}) ⇒ Types::ListGroupsOlderThanOrderingIdResponse
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
ListGroupsOlderThanOrderingId is currently not supported in the
Amazon Web Services GovCloud (US-West) region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4867 4868 4869 4870 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4867 def list_groups_older_than_ordering_id(params = {}, = {}) req = build_request(:list_groups_older_than_ordering_id, params) req.send_request() end |
#list_indices(params = {}) ⇒ Types::ListIndicesResponse
Lists the Amazon Kendra indexes that you created.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4911 4912 4913 4914 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4911 def list_indices(params = {}, = {}) req = build_request(:list_indices, params) req.send_request() end |
#list_query_suggestions_block_lists(params = {}) ⇒ Types::ListQuerySuggestionsBlockListsResponse
Lists the block lists used for query suggestions for an index.
For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
ListQuerySuggestionsBlockLists is currently not supported in the
Amazon Web Services GovCloud (US-West) region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4978 4979 4980 4981 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 4978 def list_query_suggestions_block_lists(params = {}, = {}) req = build_request(:list_query_suggestions_block_lists, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Gets a list of tags associated with a resource. Indexes, FAQs, data sources, and other resources can have tags associated with them.
5018 5019 5020 5021 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 5018 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_thesauri(params = {}) ⇒ Types::ListThesauriResponse
Lists the thesauri for an index.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5066 5067 5068 5069 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 5066 def list_thesauri(params = {}, = {}) req = build_request(:list_thesauri, params) req.send_request() end |
#put_principal_mapping(params = {}) ⇒ Struct
Maps users to their groups so that you only need to provide the user ID when you issue the query.
You can also map sub groups to groups. For example, the group "Company Intellectual Property Teams" includes sub groups "Research" and "Engineering". These sub groups include their own list of users or people who work in these teams. Only users who work in research and engineering, and therefore belong in the intellectual property group, can see top-secret company documents in their search results.
This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. For more information, see Filtering on user context.
If more than five PUT actions for a group are currently processing,
a validation exception is thrown.
5184 5185 5186 5187 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 5184 def put_principal_mapping(params = {}, = {}) req = build_request(:put_principal_mapping, params) req.send_request() end |
#query(params = {}) ⇒ Types::QueryResult
Searches an index given an input query.
Retrieve API instead of
filing a service limit increase to increase the Query API document
excerpt length.
You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information.
A query response contains three types of results.
Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt.
Matching FAQs or questions-answer from your FAQ file.
Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt.
You can specify that the query return only one type of result using
the QueryResultTypeFilter parameter. Each query returns the 100 most
relevant results. If you filter result type to only question-answers,
a maximum of four results are returned. If you filter result type to
only answers, a maximum of three results are returned.
If you're using an Amazon Kendra Gen AI Enterprise Edition index, you
can only use ATTRIBUTE_FILTER to filter search results by user
context. If you're using an Amazon Kendra Gen AI Enterprise Edition
index and you try to use USER_TOKEN to configure user context
policy, Amazon Kendra returns a ValidationException error.
5639 5640 5641 5642 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 5639 def query(params = {}, = {}) req = build_request(:query, params) req.send_request() end |
#retrieve(params = {}) ⇒ Types::RetrieveResult
Retrieves relevant passages or text excerpts given an input query.
This API is similar to the Query API. However, by default, the
Query API only returns excerpt passages of up to 100 token words.
With the Retrieve API, you can retrieve longer passages of up to 200
token words and up to 100 semantically relevant passages. This
doesn't include question-answer or FAQ type responses from your
index. The passages are text excerpts that can be semantically
extracted from multiple documents and multiple parts of the same
document. If in extreme cases your documents produce zero passages
using the Retrieve API, you can alternatively use the Query API
and its types of responses.
You can also do the following:
Override boosting at the index level
Filter based on document fields or attributes
Filter based on the user or their group access to documents
View the confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.
Confidence score buckets are currently available only for English.
You can also include certain fields in the response that might provide useful additional information.
The Retrieve API shares the number of query capacity units that
you set for your index. For more information on what's included in a
single capacity unit and the default base capacity for an index, see
Adjusting capacity.
If you're using an Amazon Kendra Gen AI Enterprise Edition index, you
can only use ATTRIBUTE_FILTER to filter search results by user
context. If you're using an Amazon Kendra Gen AI Enterprise Edition
index and you try to use USER_TOKEN to configure user context
policy, Amazon Kendra returns a ValidationException error.
5899 5900 5901 5902 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 5899 def retrieve(params = {}, = {}) req = build_request(:retrieve, params) req.send_request() end |
#start_data_source_sync_job(params = {}) ⇒ Types::StartDataSourceSyncJobResponse
Starts a synchronization job for a data source connector. If a
synchronization job is already in progress, Amazon Kendra returns a
ResourceInUseException exception.
Re-syncing your data source with your index after modifying, adding, or deleting documents from your data source respository could take up to an hour or more, depending on the number of documents to sync.
5937 5938 5939 5940 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 5937 def start_data_source_sync_job(params = {}, = {}) req = build_request(:start_data_source_sync_job, params) req.send_request() end |
#stop_data_source_sync_job(params = {}) ⇒ Struct
Stops a synchronization job that is currently running. You can't stop a scheduled synchronization job.
5965 5966 5967 5968 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 5965 def stop_data_source_sync_job(params = {}, = {}) req = build_request(:stop_data_source_sync_job, params) req.send_request() end |
#submit_feedback(params = {}) ⇒ Struct
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
SubmitFeedback is currently not supported in the Amazon Web Services
GovCloud (US-West) region.
6016 6017 6018 6019 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 6016 def submit_feedback(params = {}, = {}) req = build_request(:submit_feedback, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds the specified tag to the specified index, FAQ, data source, or other resource. If the tag already exists, the existing value is replaced with the new value.
6060 6061 6062 6063 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 6060 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes a tag from an index, FAQ, data source, or other resource.
6097 6098 6099 6100 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 6097 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_access_control_configuration(params = {}) ⇒ Struct
Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change.
You call the BatchPutDocument API to apply the updated access
control configuration, with the AccessControlConfigurationId
included in the Document object. If you use an S3 bucket as a
data source, you synchronize your data source to apply the
AccessControlConfigurationId in the .metadata.json file. Amazon
Kendra currently only supports access control configuration for S3
data sources and documents indexed using the BatchPutDocument API.
You can't configure access control using
CreateAccessControlConfiguration for an Amazon Kendra Gen AI
Enterprise Edition index. Amazon Kendra will return a
ValidationException error for a Gen_AI_ENTERPRISE_EDITION index.
6198 6199 6200 6201 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 6198 def update_access_control_configuration(params = {}, = {}) req = build_request(:update_access_control_configuration, params) req.send_request() end |
#update_data_source(params = {}) ⇒ Struct
Updates an Amazon Kendra data source connector.
6974 6975 6976 6977 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 6974 def update_data_source(params = {}, = {}) req = build_request(:update_data_source, params) req.send_request() end |
#update_experience(params = {}) ⇒ Struct
Updates your Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
7039 7040 7041 7042 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 7039 def update_experience(params = {}, = {}) req = build_request(:update_experience, params) req.send_request() end |
#update_featured_results_set(params = {}) ⇒ Types::UpdateFeaturedResultsSetResponse
Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.
7123 7124 7125 7126 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 7123 def update_featured_results_set(params = {}, = {}) req = build_request(:update_featured_results_set, params) req.send_request() end |
#update_index(params = {}) ⇒ Struct
Updates an Amazon Kendra index.
7248 7249 7250 7251 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 7248 def update_index(params = {}, = {}) req = build_request(:update_index, params) req.send_request() end |
#update_query_suggestions_block_list(params = {}) ⇒ Struct
Updates a block list used for query suggestions for an index.
Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.
If a block list is updating, then you need to wait for the first update to finish before submitting another update.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
UpdateQuerySuggestionsBlockList is currently not supported in the
Amazon Web Services GovCloud (US-West) region.
7318 7319 7320 7321 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 7318 def update_query_suggestions_block_list(params = {}, = {}) req = build_request(:update_query_suggestions_block_list, params) req.send_request() end |
#update_query_suggestions_config(params = {}) ⇒ Struct
Updates the settings of query suggestions for an index.
Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.
If an update is currently processing, you need to wait for the update to finish before making another update.
Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.
You can still enable/disable query suggestions at any time.
UpdateQuerySuggestionsConfig is currently not supported in the
Amazon Web Services GovCloud (US-West) region.
7427 7428 7429 7430 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 7427 def update_query_suggestions_config(params = {}, = {}) req = build_request(:update_query_suggestions_config, params) req.send_request() end |
#update_thesaurus(params = {}) ⇒ Struct
Updates a thesaurus for an index.
7473 7474 7475 7476 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/client.rb', line 7473 def update_thesaurus(params = {}, = {}) req = build_request(:update_thesaurus, params) req.send_request() end |