VectorsIndexArgs class
The set of arguments for VectorsIndex. The set of arguments for VectorsIndex.
Constructors
-
VectorsIndexArgs({required Input<
String> dataType, required Input<int> dimension, required Input<String> distanceMetric, Input<List< ? encryptionConfigurations, required Input<VectorsIndexEncryptionConfiguration> ?>String> indexName, Input<VectorsIndexMetadataConfiguration?> ? metadataConfiguration, Input<String?> ? region, Input<Map< ? tags, required Input<String, String> ?>String> vectorBucketName}) -
Creates a new VectorsIndexArgs.
dataTypeData type of the vectors to be inserted into the vector index. Valid values:float32.dimensionDimensions of the vectors to be inserted into the vector index.distanceMetricDistance metric to be used for similarity search. Valid values:cosine,euclidean.encryptionConfigurationsBlock for encryption configuration for the vector index. SeeencryptionConfigurationBlock below.indexNameName of the vector index.metadataConfigurationBlock for metadata configuration for the vector index. SeemetadataConfigurationBlock below.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.tagsKey-value map of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.vectorBucketNameName of the vector bucket for the vector index.const -
VectorsIndexArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
dataType
→ Input<
String> -
Data type of the vectors to be inserted into the vector index. Valid values:
float32.final -
dimension
→ Input<
int> -
Dimensions of the vectors to be inserted into the vector index.
final
-
distanceMetric
→ Input<
String> -
Distance metric to be used for similarity search. Valid values:
cosine,euclidean.final -
encryptionConfigurations
→ Input<
List< ?VectorsIndexEncryptionConfiguration> ?> -
Block for encryption configuration for the vector index. See
encryptionConfigurationBlock below.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
indexName
→ Input<
String> -
Name of the vector index.
final
-
metadataConfiguration
→ Input<
VectorsIndexMetadataConfiguration?> ? -
Block for metadata configuration for the vector index. See
metadataConfigurationBlock below.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
vectorBucketName
→ Input<
String> -
Name of the vector bucket for the vector index.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited