io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel Maven / Gradle / Ivy
Show all versions of generative-ai-cdk-constructs Show documentation
package io.github.cdklabs.generative_ai_cdk_constructs.bedrock;
/**
* (experimental) Bedrock models.
*
* If you need to use a model name that doesn't exist as a static member, you
* can instantiate a BedrockFoundationModel object, e.g: new BedrockFoundationModel('my-model').
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-23T18:35:37.387Z")
@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.BedrockFoundationModel")
public class BedrockFoundationModel extends software.amazon.jsii.JsiiObject {
protected BedrockFoundationModel(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
}
protected BedrockFoundationModel(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
super(initializationMode);
}
static {
AMAZON_TITAN_PREMIER_V1_0 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "AMAZON_TITAN_PREMIER_V1_0", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
AMAZON_TITAN_TEXT_EXPRESS_V1 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "AMAZON_TITAN_TEXT_EXPRESS_V1", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
ANTHROPIC_CLAUDE_3_5_SONNET_V1_0 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "ANTHROPIC_CLAUDE_3_5_SONNET_V1_0", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
ANTHROPIC_CLAUDE_HAIKU_V1_0 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "ANTHROPIC_CLAUDE_HAIKU_V1_0", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
ANTHROPIC_CLAUDE_INSTANT_V1_2 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "ANTHROPIC_CLAUDE_INSTANT_V1_2", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
ANTHROPIC_CLAUDE_OPUS_V1_0 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "ANTHROPIC_CLAUDE_OPUS_V1_0", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
ANTHROPIC_CLAUDE_SONNET_V1_0 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "ANTHROPIC_CLAUDE_SONNET_V1_0", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
ANTHROPIC_CLAUDE_V2 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "ANTHROPIC_CLAUDE_V2", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
ANTHROPIC_CLAUDE_V2_1 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "ANTHROPIC_CLAUDE_V2_1", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
COHERE_EMBED_ENGLISH_V3 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "COHERE_EMBED_ENGLISH_V3", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
COHERE_EMBED_MULTILINGUAL_V3 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "COHERE_EMBED_MULTILINGUAL_V3", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
TITAN_EMBED_TEXT_V1 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "TITAN_EMBED_TEXT_V1", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
TITAN_EMBED_TEXT_V2_1024 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "TITAN_EMBED_TEXT_V2_1024", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
TITAN_EMBED_TEXT_V2_256 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "TITAN_EMBED_TEXT_V2_256", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
TITAN_EMBED_TEXT_V2_512 = software.amazon.jsii.JsiiObject.jsiiStaticGet(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class, "TITAN_EMBED_TEXT_V2_512", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel.class));
}
/**
* @param value This parameter is required.
* @param props
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public BedrockFoundationModel(final @org.jetbrains.annotations.NotNull java.lang.String value, final @org.jetbrains.annotations.Nullable io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModelProps props) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(value, "value is required"), props });
}
/**
* @param value This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public BedrockFoundationModel(final @org.jetbrains.annotations.NotNull java.lang.String value) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(value, "value is required") });
}
/**
* (experimental) Returns the ARN of the foundation model in the following format: arn:${Partition}:bedrock:${Region}::foundation-model/${ResourceId}.
*
* @param construct This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String asArn(final @org.jetbrains.annotations.NotNull software.constructs.IConstruct construct) {
return software.amazon.jsii.Kernel.call(this, "asArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class), new Object[] { java.util.Objects.requireNonNull(construct, "construct is required") });
}
/**
* @param construct This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.bedrock.IModel asIModel(final @org.jetbrains.annotations.NotNull software.constructs.IConstruct construct) {
return software.amazon.jsii.Kernel.call(this, "asIModel", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.bedrock.IModel.class), new Object[] { java.util.Objects.requireNonNull(construct, "construct is required") });
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String toString() {
return software.amazon.jsii.Kernel.call(this, "toString", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel AMAZON_TITAN_PREMIER_V1_0;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel AMAZON_TITAN_TEXT_EXPRESS_V1;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel ANTHROPIC_CLAUDE_3_5_SONNET_V1_0;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel ANTHROPIC_CLAUDE_HAIKU_V1_0;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel ANTHROPIC_CLAUDE_INSTANT_V1_2;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel ANTHROPIC_CLAUDE_OPUS_V1_0;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel ANTHROPIC_CLAUDE_SONNET_V1_0;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel ANTHROPIC_CLAUDE_V2;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel ANTHROPIC_CLAUDE_V2_1;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel COHERE_EMBED_ENGLISH_V3;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel COHERE_EMBED_MULTILINGUAL_V3;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel TITAN_EMBED_TEXT_V1;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel TITAN_EMBED_TEXT_V2_1024;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel TITAN_EMBED_TEXT_V2_256;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public final static io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel TITAN_EMBED_TEXT_V2_512;
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.String getModelId() {
return software.amazon.jsii.Kernel.get(this, "modelId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean getSupportsAgents() {
return software.amazon.jsii.Kernel.get(this, "supportsAgents", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.NotNull java.lang.Boolean getSupportsKnowledgeBase() {
return software.amazon.jsii.Kernel.get(this, "supportsKnowledgeBase", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
}
/**
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public @org.jetbrains.annotations.Nullable java.lang.Number getVectorDimensions() {
return software.amazon.jsii.Kernel.get(this, "vectorDimensions", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
}
/**
* (experimental) A fluent builder for {@link io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static final class Builder implements software.amazon.jsii.Builder {
/**
* @return a new instance of {@link Builder}.
* @param value This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public static Builder create(final java.lang.String value) {
return new Builder(value);
}
private final java.lang.String value;
private io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModelProps.Builder props;
private Builder(final java.lang.String value) {
this.value = value;
}
/**
* (experimental) Bedrock Agents can use this model.
*
* Default: - false
*
* @return {@code this}
* @param supportsAgents Bedrock Agents can use this model. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder supportsAgents(final java.lang.Boolean supportsAgents) {
this.props().supportsAgents(supportsAgents);
return this;
}
/**
* (experimental) Bedrock Knowledge Base can use this model.
*
* Default: - false
*
* @return {@code this}
* @param supportsKnowledgeBase Bedrock Knowledge Base can use this model. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder supportsKnowledgeBase(final java.lang.Boolean supportsKnowledgeBase) {
this.props().supportsKnowledgeBase(supportsKnowledgeBase);
return this;
}
/**
* (experimental) Embedding models have different vector dimensions.
*
* Only applicable for embedding models.
*
* @return {@code this}
* @param vectorDimensions Embedding models have different vector dimensions. This parameter is required.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public Builder vectorDimensions(final java.lang.Number vectorDimensions) {
this.props().vectorDimensions(vectorDimensions);
return this;
}
/**
* @return a newly built instance of {@link io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel}.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@Override
public io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel build() {
return new io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModel(
this.value,
this.props != null ? this.props.build() : null
);
}
private io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModelProps.Builder props() {
if (this.props == null) {
this.props = new io.github.cdklabs.generative_ai_cdk_constructs.bedrock.BedrockFoundationModelProps.Builder();
}
return this.props;
}
}
}