View Source aws_kendra (aws v0.3.1)

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.

batch_delete_document(Client, Input, Options)

batch_put_document(Client, Input)

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.

batch_put_document(Client, Input, Options)

create_data_source(Client, Input)

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.

create_data_source(Client, Input, Options)

create_faq(Client, Input)

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

create_faq(Client, Input, Options)

create_index(Client, Input)

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.

create_index(Client, Input, Options)

create_thesaurus(Client, Input)

Creates a thesaurus for an index.

The thesaurus contains a list of synonyms in Solr format.

create_thesaurus(Client, Input, Options)

delete_data_source(Client, Input)

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.

delete_data_source(Client, Input, Options)

delete_faq(Client, Input)

Removes an FAQ from an index.

delete_faq(Client, Input, Options)

delete_index(Client, Input)

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.

delete_index(Client, Input, Options)

delete_thesaurus(Client, Input)

Deletes an existing Amazon Kendra thesaurus.

delete_thesaurus(Client, Input, Options)

describe_data_source(Client, Input)

Gets information about a Amazon Kendra data source.

describe_data_source(Client, Input, Options)

describe_faq(Client, Input)

Gets information about an FAQ list.

describe_faq(Client, Input, Options)

describe_index(Client, Input)

Describes an existing Amazon Kendra index

describe_index(Client, Input, Options)

describe_thesaurus(Client, Input)

Describes an existing Amazon Kendra thesaurus.

describe_thesaurus(Client, Input, Options)

list_data_source_sync_jobs(Client, Input)

Gets statistics about synchronizing Amazon Kendra with a data source.

list_data_source_sync_jobs(Client, Input, Options)

list_data_sources(Client, Input)

Lists the data sources that you have created.

list_data_sources(Client, Input, Options)

list_faqs(Client, Input)

Gets a list of FAQ lists associated with an index.

list_faqs(Client, Input, Options)

list_indices(Client, Input)

Lists the Amazon Kendra indexes that you have created.

list_indices(Client, Input, Options)

list_tags_for_resource(Client, Input)

Gets a list of tags associated with a specified resource.

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

list_tags_for_resource(Client, Input, Options)

list_thesauri(Client, Input)

Lists the Amazon Kendra thesauri associated with an index.

list_thesauri(Client, Input, Options)

query(Client, Input)

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.

query(Client, Input, Options)

start_data_source_sync_job(Client, Input)

Starts a synchronization job for a data source.

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

start_data_source_sync_job(Client, Input, Options)

stop_data_source_sync_job(Client, Input)

Stops a running synchronization job.

You can't stop a scheduled synchronization job.

stop_data_source_sync_job(Client, Input, Options)

submit_feedback(Client, Input)

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

Settings View Source aws_kendra (aws v0.3.1)

Link to this section Summary

Functions

Link to this section Functions

batch_delete_document(Client, Input)