AWS.Kendra (aws-elixir v0.8.0) View Source

Amazon Kendra is a service for indexing large document sets.

Link to this section Summary

Functions

Removes one or more documents from an index.

Returns the indexing status for one or more documents submitted with the BatchPutDocument operation.

Adds one or more documents to an index.

Clears existing query suggestions from an index.

Creates a data source that you use to with an Amazon Kendra index.

Creates an new set of frequently asked question (FAQ) questions and answers.

Creates a new Amazon Kendra index.

Creates a block list to exlcude certain queries from suggestions.

Creates a thesaurus for an index.

Deletes an Amazon Kendra data source.

Removes an FAQ from an index.

Deletes an existing Amazon Kendra index.

Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.

Deletes a block list used for query suggestions for an index.

Deletes an existing Amazon Kendra thesaurus.

Gets information about a Amazon Kendra data source.

Gets information about an FAQ list.

Describes an existing Amazon Kendra index

Describes the processing of PUT and DELETE actions for mapping users to their groups.

Describes a block list used for query suggestions for an index.

Describes the settings of query suggestions for an index.

Describes an existing Amazon Kendra thesaurus.

Fetches the queries that are suggested to your users.

Gets statistics about synchronizing Amazon Kendra with a data source.

Lists the data sources that you have created.

Gets a list of FAQ lists associated with an index.

Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.

Lists the Amazon Kendra indexes that you have created.

Lists the block lists used for query suggestions for an index.

Gets a list of tags associated with a specified resource.

Lists the Amazon Kendra thesauri associated with an index.

Searches an active index.

Starts a synchronization job for a data source.

Stops a running synchronization job.

Enables you to provide feedback to Amazon Kendra to improve the performance of the service.

Adds the specified tag to the specified index, FAQ, or data source resource.

Removes a tag from an index, FAQ, or a data source.

Updates an existing Amazon Kendra data source.

Updates an existing Amazon Kendra index.

Updates a block list used for query suggestions for an index.

Updates the settings of query suggestions for an index.

Updates a thesaurus file associated with an index.

Link to this section Functions

Link to this function

batch_delete_document(client, input, options \\ [])

View Source

Removes one or more documents from an index.

The documents must have been added with the BatchPutDocument operation.

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 you CloudWatch log.

Link to this function

batch_get_document_status(client, input, options \\ [])

View Source

Returns the indexing status for one or more documents submitted with the BatchPutDocument operation.

When you use the BatchPutDocument operation, documents are indexed asynchronously. You can use the BatchGetDocumentStatus operation 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 operation to check the status of the BatchDeleteDocument operation. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

Link to this function

batch_put_document(client, input, options \\ [])

View Source

Adds one or more documents to an index.

The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this operation 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.

Link to this function

clear_query_suggestions(client, input, options \\ [])

View Source

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.

Link to this function

create_data_source(client, input, options \\ [])

View Source

Creates a data source that you use to with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information such as document metadata (author, source URI, and so on) and user context information.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

Link to this function

create_faq(client, input, options \\ [])

View Source

Creates an new set of frequently asked question (FAQ) questions and answers.

Link to this function

create_index(client, input, options \\ [])

View Source

Creates a new Amazon Kendra index.

Index creation is an asynchronous operation. 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 operation or using one of the supported data sources.

Link to this function

create_query_suggestions_block_list(client, input, options \\ [])

View Source

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.

Link to this function

create_thesaurus(client, input, options \\ [])

View Source

Creates a thesaurus for an index.

The thesaurus contains a list of synonyms in Solr format.

Link to this function

delete_data_source(client, input, options \\ [])

View Source

Deletes an Amazon Kendra data source.

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 operation is set to DELETING. For more information, see Deleting Data Sources.

Link to this function

delete_faq(client, input, options \\ [])

View Source

Removes an FAQ from an index.

Link to this function

delete_index(client, input, options \\ [])

View Source

Deletes an existing 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 operation is set to DELETING.

Link to this function

delete_principal_mapping(client, input, options \\ [])

View Source

Deletes a group so that all users and sub groups 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.

Link to this function

delete_query_suggestions_block_list(client, input, options \\ [])

View Source

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.

Link to this function

delete_thesaurus(client, input, options \\ [])

View Source

Deletes an existing Amazon Kendra thesaurus.

Link to this function

describe_data_source(client, input, options \\ [])

View Source

Gets information about a Amazon Kendra data source.

Link to this function

describe_faq(client, input, options \\ [])

View Source

Gets information about an FAQ list.

Link to this function

describe_index(client, input, options \\ [])

View Source

Describes an existing Amazon Kendra index

Link to this function

describe_principal_mapping(client, input, options \\ [])

View Source

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.

Link to this function

describe_query_suggestions_block_list(client, input, options \\ [])

View Source

Describes 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.

Link to this function

describe_query_suggestions_config(client, input, options \\ [])

View Source

Describes the settings of query suggestions for an index.

This is used to check the current settings applied to query suggestions.

Link to this function

describe_thesaurus(client, input, options \\ [])

View Source

Describes an existing Amazon Kendra thesaurus.

Link to this function

get_query_suggestions(client, input, options \\ [])

View Source

Fetches the queries that are suggested to your users.

Link to this function

list_data_source_sync_jobs(client, input, options \\ [])

View Source

Gets statistics about synchronizing Amazon Kendra with a data source.

Link to this function

list_data_sources(client, input, options \\ [])

View Source

Lists the data sources that you have created.

Link to this function

list_faqs(client, input, options \\ [])

View Source

Gets a list of FAQ lists associated with an index.

Link to this function

list_groups_older_than_ordering_id(client, input, options \\ [])

View Source

Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.

Link to this function

list_indices(client, input, options \\ [])

View Source

Lists the Amazon Kendra indexes that you have created.

Link to this function

list_query_suggestions_block_lists(client, input, options \\ [])

View Source

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.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Gets a list of tags associated with a specified resource.

Indexes, FAQs, and data sources can have tags associated with them.

Link to this function

list_thesauri(client, input, options \\ [])

View Source

Lists the Amazon Kendra thesauri associated with an index.

Link to this function

put_principal_mapping(client, input, options \\ [])

View Source

Maps users to their groups.

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.

You map users to their groups when you want to filter search results for different users based on their group’s access to documents. For more information on filtering search results for different users, see Filtering on user context.

If more than five PUT actions for a group are currently processing, a validation exception is thrown.

Link to this function

query(client, input, options \\ [])

View Source

Searches an active index.

Use this API to search your documents using query. The Query operation enables to do faceted search and to filter results based on document attributes.

It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.

Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.

  • Relevant passages

  • Matching FAQs

  • Relevant documents

You can specify that the query return only one type of result using the QueryResultTypeConfig parameter.

Each query returns the 100 most relevant results.

Link to this function

start_data_source_sync_job(client, input, options \\ [])

View Source

Starts a synchronization job for a data source.

If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.

Link to this function

stop_data_source_sync_job(client, input, options \\ [])

View Source

Stops a running synchronization job.

You can't stop a scheduled synchronization job.

Link to this function

submit_feedback(client, input, options \\ [])

View Source

Enables you to provide feedback to Amazon Kendra to improve the performance of the service.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds the specified tag to the specified index, FAQ, or data source resource.

If the tag already exists, the existing value is replaced with the new value.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes a tag from an index, FAQ, or a data source.

Link to this function

update_data_source(client, input, options \\ [])

View Source

Updates an existing Amazon Kendra data source.

Link to this function

update_index(client, input, options \\ [])

View Source

Updates an existing Amazon Kendra index.

Link to this function

update_query_suggestions_block_list(client, input, options \\ [])

View Source

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.

Link to this function

update_query_suggestions_config(client, input, options \\ [])

View Source

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 (i.e. 'happening'), 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.

Link to this function

update_thesaurus(client, input, options \\ [])

View Source

Updates a thesaurus file associated with an index.