interface MetadataConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.S3Vectors.Mixins.CfnIndexPropsMixin.MetadataConfigurationProperty |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awss3vectors/mixins#CfnIndexPropsMixin_MetadataConfigurationProperty |
 Java | software.amazon.awscdk.mixins.preview.services.s3vectors.mixins.CfnIndexPropsMixin.MetadataConfigurationProperty |
 Python | aws_cdk.mixins_preview.aws_s3vectors.mixins.CfnIndexPropsMixin.MetadataConfigurationProperty |
 TypeScript | @aws-cdk/mixins-preview » aws_s3vectors » mixins » CfnIndexPropsMixin » MetadataConfigurationProperty |
The metadata configuration for the vector index.
This configuration allows you to specify which metadata keys should be treated as non-filterable.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as s3vectors_mixins } from '@aws-cdk/mixins-preview/aws-s3vectors';
const metadataConfigurationProperty: s3vectors_mixins.CfnIndexPropsMixin.MetadataConfigurationProperty = {
nonFilterableMetadataKeys: ['nonFilterableMetadataKeys'],
};
Properties
| Name | Type | Description |
|---|---|---|
| non | string[] | Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. |
nonFilterableMetadataKeys?
Type:
string[]
(optional)
Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval.
Unlike default metadata keys, these keys can't be used as query filters. Non-filterable metadata keys can be retrieved but can't be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors.
You can specify 1 to 10 non-filterable metadata keys. Each key must be 1 to 63 characters long.