Package software.amazon.awscdk.services.bedrock.alpha

Class BedrockFoundationModel.Builder

java.lang.Object
software.amazon.awscdk.services.bedrock.alpha.BedrockFoundationModel.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<BedrockFoundationModel>
Enclosing class:
BedrockFoundationModel
@Stability(Experimental) public static final class BedrockFoundationModel.Builder extends Object implements software.amazon.jsii.Builder<BedrockFoundationModel>
(experimental) A fluent builder for BedrockFoundationModel.

  • Method Details

    • create

      @Stability(Experimental) public static BedrockFoundationModel.Builder create(String value)
      Parameters:
      value - This parameter is required.
      Returns:
      a new instance of BedrockFoundationModel.Builder.

    • legacy

      @Stability(Experimental) public BedrockFoundationModel.Builder legacy(Boolean legacy)
      (experimental) https://docs.aws.amazon.com/bedrock/latest/userguide/model-lifecycle.html A version is marked Legacy when there is a more recent version which provides superior performance. Amazon Bedrock sets an EOL date for Legacy versions.

      Default: - false

      Parameters:
      legacy - https://docs.aws.amazon.com/bedrock/latest/userguide/model-lifecycle.html A version is marked Legacy when there is a more recent version which provides superior performance. Amazon Bedrock sets an EOL date for Legacy versions. This parameter is required.
      Returns:
      this

    • optimizedForAgents

      @Stability(Experimental) public BedrockFoundationModel.Builder optimizedForAgents(Boolean optimizedForAgents)
      (experimental) Currently, some of the offered models are optimized with prompts/parsers fine-tuned for integrating with the agents architecture.

      When true, the model has been specifically optimized for agent interactions.

      Default: - false

      Parameters:
      optimizedForAgents - Currently, some of the offered models are optimized with prompts/parsers fine-tuned for integrating with the agents architecture. This parameter is required.
      Returns:
      this

    • supportedVectorType

      @Stability(Experimental) public BedrockFoundationModel.Builder supportedVectorType(List<? extends VectorType> supportedVectorType)
      (experimental) Embeddings models have different supported vector types.

      Defines whether the model supports floating-point or binary vectors.

      Default: - undefined

      Parameters:
      supportedVectorType - Embeddings models have different supported vector types. This parameter is required.
      Returns:
      this

    • supportsAgents

      @Stability(Experimental) public BedrockFoundationModel.Builder supportsAgents(Boolean supportsAgents)
      (experimental) Bedrock Agents can use this model.

      When true, the model can be used with Bedrock Agents for automated task execution.

      Default: - false

      Parameters:
      supportsAgents - Bedrock Agents can use this model. This parameter is required.
      Returns:
      this

    • supportsCrossRegion

      @Stability(Experimental) public BedrockFoundationModel.Builder supportsCrossRegion(Boolean supportsCrossRegion)
      (experimental) Can be used with a Cross-Region Inference Profile.

      When true, the model supports inference across different AWS regions.

      Default: - false

      Parameters:
      supportsCrossRegion - Can be used with a Cross-Region Inference Profile. This parameter is required.
      Returns:
      this

    • supportsKnowledgeBase

      @Stability(Experimental) public BedrockFoundationModel.Builder supportsKnowledgeBase(Boolean supportsKnowledgeBase)
      (experimental) Bedrock Knowledge Base can use this model.

      When true, the model can be used for knowledge base operations.

      Default: - false

      Parameters:
      supportsKnowledgeBase - Bedrock Knowledge Base can use this model. This parameter is required.
      Returns:
      this

    • vectorDimensions

      @Stability(Experimental) public BedrockFoundationModel.Builder vectorDimensions(Number vectorDimensions)
      (experimental) Embedding models have different vector dimensions.

      Only applicable for embedding models. Defines the dimensionality of the vector embeddings.

      Default: - undefined

      Parameters:
      vectorDimensions - Embedding models have different vector dimensions. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public BedrockFoundationModel build()
      Specified by:
      build in interface software.amazon.jsii.Builder<BedrockFoundationModel>
      Returns:
      a newly built instance of BedrockFoundationModel.