Package software.amazon.awscdk.services.bedrock

Interface CfnKnowledgeBase.PineconeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBase.PineconeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBase

@Stability(Stable)
public static interface CfnKnowledgeBase.PineconeConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Contains details about the storage configuration of the knowledge base in Pinecone.

For more information, see Create a vector index in Pinecone .

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.*;
 PineconeConfigurationProperty pineconeConfigurationProperty = PineconeConfigurationProperty.builder()
         .connectionString("connectionString")
         .credentialsSecretArn("credentialsSecretArn")
         .fieldMapping(PineconeFieldMappingProperty.builder()
                 .metadataField("metadataField")
                 .textField("textField")
                 .build())
         // the properties below are optional
         .namespace("namespace")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBase.PineconeConfigurationProperty.Builder	builder()
String	getConnectionString()	The endpoint URL for your index management page.
String	getCredentialsSecretArn()	The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
Object	getFieldMapping()	Contains the names of the fields to which to map information about the vector store.
default String	getNamespace()	The namespace to be used to write new data to your database.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConnectionString

@Stability(Stable)
@NotNull
String getConnectionString()

The endpoint URL for your index management page.

See Also:

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

getCredentialsSecretArn

@Stability(Stable)
@NotNull
String getCredentialsSecretArn()

The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.

See Also:

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

getFieldMapping

@Stability(Stable)
@NotNull
Object getFieldMapping()

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

See Also:

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

getNamespace

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

The namespace to be used to write new data to your database.

See Also:

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

builder

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

Returns:

a CfnKnowledgeBase.PineconeConfigurationProperty.Builder of CfnKnowledgeBase.PineconeConfigurationProperty