Package software.amazon.awscdk.cfnpropertymixins.services.bedrock

Interface CfnKnowledgeBasePropsMixin.NeptuneAnalyticsFieldMappingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBasePropsMixin.NeptuneAnalyticsFieldMappingProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBasePropsMixin

@Stability(Stable)
public static interface CfnKnowledgeBasePropsMixin.NeptuneAnalyticsFieldMappingProperty
extends software.amazon.jsii.JsiiSerializable

Contains the names of the fields to which to map information about the vector store.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.bedrock.*;
 NeptuneAnalyticsFieldMappingProperty neptuneAnalyticsFieldMappingProperty = NeptuneAnalyticsFieldMappingProperty.builder()
         .metadataField("metadataField")
         .textField("textField")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-neptuneanalyticsfieldmapping.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnKnowledgeBasePropsMixin.NeptuneAnalyticsFieldMappingProperty.Builder	A builder for CfnKnowledgeBasePropsMixin.NeptuneAnalyticsFieldMappingProperty
static final class	CfnKnowledgeBasePropsMixin.NeptuneAnalyticsFieldMappingProperty.Jsii$Proxy	An implementation for CfnKnowledgeBasePropsMixin.NeptuneAnalyticsFieldMappingProperty

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBasePropsMixin.NeptuneAnalyticsFieldMappingProperty.Builder	builder()
default String	getMetadataField()	The name of the field in which Amazon Bedrock stores metadata about the vector store.
default String	getTextField()	The name of the field in which Amazon Bedrock stores the raw text from your data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetadataField

@Stability(Stable)
@Nullable
default String getMetadataField()

The name of the field in which Amazon Bedrock stores metadata about the vector store.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-neptuneanalyticsfieldmapping.html#cfn-bedrock-knowledgebase-neptuneanalyticsfieldmapping-metadatafield

getTextField

@Stability(Stable)
@Nullable
default String getTextField()

The name of the field in which Amazon Bedrock stores the raw text from your data.

The text is split according to the chunking strategy you choose.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-neptuneanalyticsfieldmapping.html#cfn-bedrock-knowledgebase-neptuneanalyticsfieldmapping-textfield

builder

@Stability(Stable)
static CfnKnowledgeBasePropsMixin.NeptuneAnalyticsFieldMappingProperty.Builder builder()

Returns:

a CfnKnowledgeBasePropsMixin.NeptuneAnalyticsFieldMappingProperty.Builder of CfnKnowledgeBasePropsMixin.NeptuneAnalyticsFieldMappingProperty