feat(client-kendra): Amazon Kendra now supports confidence score buckets for retrieved passage results using the Retrieve API.

Author: awstools

clients/client-kendra/src/commands/BatchDeleteDocumentCommand.ts

@@ -40,7 +40,10 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
  *             the <code>BatchPutDocument</code> API.</p>
  *          <p>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.</p>
+ *             batch are sent to your Amazon Web Services CloudWatch log. You can also use the
+ *             <code>BatchGetDocumentStatus</code> API to monitor the progress of deleting your documents.</p>
+ *          <p>Deleting documents from an index using <code>BatchDeleteDocument</code> could take up
+ *             to an hour or more, depending on the number of documents you want to delete.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-kendra/src/commands/BatchPutDocumentCommand.ts

@@ -42,10 +42,9 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
  *             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.</p>
  *          <p>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.</p>
+ *             Amazon Web Services CloudWatch. Any error messages related to processing the batch
+ *             are sent to your Amazon Web Services CloudWatch log. You can also use the
+ *             <code>BatchGetDocumentStatus</code> API to monitor the progress of indexing your documents.</p>
  *          <p>For an example of ingesting inline documents using Python and Java SDKs, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html">Adding files
  *                 directly to an index</a>.</p>
  * @example

clients/client-kendra/src/commands/CreateIndexCommand.ts

@@ -40,8 +40,8 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat
  *       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>Once the index is active, you can index your documents using the
+ *         <code>BatchPutDocument</code> API or using one of the supported <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-sources.html">data sources</a>.</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

clients/client-kendra/src/commands/DeleteDataSourceCommand.ts

@@ -40,6 +40,9 @@ export interface DeleteDataSourceCommandOutput extends __MetadataBearer {}
  *       data source is already being deleted. While the data source is being deleted, the
  *         <code>Status</code> field returned by a call to the <code>DescribeDataSource</code> API is
  *       set to <code>DELETING</code>. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html">Deleting Data Sources</a>.</p>
+ *          <p>Deleting an entire data source or re-syncing your index after deleting specific documents
+ *       from a data source could take up to an hour or more, depending on the number of documents you
+ *       want to delete.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-kendra/src/commands/RetrieveCommand.ts

@@ -45,8 +45,8 @@ export interface RetrieveCommandOutput extends RetrieveResult, __MetadataBearer
  *             include question-answer or FAQ type responses from your index. The passages
  *             are text excerpts that can be semantically extracted from multiple documents
  *             and multiple parts of the same document. If in extreme cases your documents
- *             produce no relevant passages using the <code>Retrieve</code> API, you can
- *             alternatively use the <code>Query</code> API.</p>
+ *             produce zero passages using the <code>Retrieve</code> API, you can alternatively
+ *             use the <code>Query</code> API and its types of responses.</p>
  *          <p>You can also do the following:</p>
  *          <ul>
  *             <li>
@@ -61,6 +61,10 @@ export interface RetrieveCommandOutput extends RetrieveResult, __MetadataBearer
  *          </ul>
  *          <p>You can also include certain fields in the response that might provide useful
  *             additional information.</p>
+ *          <p>The <code>Retrieve</code> API shares the number of <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_CapacityUnitsConfiguration.html">query capacity
+ *             units</a> that you set for your index. For more information on what's included in
+ *             a single capacity unit and the default base capacity for an index, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html">Adjusting
+ *                 capacity</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -208,6 +212,9 @@ export interface RetrieveCommandOutput extends RetrieveResult, __MetadataBearer
  * //           },
  * //         },
  * //       ],
+ * //       ScoreAttributes: { // ScoreAttributes
+ * //         ScoreConfidence: "VERY_HIGH" || "HIGH" || "MEDIUM" || "LOW" || "NOT_AVAILABLE",
+ * //       },
  * //     },
  * //   ],
  * // };

clients/client-kendra/src/commands/StartDataSourceSyncJobCommand.ts

@@ -39,6 +39,9 @@ export interface StartDataSourceSyncJobCommandOutput extends StartDataSourceSync
  * <p>Starts a synchronization job for a data source connector. If a synchronization job is
  *       already in progress, Amazon Kendra returns a <code>ResourceInUseException</code>
  *       exception.</p>
+ *          <p>Re-syncing your data source with your index after modifying, adding, or deleting
+ *       documents from your data source respository could take up to an hour or more, depending on
+ *       the number of documents to sync.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-kendra/src/models/models_0.ts

@@ -186,25 +186,33 @@ export interface AdditionalResultAttribute {
 
 /**
  * @public
- * <p>Maps a column or attribute in the data source to an index field. You must first create the
- *       fields in the index using the <code>UpdateIndex</code> API.</p>
+ * <p>Maps attributes or field names of the documents synced from the data source
+ *       to Amazon Kendra index field names. You can set up field mappings for each
+ *       data source when calling <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_CreateDataSource.html">CreateDataSource</a>
+ *       or <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_UpdateDataSource.html">UpdateDataSource</a> API. To create custom fields, use the <code>UpdateIndex</code>
+ *       API to first create an index field and then map to the data source field. For more
+ *       information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.</p>
  */
 export interface DataSourceToIndexFieldMapping {
   /**
    * @public
-   * <p>The name of the column or attribute in the data source.</p>
+   * <p>The name of the field in the data source. You must first create the index field
+   *       using the <code>UpdateIndex</code> API.</p>
    */
   DataSourceFieldName: string | undefined;
 
   /**
    * @public
-   * <p>The type of data stored in the column or attribute.</p>
+   * <p>The format for date fields in the data source. If the field specified in
+   *       <code>DataSourceFieldName</code> is a date field, you must specify the date
+   *       format. If the field is not a date field, an exception is thrown.</p>
    */
   DateFieldFormat?: string;
 
   /**
    * @public
-   * <p>The name of the field in the index.</p>
+   * <p>The name of the index field to map to the data source field. The index field type
+   *       must match the data source field type.</p>
    */
   IndexFieldName: string | undefined;
 }
@@ -1760,9 +1768,8 @@ export interface BatchPutDocumentResponse {
    *             validation check. Each document contains an error message that indicates why the
    *             document couldn't be added to the index.</p>
    *          <p>If there was an error adding a document to an index the error is reported in your
-   *                 Amazon Web Services CloudWatch log. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-logs.html">Monitoring Amazon
-   *                 Kendra with Amazon CloudWatch Logs</a>
-   *          </p>
+   *                 Amazon Web Services CloudWatch log. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/cloudwatch-logs.html">Monitoring
+   *                     Amazon Kendra with Amazon CloudWatch logs</a>.</p>
    */
   FailedDocuments?: BatchPutDocumentResponseFailedDocument[];
 }
@@ -2640,7 +2647,8 @@ export interface SqlConfiguration {
 
 /**
  * @public
- * <p>Provides the configuration information to connect to a index. </p>
+ * <p>Provides the configuration information to an <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-database.html">Amazon Kendra supported
+ *             database</a>.</p>
  */
 export interface DatabaseConfiguration {
   /**

clients/client-kendra/src/models/models_1.ts

@@ -258,6 +258,14 @@ export interface RetrieveResultItem {
    *             or the source URI (<code>_source_uri</code>) of the document.</p>
    */
   DocumentAttributes?: DocumentAttribute[];
+
+  /**
+   * @public
+   * <p>The confidence score bucket for a retrieved passage result. The confidence
+   *             bucket provides a relative ranking that indicates how confident Amazon Kendra
+   *             is that the response is relevant to the query.</p>
+   */
+  ScoreAttributes?: ScoreAttributes;
 }
 
 /**
@@ -954,7 +962,7 @@ export interface UpdateThesaurusRequest {
 
 /**
  * @public
- * <p>Information about a document attribute. You can use document attributes as
+ * <p>Information about a document attribute or field. You can use document attributes as
  *          facets.</p>
  *          <p>For example, the document attribute or facet "Department" includes the values "HR",
  *          "Engineering", and "Accounting". You can display these values in the search results so that
@@ -994,26 +1002,26 @@ export interface Facet {
 
 /**
  * @public
- * <p>Provides the count of documents that match a particular attribute when doing a faceted
- *          search.</p>
+ * <p>Provides the count of documents that match a particular document attribute or
+ *          field when doing a faceted search.</p>
  */
 export interface DocumentAttributeValueCountPair {
   /**
    * @public
-   * <p>The value of the attribute. For example, "HR".</p>
+   * <p>The value of the attribute/field. For example, "HR".</p>
    */
   DocumentAttributeValue?: DocumentAttributeValue;
 
   /**
    * @public
-   * <p>The number of documents in the response that have the attribute value for the
-   *          key.</p>
+   * <p>The number of documents in the response that have the attribute/field value for
+   *          the key.</p>
    */
   Count?: number;
 
   /**
    * @public
-   * <p>Contains the results of a document attribute that is a nested facet. A
+   * <p>Contains the results of a document attribute/field that is a nested facet. A
    *             <code>FacetResult</code> contains the counts for each facet nested within a
    *          facet.</p>
    *          <p>For example, the document attribute or facet "Department" includes a value called
@@ -1057,98 +1065,121 @@ export interface FacetResult {
 
 /**
  * @public
- * <p>Provides filtering the query results based on document attributes or metadata
- *          fields.</p>
- *          <p>When you use the <code>AndAllFilters</code> or <code>OrAllFilters</code>, filters you
- *          can use 2 layers under the first attribute filter. For example, you can use:</p>
+ * <p>Filters the search results based on document attributes or fields.</p>
+ *          <p>You can filter results using attributes for your particular documents.
+ *          The attributes must exist in your index. For example, if your documents
+ *          include the custom attribute "Department", you can filter documents that
+ *          belong to the "HR" department. You would use the <code>EqualsTo</code>
+ *          operation to filter results or documents with "Department" equals to "HR".</p>
+ *          <p>You can use <code>AndAllFilters</code> and <code>AndOrFilters</code> in
+ *          combination with each other or with other operations such as <code>EqualsTo</code>.
+ *          For example:</p>
  *          <p>
- *             <code><AndAllFilters></code>
+ *             <code>AndAllFilters</code>
  *          </p>
- *          <ol>
+ *          <ul>
  *             <li>
  *                <p>
- *                   <code> <OrAllFilters></code>
- *                </p>
+ *                   <code>EqualsTo</code>: "Department", "HR"</p>
  *             </li>
  *             <li>
  *                <p>
- *                   <code> <EqualsTo></code>
+ *                   <code>AndOrFilters</code>
  *                </p>
+ *                <ul>
+ *                   <li>
+ *                      <p>
+ *                         <code>ContainsAny</code>: "Project Name", ["new hires", "new hiring"]</p>
+ *                   </li>
+ *                </ul>
  *             </li>
- *          </ol>
- *          <p>If you use more than 2 layers, you receive a <code>ValidationException</code> exception
- *          with the message "<code>AttributeFilter</code> cannot have a depth of more than 2."</p>
- *          <p>If you use more than 10 attribute filters in a given list for <code>AndAllFilters</code>
- *          or <code>OrAllFilters</code>, you receive a <code>ValidationException</code> with the
- *          message "<code>AttributeFilter</code> cannot have a length of more than 10".</p>
+ *          </ul>
+ *          <p>This example filters results or documents that belong to the HR department
+ *          <i>and</i> belong to projects that contain "new hires"
+ *          <i>or</i> "new hiring" in the project name (must use
+ *          <code>ContainAny</code> with <code>StringListValue</code>). This example is
+ *          filtering with a depth of 2.</p>
+ *          <p>You cannot filter more than a depth of 2, otherwise you receive a
+ *          <code>ValidationException</code> exception with the message "AttributeFilter
+ *          cannot have a depth of more than 2." Also, if you use more than 10 attribute
+ *          filters in a given list for <code>AndAllFilters</code> or <code>OrAllFilters</code>,
+ *          you receive a <code>ValidationException</code> with the message "AttributeFilter
+ *          cannot have a length of more than 10".</p>
+ *          <p>For examples of using <code>AttributeFilter</code>, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/filtering.html#search-filtering">Using
+ *          document attributes to filter search results</a>.</p>
  */
 export interface AttributeFilter {
   /**
    * @public
-   * <p>Performs a logical <code>AND</code> operation on all supplied filters.</p>
+   * <p>Performs a logical <code>AND</code> operation on all filters that you specify.</p>
    */
   AndAllFilters?: AttributeFilter[];
 
   /**
    * @public
-   * <p>Performs a logical <code>OR</code> operation on all supplied filters.</p>
+   * <p>Performs a logical <code>OR</code> operation on all filters that you specify.</p>
    */
   OrAllFilters?: AttributeFilter[];
 
   /**
    * @public
-   * <p>Performs a logical <code>NOT</code> operation on all supplied filters.</p>
+   * <p>Performs a logical <code>NOT</code> operation on all filters that you specify.</p>
    */
   NotFilter?: AttributeFilter;
 
   /**
    * @public
-   * <p>Performs an equals operation on two document attributes or metadata fields.</p>
+   * <p>Performs an equals operation on document attributes/fields and their values.</p>
    */
   EqualsTo?: DocumentAttribute;
 
   /**
    * @public
-   * <p>Returns true when a document contains all of the specified document attributes or
-   *          metadata fields. This filter is only applicable to <code>StringListValue</code>
-   *          metadata.</p>
+   * <p>Returns true when a document contains all of the specified document attributes/fields.
+   *          This filter is only applicable to <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">StringListValue</a>.</p>
    */
   ContainsAll?: DocumentAttribute;
 
   /**
    * @public
-   * <p>Returns true when a document contains any of the specified document attributes or
-   *          metadata fields. This filter is only applicable to <code>StringListValue</code>
-   *          metadata.</p>
+   * <p>Returns true when a document contains any of the specified document attributes/fields.
+   *          This filter is only applicable to <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">StringListValue</a>.</p>
    */
   ContainsAny?: DocumentAttribute;
 
   /**
    * @public
-   * <p>Performs a greater than operation on two document attributes or metadata fields. Use
-   *          with a document attribute of type <code>Date</code> or <code>Long</code>.</p>
+   * <p>Performs a greater than operation on document attributes/fields and their
+   *          values. Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
+   *             type</a>
+   *             <code>Date</code> or <code>Long</code>.</p>
    */
   GreaterThan?: DocumentAttribute;
 
   /**
    * @public
-   * <p>Performs a greater or equals than operation on two document attributes or metadata
-   *          fields. Use with a document attribute of type <code>Date</code> or
-   *          <code>Long</code>.</p>
+   * <p>Performs a greater or equals than operation on document attributes/fields and
+   *          their values. Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
+   *             type</a>
+   *             <code>Date</code> or <code>Long</code>.</p>
    */
   GreaterThanOrEquals?: DocumentAttribute;
 
   /**
    * @public
-   * <p>Performs a less than operation on two document attributes or metadata fields. Use with a
-   *          document attribute of type <code>Date</code> or <code>Long</code>.</p>
+   * <p>Performs a less than operation on document attributes/fields and their values.
+   *          Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
+   *             type</a>
+   *             <code>Date</code> or <code>Long</code>.</p>
    */
   LessThan?: DocumentAttribute;
 
   /**
    * @public
-   * <p>Performs a less than or equals operation on two document attributes or metadata fields.
-   *          Use with a document attribute of type <code>Date</code> or <code>Long</code>.</p>
+   * <p>Performs a less than or equals operation on document attributes/fields and
+   *          their values. Use with the <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_DocumentAttributeValue.html">document attribute
+   *             type</a>
+   *             <code>Date</code> or <code>Long</code>.</p>
    */
   LessThanOrEquals?: DocumentAttribute;
 }