Package software.amazon.awssdk.services.sagemaker.model

Class GenerativeAiSettings

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.GenerativeAiSettings

All Implemented Interfaces:

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

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

The generative AI settings for the SageMaker Canvas application.

Configure these settings for Canvas users starting chats with generative AI foundation models. For more information, see Use generative AI with foundation models.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GenerativeAiSettings.Builder

Method Summary

Modifier and Type	Method	Description
String	amazonBedrockRoleArn()	The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in Amazon Bedrock.
static GenerativeAiSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GenerativeAiSettings.Builder>	serializableBuilderClass()
GenerativeAiSettings.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

amazonBedrockRoleArn

public final String amazonBedrockRoleArn()

The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that establishes bedrock.amazonaws.com as a service principal.

Returns:

The ARN of an Amazon Web Services IAM role that allows fine-tuning of large language models (LLMs) in Amazon Bedrock. The IAM role should have Amazon S3 read and write permissions, as well as a trust relationship that establishes bedrock.amazonaws.com as a service principal.

toBuilder

public GenerativeAiSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GenerativeAiSettings.Builder,GenerativeAiSettings>

builder

public static GenerativeAiSettings.Builder builder()

serializableBuilderClass

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