Package software.amazon.awscdk.services.bedrock

Interface CfnKnowledgeBase.OpenSearchServerlessFieldMappingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBase.OpenSearchServerlessFieldMappingProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBase

@Stability(Stable)
public static interface CfnKnowledgeBase.OpenSearchServerlessFieldMappingProperty
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.services.bedrock.*;
 OpenSearchServerlessFieldMappingProperty openSearchServerlessFieldMappingProperty = OpenSearchServerlessFieldMappingProperty.builder()
         .metadataField("metadataField")
         .textField("textField")
         .vectorField("vectorField")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBase.OpenSearchServerlessFieldMappingProperty.Builder	builder()
String	getMetadataField()	The name of the field in which Amazon Bedrock stores metadata about the vector store.
String	getTextField()	The name of the field in which Amazon Bedrock stores the raw text from your data.
String	getVectorField()	The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetadataField

@Stability(Stable)
@NotNull
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-opensearchserverlessfieldmapping.html#cfn-bedrock-knowledgebase-opensearchserverlessfieldmapping-metadatafield

getTextField

@Stability(Stable)
@NotNull
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-opensearchserverlessfieldmapping.html#cfn-bedrock-knowledgebase-opensearchserverlessfieldmapping-textfield

getVectorField

@Stability(Stable)
@NotNull
String getVectorField()

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.

See Also:

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

builder

@Stability(Stable)
static CfnKnowledgeBase.OpenSearchServerlessFieldMappingProperty.Builder builder()

Returns:

a CfnKnowledgeBase.OpenSearchServerlessFieldMappingProperty.Builder of CfnKnowledgeBase.OpenSearchServerlessFieldMappingProperty