Package software.amazon.awssdk.services.kendra.model

Class QueryResponse

    • Method Detail

      • queryId

        public final String queryId()

        The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API.

        Returns:
        The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API.

      • hasResultItems

        public final boolean hasResultItems()
        For responses, this returns true if the service returned a value for the ResultItems property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • resultItems

        public final List<QueryResultItem> resultItems()

        The results of the search.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResultItems() method.

        Returns:
        The results of the search.

      • hasFacetResults

        public final boolean hasFacetResults()
        For responses, this returns true if the service returned a value for the FacetResults property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • facetResults

        public final List<FacetResult> facetResults()

        Contains the facet results. A FacetResult contains the counts for each field/attribute key that was specified in the Facets input parameter.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFacetResults() method.

        Returns:
        Contains the facet results. A FacetResult contains the counts for each field/attribute key that was specified in the Facets input parameter.

      • totalNumberOfResults

        public final Integer totalNumberOfResults()

        The total number of items found by the search. However, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.

        Returns:
        The total number of items found by the search. However, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.

      • hasWarnings

        public final boolean hasWarnings()
        For responses, this returns true if the service returned a value for the Warnings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • warnings

        public final List<Warning> warnings()

        A list of warning codes and their messages on problems with your query.

        Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see Searching with advanced query syntax.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWarnings() method.

        Returns:
        A list of warning codes and their messages on problems with your query.

        Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see Searching with advanced query syntax.

      • hasSpellCorrectedQueries

        public final boolean hasSpellCorrectedQueries()
        For responses, this returns true if the service returned a value for the SpellCorrectedQueries property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • spellCorrectedQueries

        public final List<SpellCorrectedQuery> spellCorrectedQueries()

        A list of information related to suggested spell corrections for a query.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSpellCorrectedQueries() method.

        Returns:
        A list of information related to suggested spell corrections for a query.

      • hasFeaturedResultsItems

        public final boolean hasFeaturedResultsItems()
        For responses, this returns true if the service returned a value for the FeaturedResultsItems property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • featuredResultsItems

        public final List<FeaturedResultsItem> featuredResultsItems()

        The list of featured result items. Featured results are 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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFeaturedResultsItems() method.

        Returns:
        The list of featured result items. Featured results are 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.

      • toString

        public final 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