Package software.amazon.awssdk.services.bedrock.model

Class RerankingMetadataSelectiveModeConfiguration

    • Method Detail

      • hasFieldsToInclude

        public final boolean hasFieldsToInclude()
        For responses, this returns true if the service returned a value for the FieldsToInclude 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.

      • fieldsToInclude

        public final List<FieldForReranking> fieldsToInclude()

        A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.

        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 hasFieldsToInclude() method.

        Returns:
        A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.

      • hasFieldsToExclude

        public final boolean hasFieldsToExclude()
        For responses, this returns true if the service returned a value for the FieldsToExclude 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.

      • fieldsToExclude

        public final List<FieldForReranking> fieldsToExclude()

        A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.

        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 hasFieldsToExclude() method.

        Returns:
        A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)

      • fromFieldsToInclude

        public static RerankingMetadataSelectiveModeConfiguration fromFieldsToInclude​(List<FieldForReranking> fieldsToInclude)
        Create an instance of this class with fieldsToInclude() initialized to the given value.

        A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.

        Parameters:
        fieldsToInclude - A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.

      • fromFieldsToExclude

        public static RerankingMetadataSelectiveModeConfiguration fromFieldsToExclude​(List<FieldForReranking> fieldsToExclude)
        Create an instance of this class with fieldsToExclude() initialized to the given value.

        A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.

        Parameters:
        fieldsToExclude - A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.