QueryResultItem (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.kendra.model.QueryResultItem

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<QueryResultItem.Builder,QueryResultItem>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class QueryResultItem
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<QueryResultItem.Builder,QueryResultItem>
```
A single query result.

A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface QueryResultItem.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`QueryResultItem.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AdditionalResultAttribute>`	`additionalAttributes()` One or more additional attributes associated with the query result.
`static QueryResultItem.Builder`	`builder()`
`List<DocumentAttribute>`	`documentAttributes()` An array of document attributes for the document that the query result maps to.
`TextWithHighlights`	`documentExcerpt()` An extract of the text in the document.
`String`	`documentId()` The unique identifier for the document.
`TextWithHighlights`	`documentTitle()` The title of the document.
`String`	`documentURI()` The URI of the original location of the document.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdditionalAttributes()` Returns true if the AdditionalAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasDocumentAttributes()` Returns true if the DocumentAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`String`	`id()` The unique identifier for the query result.
`ScoreAttributes`	`scoreAttributes()` Indicates the confidence that Amazon Kendra has that a result matches the query that you provided.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends QueryResultItem.Builder>`	`serializableBuilderClass()`
`QueryResultItem.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`QueryResultType`	`type()` The type of document.
`String`	`typeAsString()` The type of document.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - id
```
public String id()
```
    The unique identifier for the query result.
    
    Returns:
    
    The unique identifier for the query result.
  - type
```
public QueryResultType type()
```
    The type of document.
    
    If the service returns an enum value that is not available in the current SDK version, type will return QueryResultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of document.
    
    See Also:
    
    QueryResultType
  - typeAsString
```
public String typeAsString()
```
    The type of document.
    
    If the service returns an enum value that is not available in the current SDK version, type will return QueryResultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of document.
    
    See Also:
    
    QueryResultType
  - hasAdditionalAttributes
```
public boolean hasAdditionalAttributes()
```
    Returns true if the AdditionalAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - additionalAttributes
```
public List<AdditionalResultAttribute> additionalAttributes()
```
    One or more additional attributes associated with the query result.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAdditionalAttributes() to see if a value was sent in this field.
    
    Returns:
    
    One or more additional attributes associated with the query result.
  - documentId
```
public String documentId()
```
    The unique identifier for the document.
    
    Returns:
    
    The unique identifier for the document.
  - documentTitle
```
public TextWithHighlights documentTitle()
```
    The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.
    
    Returns:
    
    The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.
  - documentExcerpt
```
public TextWithHighlights documentExcerpt()
```
    An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.
    
    Returns:
    
    An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.
  - documentURI
```
public String documentURI()
```
    The URI of the original location of the document.
    
    Returns:
    
    The URI of the original location of the document.
  - hasDocumentAttributes
```
public boolean hasDocumentAttributes()
```
    Returns true if the DocumentAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - documentAttributes
```
public List<DocumentAttribute> documentAttributes()
```
    An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasDocumentAttributes() to see if a value was sent in this field.
    
    Returns:
    
    An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.
  - scoreAttributes
```
public ScoreAttributes scoreAttributes()
```
    Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.
    
    The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.
    
    Returns:
    
    Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.
    
    The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.
  - toBuilder
```
public QueryResultItem.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<QueryResultItem.Builder,QueryResultItem>
  - builder
```
public static QueryResultItem.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends QueryResultItem.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class QueryResultItem

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

type

typeAsString

hasAdditionalAttributes

additionalAttributes

documentId

documentTitle

documentExcerpt

documentURI

hasDocumentAttributes

documentAttributes

scoreAttributes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields