AWS.Kendra (aws-elixir v0.7.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.

Adds one or more documents to 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.

Deletes an Amazon Kendra data source.

Removes an FAQ from an index.

Deletes an existing Amazon Kendra index.

Gets information about a Amazon Kendra data source.

Gets information about an FAQ list.

Describes an existing Amazon Kendra index

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.

Lists the Amazon Kendra indexes that you have created.

Gets a list of tags associated with a specified resource.

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.

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 AWS CloudWatch. Any error messages releated to the processing of the batch are sent to you CloudWatch log.

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 AWS CloudWatch. Any error messages related to processing the batch are sent to your AWS CloudWatch log.

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 . 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 operation or using one of the supported data sources.

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

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

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_indices(client, input, options \\ [])

View Source

Lists the Amazon Kendra indexes that you have created.

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

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.