Interface RerankingMetadataSelectiveModeConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RerankingMetadataSelectiveModeConfiguration.Builder,RerankingMetadataSelectiveModeConfiguration>, SdkBuilder<RerankingMetadataSelectiveModeConfiguration.Builder,RerankingMetadataSelectiveModeConfiguration>, SdkPojo
Enclosing class:
RerankingMetadataSelectiveModeConfiguration
@Mutable @NotThreadSafe public static interface RerankingMetadataSelectiveModeConfiguration.Builder extends SdkPojo, CopyableBuilder<RerankingMetadataSelectiveModeConfiguration.Builder,RerankingMetadataSelectiveModeConfiguration>

  • Method Details

    • fieldsToInclude

      RerankingMetadataSelectiveModeConfiguration.Builder fieldsToInclude(Collection<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.

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldsToInclude

      RerankingMetadataSelectiveModeConfiguration.Builder fieldsToInclude(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.

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldsToInclude

      RerankingMetadataSelectiveModeConfiguration.Builder fieldsToInclude(Consumer<FieldForReranking.Builder>... 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.

      This is a convenience method that creates an instance of the FieldForReranking.Builder avoiding the need to create one manually via FieldForReranking.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fieldsToInclude(List<FieldForReranking>).

      Parameters:
      fieldsToInclude - a consumer that will call methods on FieldForReranking.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • fieldsToExclude

      RerankingMetadataSelectiveModeConfiguration.Builder fieldsToExclude(Collection<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.

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldsToExclude

      RerankingMetadataSelectiveModeConfiguration.Builder fieldsToExclude(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.

      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldsToExclude

      RerankingMetadataSelectiveModeConfiguration.Builder fieldsToExclude(Consumer<FieldForReranking.Builder>... 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.

      This is a convenience method that creates an instance of the FieldForReranking.Builder avoiding the need to create one manually via FieldForReranking.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fieldsToExclude(List<FieldForReranking>).

      Parameters:
      fieldsToExclude - a consumer that will call methods on FieldForReranking.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: