Package software.amazon.awssdk.services.bedrockagentruntime.model

Class ExternalSourcesGenerationConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.ExternalSourcesGenerationConfiguration

All Implemented Interfaces:

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

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

Contains the generation configuration of the external source wrapper object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExternalSourcesGenerationConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,Document>	additionalModelRequestFields()	Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source.
static ExternalSourcesGenerationConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
GuardrailConfiguration	guardrailConfiguration()	The configuration details for the guardrail.
boolean	hasAdditionalModelRequestFields()	For responses, this returns true if the service returned a value for the AdditionalModelRequestFields property.
int	hashCode()
InferenceConfig	inferenceConfig()	Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.
PromptTemplate	promptTemplate()	Contain the textPromptTemplate string for the external source wrapper object.
List<SdkField<?>>	sdkFields()
static Class<? extends ExternalSourcesGenerationConfiguration.Builder>	serializableBuilderClass()
ExternalSourcesGenerationConfiguration.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

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()

Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.

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:

Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used.

guardrailConfiguration

public final GuardrailConfiguration guardrailConfiguration()

The configuration details for the guardrail.

Returns:

The configuration details for the guardrail.

inferenceConfig

public final InferenceConfig inferenceConfig()

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.

Returns:

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.

promptTemplate

public final PromptTemplate promptTemplate()

Contain the textPromptTemplate string for the external source wrapper object.

Returns:

Contain the textPromptTemplate string for the external source wrapper object.

toBuilder

public ExternalSourcesGenerationConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExternalSourcesGenerationConfiguration.Builder,ExternalSourcesGenerationConfiguration>

builder

public static ExternalSourcesGenerationConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ExternalSourcesGenerationConfiguration.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