interface DocumentMetadataConfigurationProperty

Language	Type name
.NET	Amazon.CDK.AWS.Kendra.CfnIndex.DocumentMetadataConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnIndex_DocumentMetadataConfigurationProperty
Java	software.amazon.awscdk.services.kendra.CfnIndex.DocumentMetadataConfigurationProperty
Python	aws_cdk.aws_kendra.CfnIndex.DocumentMetadataConfigurationProperty
TypeScript	aws-cdk-lib » aws_kendra » CfnIndex » DocumentMetadataConfigurationProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const documentMetadataConfigurationProperty: kendra.CfnIndex.DocumentMetadataConfigurationProperty = {
  name: 'name',
  type: 'type',

  // the properties below are optional
  relevance: {
    duration: 'duration',
    freshness: false,
    importance: 123,
    rankOrder: 'rankOrder',
    valueImportanceItems: [{
      key: 'key',
      value: 123,
    }],
  },
  search: {
    displayable: false,
    facetable: false,
    searchable: false,
    sortable: false,
  },
};

Properties

Name	Type	Description
name	string	The name of the index field.
type	string	The data type 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.

---

name

Type: string

The name of the index field.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-name

---

type

Type: string

The data type of the index field.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-type

---

relevance?

Type: IResolvable | RelevanceProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-relevance

---

search?

Type: IResolvable | SearchProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-documentmetadataconfiguration.html#cfn-kendra-index-documentmetadataconfiguration-search