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

Class VectorSearchBedrockRerankingModelConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrock.model.VectorSearchBedrockRerankingModelConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<VectorSearchBedrockRerankingModelConfiguration.Builder,VectorSearchBedrockRerankingModelConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class VectorSearchBedrockRerankingModelConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VectorSearchBedrockRerankingModelConfiguration.Builder,VectorSearchBedrockRerankingModelConfiguration>

Configuration for the Amazon Bedrock foundation model used for reranking vector search results. This specifies which model to use and any additional parameters required by the model.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VectorSearchBedrockRerankingModelConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,Document>	additionalModelRequestFields()	A list of additional fields to include in the model request during reranking.
static VectorSearchBedrockRerankingModelConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalModelRequestFields()	For responses, this returns true if the service returned a value for the AdditionalModelRequestFields property.
int	hashCode()
String	modelArn()	The Amazon Resource Name (ARN) of the foundation model to use for reranking.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends VectorSearchBedrockRerankingModelConfiguration.Builder>	serializableBuilderClass()
VectorSearchBedrockRerankingModelConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

modelArn

public final String modelArn()

The Amazon Resource Name (ARN) of the foundation model to use for reranking. This model processes the query and search results to determine a more relevant ordering.

Returns:

The Amazon Resource Name (ARN) of the foundation model to use for reranking. This model processes the query and search results to determine a more relevant ordering.

hasAdditionalModelRequestFields

public final boolean hasAdditionalModelRequestFields()

For responses, this returns true if the service returned a value for the AdditionalModelRequestFields 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.

additionalModelRequestFields

public final Map<String,Document> additionalModelRequestFields()

A list of additional fields to include in the model request during reranking. These fields provide extra context or configuration options specific to the selected foundation model.

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

Returns:

A list of additional fields to include in the model request during reranking. These fields provide extra context or configuration options specific to the selected foundation model.

toBuilder

public VectorSearchBedrockRerankingModelConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VectorSearchBedrockRerankingModelConfiguration.Builder,VectorSearchBedrockRerankingModelConfiguration>

builder

public static VectorSearchBedrockRerankingModelConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends VectorSearchBedrockRerankingModelConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo