interface PineconeConfigurationProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.aws_bedrock.CfnKnowledgeBase.PineconeConfigurationProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnKnowledgeBase_PineconeConfigurationProperty |
![]() | software.amazon.awscdk.services.bedrock.CfnKnowledgeBase.PineconeConfigurationProperty |
![]() | aws_cdk.aws_bedrock.CfnKnowledgeBase.PineconeConfigurationProperty |
![]() | aws-cdk-lib » aws_bedrock » CfnKnowledgeBase » PineconeConfigurationProperty |
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 { aws_bedrock as bedrock } from 'aws-cdk-lib';
const pineconeConfigurationProperty: bedrock.CfnKnowledgeBase.PineconeConfigurationProperty = {
connectionString: 'connectionString',
credentialsSecretArn: 'credentialsSecretArn',
fieldMapping: {
metadataField: 'metadataField',
textField: 'textField',
},
// the properties below are optional
namespace: 'namespace',
};
Properties
Name | Type | Description |
---|---|---|
connection | string | The endpoint URL for your index management page. |
credentials | string | The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key. |
field | IResolvable | Pinecone | Contains the names of the fields to which to map information about the vector store. |
namespace? | string | The namespace to be used to write new data to your database. |
connectionString
Type:
string
The endpoint URL for your index management page.
credentialsSecretArn
Type:
string
The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key.
fieldMapping
Type:
IResolvable
|
Pinecone
Contains the names of the fields to which to map information about the vector store.
namespace?
Type:
string
(optional)
The namespace to be used to write new data to your database.