QueryResultItem.Builder (AWS Java SDK :: Services

All Superinterfaces:

Buildable, CopyableBuilder<QueryResultItem.Builder,QueryResultItem>, SdkBuilder<QueryResultItem.Builder,QueryResultItem>, SdkPojo

Enclosing class:

QueryResultItem
```
public static interface QueryResultItem.Builder
extends SdkPojo, CopyableBuilder<QueryResultItem.Builder,QueryResultItem>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`QueryResultItem.Builder`	`additionalAttributes(AdditionalResultAttribute... additionalAttributes)` One or more additional attributes associated with the query result.
`QueryResultItem.Builder`	`additionalAttributes(Collection<AdditionalResultAttribute> additionalAttributes)` One or more additional attributes associated with the query result.
`QueryResultItem.Builder`	`additionalAttributes(Consumer<AdditionalResultAttribute.Builder>... additionalAttributes)` One or more additional attributes associated with the query result.
`QueryResultItem.Builder`	`documentAttributes(Collection<DocumentAttribute> documentAttributes)` An array of document attributes assigned to a document in the search results.
`QueryResultItem.Builder`	`documentAttributes(Consumer<DocumentAttribute.Builder>... documentAttributes)` An array of document attributes assigned to a document in the search results.
`QueryResultItem.Builder`	`documentAttributes(DocumentAttribute... documentAttributes)` An array of document attributes assigned to a document in the search results.
`default QueryResultItem.Builder`	`documentExcerpt(Consumer<TextWithHighlights.Builder> documentExcerpt)` An extract of the text in the document.
`QueryResultItem.Builder`	`documentExcerpt(TextWithHighlights documentExcerpt)` An extract of the text in the document.
`QueryResultItem.Builder`	`documentId(String documentId)` The identifier for the document.
`default QueryResultItem.Builder`	`documentTitle(Consumer<TextWithHighlights.Builder> documentTitle)` The title of the document.
`QueryResultItem.Builder`	`documentTitle(TextWithHighlights documentTitle)` The title of the document.
`QueryResultItem.Builder`	`documentURI(String documentURI)` The URI of the original location of the document.
`QueryResultItem.Builder`	`feedbackToken(String feedbackToken)` A token that identifies a particular result from a particular query.
`QueryResultItem.Builder`	`format(QueryResultFormat format)` If the `Type` of document within the response is `ANSWER`, then it is either a `TABLE` answer or `TEXT` answer.
`QueryResultItem.Builder`	`format(String format)` If the `Type` of document within the response is `ANSWER`, then it is either a `TABLE` answer or `TEXT` answer.
`QueryResultItem.Builder`	`id(String id)` The identifier for the query result.
`default QueryResultItem.Builder`	`scoreAttributes(Consumer<ScoreAttributes.Builder> scoreAttributes)` Indicates the confidence that Amazon Kendra has that a result matches the query that you provided.
`QueryResultItem.Builder`	`scoreAttributes(ScoreAttributes scoreAttributes)` Indicates the confidence that Amazon Kendra has that a result matches the query that you provided.
`default QueryResultItem.Builder`	`tableExcerpt(Consumer<TableExcerpt.Builder> tableExcerpt)` An excerpt from a table within a document.
`QueryResultItem.Builder`	`tableExcerpt(TableExcerpt tableExcerpt)` An excerpt from a table within a document.
`QueryResultItem.Builder`	`type(QueryResultType type)` The type of document within the response.
`QueryResultItem.Builder`	`type(String type)` The type of document within the response.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - id
```
QueryResultItem.Builder id(String id)
```
    The identifier for the query result.
    
    Parameters:
    
    id - The identifier for the query result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - type
```
QueryResultItem.Builder type(String type)
```
    The type of document within the response. For example, a response could include a question-answer that's relevant to the query.
    
    Parameters:
    
    type - The type of document within the response. For example, a response could include a question-answer that's relevant to the query.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    QueryResultType, QueryResultType
  - type
```
QueryResultItem.Builder type(QueryResultType type)
```
    The type of document within the response. For example, a response could include a question-answer that's relevant to the query.
    
    Parameters:
    
    type - The type of document within the response. For example, a response could include a question-answer that's relevant to the query.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    QueryResultType, QueryResultType
  - format
```
QueryResultItem.Builder format(String format)
```
    If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt.
    
    Parameters:
    
    format - If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    QueryResultFormat, QueryResultFormat
  - format
```
QueryResultItem.Builder format(QueryResultFormat format)
```
    If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt.
    
    Parameters:
    
    format - If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    QueryResultFormat, QueryResultFormat
  - additionalAttributes
```
QueryResultItem.Builder additionalAttributes(Collection<AdditionalResultAttribute> additionalAttributes)
```
    One or more additional attributes associated with the query result.
    
    Parameters:
    
    additionalAttributes - One or more additional attributes associated with the query result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - additionalAttributes
```
QueryResultItem.Builder additionalAttributes(AdditionalResultAttribute... additionalAttributes)
```
    One or more additional attributes associated with the query result.
    
    Parameters:
    
    additionalAttributes - One or more additional attributes associated with the query result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - additionalAttributes
```
QueryResultItem.Builder additionalAttributes(Consumer<AdditionalResultAttribute.Builder>... additionalAttributes)
```
    One or more additional attributes associated with the query result.
    This is a convenience method that creates an instance of the AdditionalResultAttribute.Builder avoiding the need to create one manually via AdditionalResultAttribute.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #additionalAttributes(List).
    
    Parameters:
    
    additionalAttributes - a consumer that will call methods on AdditionalResultAttribute.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #additionalAttributes(java.util.Collection)
  - documentId
```
QueryResultItem.Builder documentId(String documentId)
```
    The identifier for the document.
    
    Parameters:
    
    documentId - The identifier for the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - documentTitle
```
QueryResultItem.Builder documentTitle(TextWithHighlights documentTitle)
```
    The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.
    
    Parameters:
    
    documentTitle - The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - documentTitle
```
default QueryResultItem.Builder documentTitle(Consumer<TextWithHighlights.Builder> documentTitle)
```
    The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.
    This is a convenience method that creates an instance of the TextWithHighlights.Builder avoiding the need to create one manually via TextWithHighlights.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentTitle(TextWithHighlights).
    
    Parameters:
    
    documentTitle - a consumer that will call methods on TextWithHighlights.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    documentTitle(TextWithHighlights)
  - documentExcerpt
```
QueryResultItem.Builder documentExcerpt(TextWithHighlights documentExcerpt)
```
    An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.
    
    Parameters:
    
    documentExcerpt - An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - documentExcerpt
```
default QueryResultItem.Builder documentExcerpt(Consumer<TextWithHighlights.Builder> documentExcerpt)
```
    An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.
    This is a convenience method that creates an instance of the TextWithHighlights.Builder avoiding the need to create one manually via TextWithHighlights.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to documentExcerpt(TextWithHighlights).
    
    Parameters:
    
    documentExcerpt - a consumer that will call methods on TextWithHighlights.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    documentExcerpt(TextWithHighlights)
  - documentURI
```
QueryResultItem.Builder documentURI(String documentURI)
```
    The URI of the original location of the document.
    
    Parameters:
    
    documentURI - The URI of the original location of the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - documentAttributes
```
QueryResultItem.Builder documentAttributes(Collection<DocumentAttribute> documentAttributes)
```
    An array of document attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
    
    Parameters:
    
    documentAttributes - An array of document attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - documentAttributes
```
QueryResultItem.Builder documentAttributes(DocumentAttribute... documentAttributes)
```
    An array of document attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
    
    Parameters:
    
    documentAttributes - An array of document attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - documentAttributes
```
QueryResultItem.Builder documentAttributes(Consumer<DocumentAttribute.Builder>... documentAttributes)
```
    An array of document attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.
    This is a convenience method that creates an instance of the DocumentAttribute.Builder avoiding the need to create one manually via DocumentAttribute.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #documentAttributes(List).
    
    Parameters:
    
    documentAttributes - a consumer that will call methods on DocumentAttribute.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #documentAttributes(java.util.Collection)
  - scoreAttributes
```
QueryResultItem.Builder scoreAttributes(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - scoreAttributes
```
default QueryResultItem.Builder scoreAttributes(Consumer<ScoreAttributes.Builder> 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.
    This is a convenience method that creates an instance of the ScoreAttributes.Builder avoiding the need to create one manually via ScoreAttributes.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scoreAttributes(ScoreAttributes).
    
    Parameters:
    
    scoreAttributes - a consumer that will call methods on ScoreAttributes.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    scoreAttributes(ScoreAttributes)
  - feedbackToken
```
QueryResultItem.Builder feedbackToken(String feedbackToken)
```
    A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .
    
    Parameters:
    
    feedbackToken - A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tableExcerpt
```
QueryResultItem.Builder tableExcerpt(TableExcerpt tableExcerpt)
```
    An excerpt from a table within a document.
    
    Parameters:
    
    tableExcerpt - An excerpt from a table within a document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tableExcerpt
```
default QueryResultItem.Builder tableExcerpt(Consumer<TableExcerpt.Builder> tableExcerpt)
```
    An excerpt from a table within a document.
    This is a convenience method that creates an instance of the TableExcerpt.Builder avoiding the need to create one manually via TableExcerpt.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tableExcerpt(TableExcerpt).
    
    Parameters:
    
    tableExcerpt - a consumer that will call methods on TableExcerpt.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    tableExcerpt(TableExcerpt)

Interface QueryResultItem.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

id

type

type

format

format

additionalAttributes

additionalAttributes

additionalAttributes

documentId

documentTitle

documentTitle

documentExcerpt

documentExcerpt

documentURI

documentAttributes

documentAttributes

documentAttributes

scoreAttributes

scoreAttributes

feedbackToken

tableExcerpt

tableExcerpt