io.github.cdklabs.generative_ai_cdk_constructs.bedrock.PromptVariant Maven / Gradle / Ivy
Show all versions of generative-ai-cdk-constructs Show documentation
package io.github.cdklabs.generative_ai_cdk_constructs.bedrock;
/**
* (experimental) Variants are specific sets of inputs that guide FMs on Amazon Bedrock to generate an appropriate response or output for a given task or instruction.
*
* You can optimize the prompt for specific use cases and models.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-23T22:27:31.979Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = io.github.cdklabs.generative_ai_cdk_constructs.$Module.class, fqn = "@cdklabs/generative-ai-cdk-constructs.bedrock.PromptVariant")
public abstract class PromptVariant extends software.amazon.jsii.JsiiObject {
protected PromptVariant(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected PromptVariant(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
protected PromptVariant() {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this);
}
/**
* (experimental) Static method to create a text template.
*
* @param props This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.bedrock.PromptVariant text(final @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.bedrock.TextPromptVariantProps props) {
return software.amazon.jsii.JsiiObject.jsiiStaticCall(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.PromptVariant.class, "text", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.PromptVariant.class), new Object[] { java.util.Objects.requireNonNull(props, "props is required") });
}
/**
* (experimental) The name of the prompt variant.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public abstract @org.jetbrains.annotations.NotNull java.lang.String getName();
/**
* (experimental) The name of the prompt variant.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public abstract void setName(final @org.jetbrains.annotations.NotNull java.lang.String value);
/**
* (experimental) The type of prompt template.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public abstract @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.bedrock.PromptTemplateType getTemplateType();
/**
* (experimental) The type of prompt template.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public abstract void setTemplateType(final @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.bedrock.PromptTemplateType value);
/**
* (experimental) The inference configuration.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public abstract @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.bedrock.CfnPrompt.PromptInferenceConfigurationProperty getInferenceConfiguration();
/**
* (experimental) The inference configuration.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public abstract void setInferenceConfiguration(final @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.bedrock.CfnPrompt.PromptInferenceConfigurationProperty value);
/**
* (experimental) The unique identifier of the model with which to run inference on the prompt.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public abstract @org.jetbrains.annotations.Nullable java.lang.String getModelId();
/**
* (experimental) The unique identifier of the model with which to run inference on the prompt.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public abstract void setModelId(final @org.jetbrains.annotations.Nullable java.lang.String value);
/**
* (experimental) The template configuration.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public abstract @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.bedrock.CfnPrompt.PromptTemplateConfigurationProperty getTemplateConfiguration();
/**
* (experimental) The template configuration.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public abstract void setTemplateConfiguration(final @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.bedrock.CfnPrompt.PromptTemplateConfigurationProperty value);
/**
* A proxy class which represents a concrete javascript instance of this type.
*/
@software.amazon.jsii.Internal
private static final class Jsii$Proxy extends io.github.cdklabs.generative_ai_cdk_constructs.bedrock.PromptVariant {
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
/**
* (experimental) The name of the prompt variant.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final @org.jetbrains.annotations.NotNull java.lang.String getName() {
return software.amazon.jsii.Kernel.get(this, "name", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The name of the prompt variant.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final void setName(final @org.jetbrains.annotations.NotNull java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "name", java.util.Objects.requireNonNull(value, "name is required"));
}
/**
* (experimental) The type of prompt template.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.bedrock.PromptTemplateType getTemplateType() {
return software.amazon.jsii.Kernel.get(this, "templateType", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.PromptTemplateType.class));
}
/**
* (experimental) The type of prompt template.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final void setTemplateType(final @org.jetbrains.annotations.NotNull io.github.cdklabs.generative_ai_cdk_constructs.bedrock.PromptTemplateType value) {
software.amazon.jsii.Kernel.set(this, "templateType", java.util.Objects.requireNonNull(value, "templateType is required"));
}
/**
* (experimental) The inference configuration.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.bedrock.CfnPrompt.PromptInferenceConfigurationProperty getInferenceConfiguration() {
return software.amazon.jsii.Kernel.get(this, "inferenceConfiguration", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.bedrock.CfnPrompt.PromptInferenceConfigurationProperty.class));
}
/**
* (experimental) The inference configuration.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final void setInferenceConfiguration(final @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.bedrock.CfnPrompt.PromptInferenceConfigurationProperty value) {
software.amazon.jsii.Kernel.set(this, "inferenceConfiguration", value);
}
/**
* (experimental) The unique identifier of the model with which to run inference on the prompt.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final @org.jetbrains.annotations.Nullable java.lang.String getModelId() {
return software.amazon.jsii.Kernel.get(this, "modelId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
* (experimental) The unique identifier of the model with which to run inference on the prompt.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final void setModelId(final @org.jetbrains.annotations.Nullable java.lang.String value) {
software.amazon.jsii.Kernel.set(this, "modelId", value);
}
/**
* (experimental) The template configuration.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.bedrock.CfnPrompt.PromptTemplateConfigurationProperty getTemplateConfiguration() {
return software.amazon.jsii.Kernel.get(this, "templateConfiguration", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.bedrock.CfnPrompt.PromptTemplateConfigurationProperty.class));
}
/**
* (experimental) The template configuration.
*/
@Override
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final void setTemplateConfiguration(final @org.jetbrains.annotations.Nullable software.amazon.awscdk.services.bedrock.CfnPrompt.PromptTemplateConfigurationProperty value) {
software.amazon.jsii.Kernel.set(this, "templateConfiguration", value);
}
}
}