feat(client-kendra): Amazon Kendra now supports preview of table info…

…rmation from HTML tables in the search results. The most relevant cells with their corresponding rows, columns are displayed as a preview in the search result. The most relevant table cell or cells are also highlighted in table preview.
aws · Nov 28, 2022 · 340955b · 340955b
1 parent cf73137
commit 340955b
Show file tree

Hide file tree

Showing 29 changed files with 1,572 additions and 1,358 deletions.
diff --git a/clients/client-kendra/src/Kendra.ts b/clients/client-kendra/src/Kendra.ts
diff --git a/clients/client-kendra/src/commands/BatchGetDocumentStatusCommand.ts b/clients/client-kendra/src/commands/BatchGetDocumentStatusCommand.ts
@@ -32,12 +32,12 @@ export interface BatchGetDocumentStatusCommandOutput extends BatchGetDocumentSta
  * <p>Returns the indexing status for one or more documents submitted
  *             with the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">
  *                 BatchPutDocument</a> API.</p>
- *         <p>When you use the <code>BatchPutDocument</code> API,
+ *          <p>When you use the <code>BatchPutDocument</code> API,
  *             documents are indexed asynchronously. You can use the
  *                 <code>BatchGetDocumentStatus</code> API to get the current
  *             status of a list of documents so that you can determine if they have
  *             been successfully indexed.</p>
- *         <p>You can also use the <code>BatchGetDocumentStatus</code> API
+ *          <p>You can also use the <code>BatchGetDocumentStatus</code> API
  *             to check the status of the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html">
  *                 BatchDeleteDocument</a> API. When a document is
  *             deleted from the index, Amazon Kendra returns <code>NOT_FOUND</code> as the

diff --git a/clients/client-kendra/src/commands/ClearQuerySuggestionsCommand.ts b/clients/client-kendra/src/commands/ClearQuerySuggestionsCommand.ts
@@ -25,13 +25,13 @@ export interface ClearQuerySuggestionsCommandOutput extends __MetadataBearer {}
 
 /**
  * <p>Clears existing query suggestions from an index.</p>
- *         <p>This deletes existing suggestions only, not the queries
+ *          <p>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.</p>
- *         <p>
+ *          <p>
  *             <code>ClearQuerySuggestions</code> is currently not supported in the
  *             Amazon Web Services GovCloud (US-West) region.</p>
  * @example

diff --git a/clients/client-kendra/src/commands/CreateAccessControlConfigurationCommand.ts b/clients/client-kendra/src/commands/CreateAccessControlConfigurationCommand.ts
@@ -35,7 +35,7 @@ export interface CreateAccessControlConfigurationCommandOutput
  *             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.</p>
- *         <p>You can use this to re-configure your existing document level access control without
+ *          <p>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
@@ -45,7 +45,7 @@ export interface CreateAccessControlConfigurationCommandOutput
  *             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.</p>
- *         <p>To apply your access control configuration to certain documents, you call
+ *          <p>To apply your access control configuration to certain documents, you call
  *             the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a>
  *             API with the <code>AccessControlConfigurationId</code> included in the
  *             <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>

diff --git a/clients/client-kendra/src/commands/CreateFaqCommand.ts b/clients/client-kendra/src/commands/CreateFaqCommand.ts
@@ -27,8 +27,8 @@ export interface CreateFaqCommandOutput extends CreateFaqResponse, __MetadataBea
 
 /**
  * <p>Creates an new set of frequently asked question (FAQ) questions and answers.</p>
- *         <p>Adding FAQs to an index is an asynchronous operation.</p>
- *         <p>For an example of adding an FAQ to an index using Python and Java SDKs,
+ *          <p>Adding FAQs to an index is an asynchronous operation.</p>
+ *          <p>For an example of adding an FAQ to an index using Python and Java SDKs,
  *             see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using your
  *                 FAQ file</a>.</p>
  * @example

diff --git a/clients/client-kendra/src/commands/CreateIndexCommand.ts b/clients/client-kendra/src/commands/CreateIndexCommand.ts
@@ -29,18 +29,16 @@ export interface CreateIndexCommandInput extends CreateIndexRequest {}
 export interface CreateIndexCommandOutput extends CreateIndexResponse, __MetadataBearer {}
 
 /**
- * <p>Creates an Amazon Kendra index. Index creation is an asynchronous
- *       API. To determine if index creation has completed, check the
- *         <code>Status</code> field returned from a call to
- *         <code>DescribeIndex</code>. The <code>Status</code> field is set to
- *         <code>ACTIVE</code> when the index is ready to use.</p>
+ * <p>Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine
+ *       if index creation has completed, check the <code>Status</code> field returned from a call to
+ *         <code>DescribeIndex</code>. The <code>Status</code> field is set to <code>ACTIVE</code> when
+ *       the index is ready to use.</p>
  *          <p>Once the index is active you can index your documents using the
- *         <code>BatchPutDocument</code> API or using one of the supported
- *       data sources.</p>
- *          <p>For an example of creating an index and data source using the Python SDK,
- *       see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting
- *         started with Python SDK</a>. For an example of creating an index and data
- *       source using the Java SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java SDK</a>.</p>
+ *         <code>BatchPutDocument</code> API or using one of the supported data sources.</p>
+ *          <p>For an example of creating an index and data source using the Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting started with Python
+ *         SDK</a>. For an example of creating an index and data source using the Java SDK, see
+ *         <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java
+ *         SDK</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-kendra/src/commands/CreateQuerySuggestionsBlockListCommand.ts b/clients/client-kendra/src/commands/CreateQuerySuggestionsBlockListCommand.ts
@@ -32,18 +32,18 @@ export interface CreateQuerySuggestionsBlockListCommandOutput
 
 /**
  * <p>Creates a block list to exlcude certain queries from suggestions.</p>
- *         <p>Any query that contains words or phrases specified in the block
+ *          <p>Any query that contains words or phrases specified in the block
  *             list is blocked or filtered out from being shown as a suggestion.</p>
- *         <p>You need to provide the file location of your block list text file
+ *          <p>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.</p>
- *         <p>For information on the current quota limits for block lists, see
+ *          <p>For information on the current quota limits for block lists, see
  *             <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas
  *                 for Amazon Kendra</a>.</p>
- *         <p>
+ *          <p>
  *             <code>CreateQuerySuggestionsBlockList</code> is currently not supported in the
  *             Amazon Web Services GovCloud (US-West) region.</p>
- *         <p>For an example of creating a block list for query suggestions using the
+ *          <p>For an example of creating a block list for query suggestions using the
  *             Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#suggestions-block-list">Query
  *                 suggestions block list</a>.</p>
  * @example

diff --git a/clients/client-kendra/src/commands/DeleteIndexCommand.ts b/clients/client-kendra/src/commands/DeleteIndexCommand.ts
@@ -24,10 +24,9 @@ export interface DeleteIndexCommandInput extends DeleteIndexRequest {}
 export interface DeleteIndexCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>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
- *         <code>Status</code> field returned by a call to the
- *         <code>DescribeIndex</code> API is set to
+ * <p>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 <code>Status</code> field
+ *       returned by a call to the <code>DescribeIndex</code> API is set to
  *       <code>DELETING</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-kendra/src/commands/DeletePrincipalMappingCommand.ts b/clients/client-kendra/src/commands/DeletePrincipalMappingCommand.ts
@@ -26,17 +26,17 @@ export interface DeletePrincipalMappingCommandOutput extends __MetadataBearer {}
 /**
  * <p>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.</p>
- *         <p>For example, after deleting the group "Summer Interns", all interns who
+ *          <p>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.</p>
- *         <p>If you want to delete or replace users or sub groups of a group, you need to
+ *          <p>If you want to delete or replace users or sub groups of a group, you need to
  *             use the <code>PutPrincipalMapping</code> 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 <code>PutPrincipalMapping</code>. You
  *             can update your internal list of users or sub groups and input this list
  *             when calling <code>PutPrincipalMapping</code>.</p>
- *         <p>
+ *          <p>
  *             <code>DeletePrincipalMapping</code> is currently not supported in the
  *             Amazon Web Services GovCloud (US-West) region.</p>
  * @example

diff --git a/clients/client-kendra/src/commands/DeleteQuerySuggestionsBlockListCommand.ts b/clients/client-kendra/src/commands/DeleteQuerySuggestionsBlockListCommand.ts
@@ -28,10 +28,10 @@ export interface DeleteQuerySuggestionsBlockListCommandOutput extends __Metadata
 
 /**
  * <p>Deletes a block list used for query suggestions for an index.</p>
- *         <p>A deleted block list might not take effect right away. Amazon Kendra
+ *          <p>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.</p>
- *         <p>
+ *          <p>
  *             <code>DeleteQuerySuggestionsBlockList</code> is currently not supported in the
  *             Amazon Web Services GovCloud (US-West) region.</p>
  * @example

diff --git a/clients/client-kendra/src/commands/DescribePrincipalMappingCommand.ts b/clients/client-kendra/src/commands/DescribePrincipalMappingCommand.ts
@@ -35,7 +35,7 @@ export interface DescribePrincipalMappingCommandOutput extends DescribePrincipal
  *             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.</p>
- *         <p>
+ *          <p>
  *             <code>DescribePrincipalMapping</code> is currently not supported in the
  *             Amazon Web Services GovCloud (US-West) region.</p>
  * @example

diff --git a/clients/client-kendra/src/commands/DescribeQuerySuggestionsBlockListCommand.ts b/clients/client-kendra/src/commands/DescribeQuerySuggestionsBlockListCommand.ts
@@ -33,9 +33,9 @@ export interface DescribeQuerySuggestionsBlockListCommandOutput
 /**
  * <p>Gets information about a block list used for query suggestions for
  *             an index.</p>
- *         <p>This is used to check the current settings that are applied to a
+ *          <p>This is used to check the current settings that are applied to a
  *             block list.</p>
- *         <p>
+ *          <p>
  *             <code>DescribeQuerySuggestionsBlockList</code> is currently not supported in the
  *             Amazon Web Services GovCloud (US-West) region.</p>
  * @example

diff --git a/clients/client-kendra/src/commands/DescribeQuerySuggestionsConfigCommand.ts b/clients/client-kendra/src/commands/DescribeQuerySuggestionsConfigCommand.ts
@@ -32,9 +32,9 @@ export interface DescribeQuerySuggestionsConfigCommandOutput
 
 /**
  * <p>Gets information on the settings of query suggestions for an index.</p>
- *         <p>This is used to check the current settings applied
+ *          <p>This is used to check the current settings applied
  *             to query suggestions.</p>
- *         <p>
+ *          <p>
  *             <code>DescribeQuerySuggestionsConfig</code> is currently not supported in the
  *             Amazon Web Services GovCloud (US-West) region.</p>
  * @example

diff --git a/clients/client-kendra/src/commands/GetQuerySuggestionsCommand.ts b/clients/client-kendra/src/commands/GetQuerySuggestionsCommand.ts
@@ -30,7 +30,7 @@ export interface GetQuerySuggestionsCommandOutput extends GetQuerySuggestionsRes
 
 /**
  * <p>Fetches the queries that are suggested to your users.</p>
- *         <p>
+ *          <p>
  *             <code>GetQuerySuggestions</code> is currently not supported in the
  *             Amazon Web Services GovCloud (US-West) region.</p>
  * @example

diff --git a/clients/client-kendra/src/commands/ListGroupsOlderThanOrderingIdCommand.ts b/clients/client-kendra/src/commands/ListGroupsOlderThanOrderingIdCommand.ts
@@ -33,7 +33,7 @@ export interface ListGroupsOlderThanOrderingIdCommandOutput
 /**
  * <p>Provides a list of groups that are mapped to users before a
  *             given ordering or timestamp identifier.</p>
- *         <p>
+ *          <p>
  *             <code>ListGroupsOlderThanOrderingId</code> is currently not supported in the
  *             Amazon Web Services GovCloud (US-West) region.</p>
  * @example

diff --git a/clients/client-kendra/src/commands/ListQuerySuggestionsBlockListsCommand.ts b/clients/client-kendra/src/commands/ListQuerySuggestionsBlockListsCommand.ts
@@ -32,10 +32,10 @@ export interface ListQuerySuggestionsBlockListsCommandOutput
 
 /**
  * <p>Lists the block lists used for query suggestions for an index.</p>
- *         <p>For information on the current quota limits for block lists, see
+ *          <p>For information on the current quota limits for block lists, see
  *             <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas
  *                 for Amazon Kendra</a>.</p>
- *         <p>
+ *          <p>
  *             <code>ListQuerySuggestionsBlockLists</code> is currently not supported in the
  *             Amazon Web Services GovCloud (US-West) region.</p>
  * @example

diff --git a/clients/client-kendra/src/commands/PutPrincipalMappingCommand.ts b/clients/client-kendra/src/commands/PutPrincipalMappingCommand.ts
@@ -26,21 +26,21 @@ export interface PutPrincipalMappingCommandOutput extends __MetadataBearer {}
 /**
  * <p>Maps users to their groups so that you only need to provide
  *             the user ID when you issue the query.</p>
- *         <p>You can also map sub groups to groups.
+ *          <p>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.</p>
- *         <p>This is useful for user context filtering, where search results are
+ *          <p>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
  *             <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">Filtering
  *                 on user context</a>.</p>
- *         <p>If more than five <code>PUT</code> actions for a group are currently
+ *          <p>If more than five <code>PUT</code> actions for a group are currently
  *             processing, a validation exception is thrown.</p>
- *         <p>
+ *          <p>
  *             <code>PutPrincipalMapping</code> is currently not supported in the
  *             Amazon Web Services GovCloud (US-West) region.</p>
  * @example

diff --git a/clients/client-kendra/src/commands/QueryCommand.ts b/clients/client-kendra/src/commands/QueryCommand.ts
@@ -26,14 +26,13 @@ export interface QueryCommandInput extends QueryRequest {}
 export interface QueryCommandOutput extends QueryResult, __MetadataBearer {}
 
 /**
- * <p>Searches an active index. Use this API to search your documents
- *          using query. The <code>Query</code> API enables to do faceted
- *          search and to filter results based on document attributes.</p>
- *          <p>It also enables you to provide user context that Amazon Kendra uses
- *          to enforce document access control in the search results.</p>
- *          <p>Amazon Kendra searches your index for text content and question and
- *          answer (FAQ) content. By default the response contains three types of
- *          results.</p>
+ * <p>Searches an active index. Use this API to search your documents using query. The
+ *             <code>Query</code> API enables to do faceted search and to filter results based on
+ *          document attributes.</p>
+ *          <p>It also enables you to provide user context that Amazon Kendra uses to enforce
+ *          document access control in the search results.</p>
+ *          <p>Amazon Kendra searches your index for text content and question and answer (FAQ)
+ *          content. By default the response contains three types of results.</p>
  *          <ul>
  *             <li>
  *                <p>Relevant passages</p>
@@ -45,8 +44,8 @@ export interface QueryCommandOutput extends QueryResult, __MetadataBearer {}
  *                <p>Relevant documents</p>
  *             </li>
  *          </ul>
- *          <p>You can specify that the query return only one type of result using
- *          the <code>QueryResultTypeConfig</code> parameter.</p>
+ *          <p>You can specify that the query return only one type of result using the
+ *             <code>QueryResultTypeConfig</code> parameter.</p>
  *          <p>Each query returns the 100 most relevant results. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-kendra/src/commands/SubmitFeedbackCommand.ts b/clients/client-kendra/src/commands/SubmitFeedbackCommand.ts
@@ -26,7 +26,7 @@ export interface SubmitFeedbackCommandOutput extends __MetadataBearer {}
 /**
  * <p>Enables you to provide feedback to Amazon Kendra to improve the
  *             performance of your index.</p>
- *         <p>
+ *          <p>
  *             <code>SubmitFeedback</code> is currently not supported in the
  *             Amazon Web Services GovCloud (US-West) region.</p>
  * @example

diff --git a/clients/client-kendra/src/commands/UpdateAccessControlConfigurationCommand.ts b/clients/client-kendra/src/commands/UpdateAccessControlConfigurationCommand.ts
@@ -35,15 +35,15 @@ export interface UpdateAccessControlConfigurationCommandOutput
  *             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.</p>
- *         <p>You can update an access control configuration you created without indexing all
+ *          <p>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.</p>
- *         <p>You call the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a> API to
+ *          <p>You call the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a> API to
  *             apply the updated access control configuration, with the
  *                 <code>AccessControlConfigurationId</code> included in the
  *             <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>