Kendra class

Amazon Kendra is a service for indexing large document sets.

Constructors

Kendra({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

batchDeleteDocument({required List<String> documentIdList, required String indexId, DataSourceSyncJobMetricTarget? dataSourceSyncJobMetricTarget}) → Future<BatchDeleteDocumentResponse>
Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation.
batchPutDocument({required List<Document> documents, required String indexId, String? roleArn}) → Future<BatchPutDocumentResponse>
Adds one or more documents to an index.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createDataSource({required String indexId, required String name, required DataSourceType type, String? clientToken, DataSourceConfiguration? configuration, String? description, String? roleArn, String? schedule, List<Tag>? tags}) → Future<CreateDataSourceResponse>
Creates a data source that you use to with an Amazon Kendra index.
createFaq({required String indexId, required String name, required String roleArn, required S3Path s3Path, String? clientToken, String? description, FaqFileFormat? fileFormat, List<Tag>? tags}) → Future<CreateFaqResponse>
Creates an new set of frequently asked question (FAQ) questions and answers.
createIndex({required String name, required String roleArn, String? clientToken, String? description, IndexEdition? edition, ServerSideEncryptionConfiguration? serverSideEncryptionConfiguration, List<Tag>? tags, UserContextPolicy? userContextPolicy, List<UserTokenConfiguration>? userTokenConfigurations}) → Future<CreateIndexResponse>
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.
createThesaurus({required String indexId, required String name, required String roleArn, required S3Path sourceS3Path, String? clientToken, String? description, List<Tag>? tags}) → Future<CreateThesaurusResponse>
Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.
deleteDataSource({required String id, required String indexId}) → Future<void>
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.
deleteFaq({required String id, required String indexId}) → Future<void>
Removes an FAQ from an index.
deleteIndex({required String id}) → Future<void>
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.
deleteThesaurus({required String id, required String indexId}) → Future<void>
Deletes an existing Amazon Kendra thesaurus.
describeDataSource({required String id, required String indexId}) → Future<DescribeDataSourceResponse>
Gets information about a Amazon Kendra data source.
describeFaq({required String id, required String indexId}) → Future<DescribeFaqResponse>
Gets information about an FAQ list.
describeIndex({required String id}) → Future<DescribeIndexResponse>
Describes an existing Amazon Kendra index
describeThesaurus({required String id, required String indexId}) → Future<DescribeThesaurusResponse>
Describes an existing Amazon Kendra thesaurus.
listDataSources({required String indexId, int? maxResults, String? nextToken}) → Future<ListDataSourcesResponse>
Lists the data sources that you have created.
listDataSourceSyncJobs({required String id, required String indexId, int? maxResults, String? nextToken, TimeRange? startTimeFilter, DataSourceSyncJobStatus? statusFilter}) → Future<ListDataSourceSyncJobsResponse>
Gets statistics about synchronizing Amazon Kendra with a data source.
listFaqs({required String indexId, int? maxResults, String? nextToken}) → Future<ListFaqsResponse>
Gets a list of FAQ lists associated with an index.
listIndices({int? maxResults, String? nextToken}) → Future<ListIndicesResponse>
Lists the Amazon Kendra indexes that you have created.
listTagsForResource({required String resourceARN}) → Future<ListTagsForResourceResponse>
Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.
listThesauri({required String indexId, int? maxResults, String? nextToken}) → Future<ListThesauriResponse>
Lists the Amazon Kendra thesauri associated with an index.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
query({required String indexId, required String queryText, AttributeFilter? attributeFilter, List<Facet>? facets, int? pageNumber, int? pageSize, QueryResultType? queryResultTypeFilter, List<String>? requestedDocumentAttributes, SortingConfiguration? sortingConfiguration, UserContext? userContext, String? visitorId}) → Future<QueryResult>
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.
startDataSourceSyncJob({required String id, required String indexId}) → Future<StartDataSourceSyncJobResponse>
Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.
stopDataSourceSyncJob({required String id, required String indexId}) → Future<void>
Stops a running synchronization job. You can't stop a scheduled synchronization job.
submitFeedback({required String indexId, required String queryId, List<ClickFeedback>? clickFeedbackItems, List<RelevanceFeedback>? relevanceFeedbackItems}) → Future<void>
Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
tagResource({required String resourceARN, required List<Tag> tags}) → Future<void>
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.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceARN, required List<String> tagKeys}) → Future<void>
Removes a tag from an index, FAQ, or a data source.
updateDataSource({required String id, required String indexId, DataSourceConfiguration? configuration, String? description, String? name, String? roleArn, String? schedule}) → Future<void>
Updates an existing Amazon Kendra data source.
updateIndex({required String id, CapacityUnitsConfiguration? capacityUnits, String? description, List<DocumentMetadataConfiguration>? documentMetadataConfigurationUpdates, String? name, String? roleArn, UserContextPolicy? userContextPolicy, List<UserTokenConfiguration>? userTokenConfigurations}) → Future<void>
Updates an existing Amazon Kendra index.
updateThesaurus({required String id, required String indexId, String? description, String? name, String? roleArn, S3Path? sourceS3Path}) → Future<void>
Updates a thesaurus file associated with an index.

Operators

operator ==(Object other) → bool
The equality operator.
inherited