Experimental
@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
BedrockFoundationModelProps Struct
Properties for configuring a Bedrock Foundation Model.
These properties define the model's capabilities and supported features.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_alpha from '@aws-cdk/aws-bedrock-alpha';
const bedrockFoundationModelProps: bedrock_alpha.BedrockFoundationModelProps = {
legacy: false,
optimizedForAgents: false,
supportedVectorType: [bedrock_alpha.VectorType.FLOATING_POINT],
supportsAgents: false,
supportsConfigurableDimensions: false,
supportsCrossRegion: false,
supportsKnowledgeBase: false,
vectorDimensions: 123,
};
Properties
optimizedForAgentsbooleanoptimized_for_agentsbooloptimizedForAgentsBooleanOptimizedForAgentsboolOptimizedForAgents*bool= false#When true, the model has been specifically optimized for agent interactions.
supportedVectorTypeVectorType[]supported_vector_typetyping.List[VectorType]supportedVectorTypeList<VectorType>SupportedVectorTypeVectorType[]SupportedVectorType*[]VectorType= undefined#Defines whether the model supports floating-point or binary vectors.
supportsAgentsbooleansupports_agentsboolsupportsAgentsBooleanSupportsAgentsboolSupportsAgents*bool= false#When true, the model can be used with Bedrock Agents for automated task execution.
supportsConfigurableDimensionsbooleansupports_configurable_dimensionsboolsupportsConfigurableDimensionsBooleanSupportsConfigurableDimensionsboolSupportsConfigurableDimensions*bool= false#Only applicable for embedding models. When true, vectorDimensions is passed to the knowledge base; when false, the model's dimension is fixed and vectorDimensions is informational only.
supportsCrossRegionbooleansupports_cross_regionboolsupportsCrossRegionBooleanSupportsCrossRegionboolSupportsCrossRegion*bool= false#When true, the model supports inference across different AWS regions.
supportsKnowledgeBasebooleansupports_knowledge_baseboolsupportsKnowledgeBaseBooleanSupportsKnowledgeBaseboolSupportsKnowledgeBase*bool= false#When true, the model can be used for knowledge base operations.
vectorDimensionsnumbervector_dimensionsint | floatvectorDimensionsNumberVectorDimensionsdoubleVectorDimensions*float64= undefined#Only applicable for embedding models. Defines the dimensionality of the vector embeddings.