AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

A single featured result item. A featured result is displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.

Inheritance Hierarchy

System.Object
  Amazon.Kendra.Model.FeaturedResultsItem

Namespace: Amazon.Kendra.Model
Assembly: AWSSDK.Kendra.dll
Version: 3.x.y.z

Syntax

C#
public class FeaturedResultsItem

The FeaturedResultsItem type exposes the following members

Constructors

NameDescription
Public Method FeaturedResultsItem()

Properties

NameTypeDescription
Public Property AdditionalAttributes System.Collections.Generic.List<Amazon.Kendra.Model.AdditionalResultAttribute>

Gets and sets the property AdditionalAttributes.

One or more additional attributes associated with the featured result.

Public Property DocumentAttributes System.Collections.Generic.List<Amazon.Kendra.Model.DocumentAttribute>

Gets and sets the property DocumentAttributes.

An array of document attributes assigned to a featured document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.

Public Property DocumentExcerpt Amazon.Kendra.Model.TextWithHighlights

Gets and sets the property DocumentExcerpt.

Public Property DocumentId System.String

Gets and sets the property DocumentId.

The identifier of the featured document.

Public Property DocumentTitle Amazon.Kendra.Model.TextWithHighlights

Gets and sets the property DocumentTitle.

Public Property DocumentURI System.String

Gets and sets the property DocumentURI.

The source URI location of the featured document.

Public Property FeedbackToken System.String

Gets and sets the property FeedbackToken.

A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.

Public Property Id System.String

Gets and sets the property Id.

The identifier of the featured result.

Public Property Type Amazon.Kendra.QueryResultType

Gets and sets the property Type.

The type of document within the featured result response. For example, a response could include a question-answer type that's relevant to the query.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5