Amazon Kendra now supports confidence score buckets for retrieved passage results using the Retrieve API.

Author: aws-sdk-dotnet-automation

generator/ServiceModels/kendra/kendra-2019-02-03.api.json

@@ -4654,7 +4654,8 @@
         "DocumentTitle":{"shape":"DocumentTitle"},
         "Content":{"shape":"Content"},
         "DocumentURI":{"shape":"Url"},
-        "DocumentAttributes":{"shape":"DocumentAttributeList"}
+        "DocumentAttributes":{"shape":"DocumentAttributeList"},
+        "ScoreAttributes":{"shape":"ScoreAttributes"}
       }
     },
     "RetrieveResultItemList":{

generator/ServiceModels/kendra/kendra-2019-02-03.docs.json

@@ -29,35 +29,56 @@
 namespace Amazon.Kendra.Model
 {
     /// <summary>
-    /// Provides filtering the query results based on document attributes or metadata fields.
+    /// Filters the search results based on document attributes or fields.
     /// 
     ///  
     /// <para>
-    /// 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:
+    /// 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".
     /// </para>
     ///  
     /// <para>
-    ///  <code>&lt;AndAllFilters&gt;</code> 
+    /// 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:
     /// </para>
-    ///  <ol> <li> 
+    ///  
+    /// <para>
+    ///  <code>AndAllFilters</code> 
+    /// </para>
+    ///  <ul> <li> 
     /// <para>
-    ///  <code> &lt;OrAllFilters&gt;</code> 
+    ///  <code>EqualsTo</code>: "Department", "HR"
     /// </para>
     ///  </li> <li> 
     /// <para>
-    ///  <code> &lt;EqualsTo&gt;</code> 
+    ///  <code>AndOrFilters</code> 
+    /// </para>
+    ///  <ul> <li> 
+    /// <para>
+    ///  <code>ContainsAny</code>: "Project Name", ["new hires", "new hiring"]
     /// </para>
-    ///  </li> </ol> 
+    ///  </li> </ul> </li> </ul> 
     /// <para>
-    /// 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."
+    /// 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.
     /// </para>
     ///  
     /// <para>
-    /// If you use more than 10 attribute filters in a given list for <code>AndAllFilters</code>
+    /// 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 "<code>AttributeFilter</code> cannot have a length of more than 10".
+    /// the message "AttributeFilter cannot have a length of more than 10".
+    /// </para>
+    ///  
+    /// <para>
+    /// 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>.
     /// </para>
     /// </summary>
     public partial class AttributeFilter
@@ -76,7 +97,7 @@ public partial class AttributeFilter
         /// <summary>
         /// Gets and sets the property AndAllFilters. 
         /// <para>
-        /// Performs a logical <code>AND</code> operation on all supplied filters.
+        /// Performs a logical <code>AND</code> operation on all filters that you specify.
         /// </para>
         /// </summary>
         public List<AttributeFilter> AndAllFilters
@@ -94,8 +115,8 @@ internal bool IsSetAndAllFilters()
         /// <summary>
         /// Gets and sets the property ContainsAll. 
         /// <para>
-        /// 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.
+        /// 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>.
         /// </para>
         /// </summary>
         public DocumentAttribute ContainsAll
@@ -113,8 +134,8 @@ internal bool IsSetContainsAll()
         /// <summary>
         /// Gets and sets the property ContainsAny. 
         /// <para>
-        /// 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.
+        /// 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>.
         /// </para>
         /// </summary>
         public DocumentAttribute ContainsAny
@@ -132,7 +153,7 @@ internal bool IsSetContainsAny()
         /// <summary>
         /// Gets and sets the property EqualsTo. 
         /// <para>
-        /// Performs an equals operation on two document attributes or metadata fields.
+        /// Performs an equals operation on document attributes/fields and their values.
         /// </para>
         /// </summary>
         public DocumentAttribute EqualsTo
@@ -150,8 +171,9 @@ internal bool IsSetEqualsTo()
         /// <summary>
         /// Gets and sets the property GreaterThan. 
         /// <para>
-        /// 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>.
+        /// 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>.
         /// </para>
         /// </summary>
         public DocumentAttribute GreaterThan
@@ -169,8 +191,9 @@ internal bool IsSetGreaterThan()
         /// <summary>
         /// Gets and sets the property GreaterThanOrEquals. 
         /// <para>
-        /// 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>.
+        /// 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>.
         /// </para>
         /// </summary>
         public DocumentAttribute GreaterThanOrEquals
@@ -188,8 +211,9 @@ internal bool IsSetGreaterThanOrEquals()
         /// <summary>
         /// Gets and sets the property LessThan. 
         /// <para>
-        /// 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>.
+        /// 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>.
         /// </para>
         /// </summary>
         public DocumentAttribute LessThan
@@ -207,8 +231,9 @@ internal bool IsSetLessThan()
         /// <summary>
         /// Gets and sets the property LessThanOrEquals. 
         /// <para>
-        /// 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>.
+        /// 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>.
         /// </para>
         /// </summary>
         public DocumentAttribute LessThanOrEquals
@@ -226,7 +251,7 @@ internal bool IsSetLessThanOrEquals()
         /// <summary>
         /// Gets and sets the property NotFilter. 
         /// <para>
-        /// Performs a logical <code>NOT</code> operation on all supplied filters.
+        /// Performs a logical <code>NOT</code> operation on all filters that you specify.
         /// </para>
         /// </summary>
         public AttributeFilter NotFilter
@@ -244,7 +269,7 @@ internal bool IsSetNotFilter()
         /// <summary>
         /// Gets and sets the property OrAllFilters. 
         /// <para>
-        /// Performs a logical <code>OR</code> operation on all supplied filters.
+        /// Performs a logical <code>OR</code> operation on all filters that you specify.
         /// </para>
         /// </summary>
         public List<AttributeFilter> OrAllFilters

generator/ServiceModels/kendra/kendra-2019-02-03.endpoint-rule-set.json

@@ -37,7 +37,14 @@ namespace Amazon.Kendra.Model
     /// <para>
     /// 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.
+    /// of 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 deleting your
+    /// documents.
+    /// </para>
+    ///  
+    /// <para>
+    /// 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.
     /// </para>
     /// </summary>
     public partial class BatchDeleteDocumentRequest : AmazonKendraRequest

generator/ServiceModels/kendra/kendra-2019-02-03.normal.json

@@ -43,7 +43,8 @@ namespace Amazon.Kendra.Model
     /// <para>
     /// 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.
+    /// 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.
     /// </para>
     ///  
     /// <para>

sdk/src/Services/Kendra/Generated/Model/AttributeFilter.cs

@@ -46,7 +46,7 @@ public partial class BatchPutDocumentResponse : AmazonWebServiceResponse
         /// <para>
         /// 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> 
+        /// Amazon Kendra with Amazon CloudWatch logs</a>.
         /// </para>
         /// </summary>
         public List<BatchPutDocumentResponseFailedDocument> FailedDocuments

sdk/src/Services/Kendra/Generated/Model/BatchDeleteDocumentRequest.cs

@@ -37,8 +37,9 @@ namespace Amazon.Kendra.Model
     /// 
     ///  
     /// <para>
-    /// Once the index is active you can index your documents using the <code>BatchPutDocument</code>
-    /// API or using one of the supported data sources.
+    /// 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>.
     /// </para>
     ///  
     /// <para>

sdk/src/Services/Kendra/Generated/Model/BatchPutDocumentRequest.cs

@@ -29,8 +29,14 @@
 namespace Amazon.Kendra.Model
 {
     /// <summary>
-    /// 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.
+    /// 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>.
     /// </summary>
     public partial class DataSourceToIndexFieldMapping
     {
@@ -41,7 +47,8 @@ public partial class DataSourceToIndexFieldMapping
         /// <summary>
         /// Gets and sets the property DataSourceFieldName. 
         /// <para>
-        /// The name of the column or attribute in the data source.
+        /// The name of the field in the data source. You must first create the index field using
+        /// the <code>UpdateIndex</code> API.
         /// </para>
         /// </summary>
         [AWSProperty(Required=true, Min=1, Max=100)]
@@ -60,7 +67,9 @@ internal bool IsSetDataSourceFieldName()
         /// <summary>
         /// Gets and sets the property DateFieldFormat. 
         /// <para>
-        /// The type of data stored in the column or attribute.
+        /// 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.
         /// </para>
         /// </summary>
         [AWSProperty(Min=4, Max=40)]
@@ -79,7 +88,8 @@ internal bool IsSetDateFieldFormat()
         /// <summary>
         /// Gets and sets the property IndexFieldName. 
         /// <para>
-        /// The name of the field in the index.
+        /// The name of the index field to map to the data source field. The index field type
+        /// must match the data source field type.
         /// </para>
         /// </summary>
         [AWSProperty(Required=true, Min=1, Max=30)]