interface DocumentMetadataConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins.CfnIndexPropsMixin.DocumentMetadataConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskendra/mixins#CfnIndexPropsMixin_DocumentMetadataConfigurationProperty`
Java	`software.amazon.awscdk.mixins.preview.services.kendra.mixins.CfnIndexPropsMixin.DocumentMetadataConfigurationProperty`
Python	`aws_cdk.mixins_preview.aws_kendra.mixins.CfnIndexPropsMixin.DocumentMetadataConfigurationProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_kendra` » `mixins` » `CfnIndexPropsMixin` » `DocumentMetadataConfigurationProperty`

Specifies the properties, such as relevance tuning and searchability, of an index field.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as kendra_mixins } from '@aws-cdk/mixins-preview/aws-kendra';
const documentMetadataConfigurationProperty: kendra_mixins.CfnIndexPropsMixin.DocumentMetadataConfigurationProperty = {
  name: 'name',
  relevance: {
    duration: 'duration',
    freshness: false,
    importance: 123,
    rankOrder: 'rankOrder',
    valueImportanceItems: [{
      key: 'key',
      value: 123,
    }],
  },
  search: {
    displayable: false,
    facetable: false,
    searchable: false,
    sortable: false,
  },
  type: 'type',
};

Properties

Name	Type	Description
name?	`string`	The name of the index field.
relevance?	`IResolvable` `\|` `RelevanceProperty`	Provides tuning parameters to determine how the field affects the search results.
search?	`IResolvable` `\|` `SearchProperty`	Provides information about how the field is used during a search.
type?	`string`	The data type of the index field.

name?

Type: string (optional)

The name of the index field.

relevance?

Type: IResolvable | RelevanceProperty (optional)

Provides tuning parameters to determine how the field affects the search results.

search?

Type: IResolvable | SearchProperty (optional)

Provides information about how the field is used during a search.

type?