2023/12/21 - Agents for Amazon Bedrock - 3 updated api methods
Changes This release introduces Amazon Aurora as a vector store on Knowledge Bases for Amazon Bedrock
{'storageConfiguration': {'rdsConfiguration': {'credentialsSecretArn': 'string',
                                               'databaseName': 'string',
                                               'fieldMapping': {'metadataField': 'string',
                                                                'primaryKeyField': 'string',
                                                                'textField': 'string',
                                                                'vectorField': 'string'},
                                               'resourceArn': 'string',
                                               'tableName': 'string'},
                          'type': {'RDS'}}}
        Response {'knowledgeBase': {'storageConfiguration': {'rdsConfiguration': {'credentialsSecretArn': 'string',
                                                                 'databaseName': 'string',
                                                                 'fieldMapping': {'metadataField': 'string',
                                                                                  'primaryKeyField': 'string',
                                                                                  'textField': 'string',
                                                                                  'vectorField': 'string'},
                                                                 'resourceArn': 'string',
                                                                 'tableName': 'string'},
                                            'type': {'RDS'}}}}
      Create a new knowledge base
See also: AWS API Documentation
Request Syntax
client.create_knowledge_base(
    clientToken='string',
    name='string',
    description='string',
    roleArn='string',
    knowledgeBaseConfiguration={
        'type': 'VECTOR',
        'vectorKnowledgeBaseConfiguration': {
            'embeddingModelArn': 'string'
        }
    },
    storageConfiguration={
        'type': 'OPENSEARCH_SERVERLESS'|'PINECONE'|'REDIS_ENTERPRISE_CLOUD'|'RDS',
        'opensearchServerlessConfiguration': {
            'collectionArn': 'string',
            'vectorIndexName': 'string',
            'fieldMapping': {
                'vectorField': 'string',
                'textField': 'string',
                'metadataField': 'string'
            }
        },
        'pineconeConfiguration': {
            'connectionString': 'string',
            'credentialsSecretArn': 'string',
            'namespace': 'string',
            'fieldMapping': {
                'textField': 'string',
                'metadataField': 'string'
            }
        },
        'redisEnterpriseCloudConfiguration': {
            'endpoint': 'string',
            'vectorIndexName': 'string',
            'credentialsSecretArn': 'string',
            'fieldMapping': {
                'vectorField': 'string',
                'textField': 'string',
                'metadataField': 'string'
            }
        },
        'rdsConfiguration': {
            'resourceArn': 'string',
            'credentialsSecretArn': 'string',
            'databaseName': 'string',
            'tableName': 'string',
            'fieldMapping': {
                'primaryKeyField': 'string',
                'vectorField': 'string',
                'textField': 'string',
                'metadataField': 'string'
            }
        }
    },
    tags={
        'string': 'string'
    }
)
string
Client specified token used for idempotency checks
This field is autopopulated if not provided.
string
[REQUIRED]
Name for a resource.
string
Description of the Resource.
string
[REQUIRED]
ARN of a IAM role.
dict
[REQUIRED]
Configures a bedrock knowledge base.
type (string) -- [REQUIRED]
The type of a knowledge base.
vectorKnowledgeBaseConfiguration (dict) --
Configurations for a vector knowledge base.
embeddingModelArn (string) -- [REQUIRED]
Arn of a Bedrock model.
dict
[REQUIRED]
Configures the physical storage of ingested data in a knowledge base.
type (string) -- [REQUIRED]
The storage type of a knowledge base.
opensearchServerlessConfiguration (dict) --
Contains the configurations to use OpenSearch Serverless to store knowledge base data.
collectionArn (string) -- [REQUIRED]
Arn of an OpenSearch Serverless collection.
vectorIndexName (string) -- [REQUIRED]
Arn of an OpenSearch Serverless index.
fieldMapping (dict) -- [REQUIRED]
A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names
vectorField (string) -- [REQUIRED]
Name of the field
textField (string) -- [REQUIRED]
Name of the field
metadataField (string) -- [REQUIRED]
Name of the field
pineconeConfiguration (dict) --
Contains the configurations to use Pinecone to store knowledge base data.
connectionString (string) -- [REQUIRED]
Pinecone connection string
credentialsSecretArn (string) -- [REQUIRED]
Arn of a SecretsManager Secret.
namespace (string) --
Pinecone namespace
fieldMapping (dict) -- [REQUIRED]
A mapping of Bedrock Knowledge Base fields to Pinecone field names
textField (string) -- [REQUIRED]
Name of the field
metadataField (string) -- [REQUIRED]
Name of the field
redisEnterpriseCloudConfiguration (dict) --
Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.
endpoint (string) -- [REQUIRED]
Redis enterprise cloud endpoint
vectorIndexName (string) -- [REQUIRED]
Name of a redis enterprise cloud index
credentialsSecretArn (string) -- [REQUIRED]
Arn of a SecretsManager Secret.
fieldMapping (dict) -- [REQUIRED]
A mapping of Bedrock Knowledge Base fields to Redis Cloud field names
vectorField (string) -- [REQUIRED]
Name of the field
textField (string) -- [REQUIRED]
Name of the field
metadataField (string) -- [REQUIRED]
Name of the field
rdsConfiguration (dict) --
Contains the configurations to use RDS to store knowledge base data.
resourceArn (string) -- [REQUIRED]
Arn of a RDS Resource.
credentialsSecretArn (string) -- [REQUIRED]
Arn of a SecretsManager Secret.
databaseName (string) -- [REQUIRED]
Name of the database within RDS
tableName (string) -- [REQUIRED]
Name of the table within RDS
fieldMapping (dict) -- [REQUIRED]
A mapping of Bedrock Knowledge Base fields to RDS column names
primaryKeyField (string) -- [REQUIRED]
Name of the column
vectorField (string) -- [REQUIRED]
Name of the column
textField (string) -- [REQUIRED]
Name of the column
metadataField (string) -- [REQUIRED]
Name of the column
dict
A map of tag keys and values
(string) --
Key of a tag
(string) --
Value of a tag
dict
Response Syntax
{
    'knowledgeBase': {
        'knowledgeBaseId': 'string',
        'name': 'string',
        'knowledgeBaseArn': 'string',
        'description': 'string',
        'roleArn': 'string',
        'knowledgeBaseConfiguration': {
            'type': 'VECTOR',
            'vectorKnowledgeBaseConfiguration': {
                'embeddingModelArn': 'string'
            }
        },
        'storageConfiguration': {
            'type': 'OPENSEARCH_SERVERLESS'|'PINECONE'|'REDIS_ENTERPRISE_CLOUD'|'RDS',
            'opensearchServerlessConfiguration': {
                'collectionArn': 'string',
                'vectorIndexName': 'string',
                'fieldMapping': {
                    'vectorField': 'string',
                    'textField': 'string',
                    'metadataField': 'string'
                }
            },
            'pineconeConfiguration': {
                'connectionString': 'string',
                'credentialsSecretArn': 'string',
                'namespace': 'string',
                'fieldMapping': {
                    'textField': 'string',
                    'metadataField': 'string'
                }
            },
            'redisEnterpriseCloudConfiguration': {
                'endpoint': 'string',
                'vectorIndexName': 'string',
                'credentialsSecretArn': 'string',
                'fieldMapping': {
                    'vectorField': 'string',
                    'textField': 'string',
                    'metadataField': 'string'
                }
            },
            'rdsConfiguration': {
                'resourceArn': 'string',
                'credentialsSecretArn': 'string',
                'databaseName': 'string',
                'tableName': 'string',
                'fieldMapping': {
                    'primaryKeyField': 'string',
                    'vectorField': 'string',
                    'textField': 'string',
                    'metadataField': 'string'
                }
            }
        },
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'FAILED',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'failureReasons': [
            'string',
        ]
    }
}
Response Structure
(dict) --
knowledgeBase (dict) --
Contains the information of a knowledge base.
knowledgeBaseId (string) --
Identifier for a resource.
name (string) --
Name for a resource.
knowledgeBaseArn (string) --
ARN of a KnowledgeBase
description (string) --
Description of the Resource.
roleArn (string) --
ARN of a IAM role.
knowledgeBaseConfiguration (dict) --
Configures a bedrock knowledge base.
type (string) --
The type of a knowledge base.
vectorKnowledgeBaseConfiguration (dict) --
Configurations for a vector knowledge base.
embeddingModelArn (string) --
Arn of a Bedrock model.
storageConfiguration (dict) --
Configures the physical storage of ingested data in a knowledge base.
type (string) --
The storage type of a knowledge base.
opensearchServerlessConfiguration (dict) --
Contains the configurations to use OpenSearch Serverless to store knowledge base data.
collectionArn (string) --
Arn of an OpenSearch Serverless collection.
vectorIndexName (string) --
Arn of an OpenSearch Serverless index.
fieldMapping (dict) --
A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names
vectorField (string) --
Name of the field
textField (string) --
Name of the field
metadataField (string) --
Name of the field
pineconeConfiguration (dict) --
Contains the configurations to use Pinecone to store knowledge base data.
connectionString (string) --
Pinecone connection string
credentialsSecretArn (string) --
Arn of a SecretsManager Secret.
namespace (string) --
Pinecone namespace
fieldMapping (dict) --
A mapping of Bedrock Knowledge Base fields to Pinecone field names
textField (string) --
Name of the field
metadataField (string) --
Name of the field
redisEnterpriseCloudConfiguration (dict) --
Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.
endpoint (string) --
Redis enterprise cloud endpoint
vectorIndexName (string) --
Name of a redis enterprise cloud index
credentialsSecretArn (string) --
Arn of a SecretsManager Secret.
fieldMapping (dict) --
A mapping of Bedrock Knowledge Base fields to Redis Cloud field names
vectorField (string) --
Name of the field
textField (string) --
Name of the field
metadataField (string) --
Name of the field
rdsConfiguration (dict) --
Contains the configurations to use RDS to store knowledge base data.
resourceArn (string) --
Arn of a RDS Resource.
credentialsSecretArn (string) --
Arn of a SecretsManager Secret.
databaseName (string) --
Name of the database within RDS
tableName (string) --
Name of the table within RDS
fieldMapping (dict) --
A mapping of Bedrock Knowledge Base fields to RDS column names
primaryKeyField (string) --
Name of the column
vectorField (string) --
Name of the column
textField (string) --
Name of the column
metadataField (string) --
Name of the column
status (string) --
The status of a knowledge base.
createdAt (datetime) --
Time Stamp.
updatedAt (datetime) --
Time Stamp.
failureReasons (list) --
Failure Reasons for Error.
(string) --
Failure Reason for Error.
{'knowledgeBase': {'storageConfiguration': {'rdsConfiguration': {'credentialsSecretArn': 'string',
                                                                 'databaseName': 'string',
                                                                 'fieldMapping': {'metadataField': 'string',
                                                                                  'primaryKeyField': 'string',
                                                                                  'textField': 'string',
                                                                                  'vectorField': 'string'},
                                                                 'resourceArn': 'string',
                                                                 'tableName': 'string'},
                                            'type': {'RDS'}}}}
      Get an existing knowledge base
See also: AWS API Documentation
Request Syntax
client.get_knowledge_base(
    knowledgeBaseId='string'
)
string
[REQUIRED]
Identifier for a resource.
dict
Response Syntax
{
    'knowledgeBase': {
        'knowledgeBaseId': 'string',
        'name': 'string',
        'knowledgeBaseArn': 'string',
        'description': 'string',
        'roleArn': 'string',
        'knowledgeBaseConfiguration': {
            'type': 'VECTOR',
            'vectorKnowledgeBaseConfiguration': {
                'embeddingModelArn': 'string'
            }
        },
        'storageConfiguration': {
            'type': 'OPENSEARCH_SERVERLESS'|'PINECONE'|'REDIS_ENTERPRISE_CLOUD'|'RDS',
            'opensearchServerlessConfiguration': {
                'collectionArn': 'string',
                'vectorIndexName': 'string',
                'fieldMapping': {
                    'vectorField': 'string',
                    'textField': 'string',
                    'metadataField': 'string'
                }
            },
            'pineconeConfiguration': {
                'connectionString': 'string',
                'credentialsSecretArn': 'string',
                'namespace': 'string',
                'fieldMapping': {
                    'textField': 'string',
                    'metadataField': 'string'
                }
            },
            'redisEnterpriseCloudConfiguration': {
                'endpoint': 'string',
                'vectorIndexName': 'string',
                'credentialsSecretArn': 'string',
                'fieldMapping': {
                    'vectorField': 'string',
                    'textField': 'string',
                    'metadataField': 'string'
                }
            },
            'rdsConfiguration': {
                'resourceArn': 'string',
                'credentialsSecretArn': 'string',
                'databaseName': 'string',
                'tableName': 'string',
                'fieldMapping': {
                    'primaryKeyField': 'string',
                    'vectorField': 'string',
                    'textField': 'string',
                    'metadataField': 'string'
                }
            }
        },
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'FAILED',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'failureReasons': [
            'string',
        ]
    }
}
Response Structure
(dict) --
knowledgeBase (dict) --
Contains the information of a knowledge base.
knowledgeBaseId (string) --
Identifier for a resource.
name (string) --
Name for a resource.
knowledgeBaseArn (string) --
ARN of a KnowledgeBase
description (string) --
Description of the Resource.
roleArn (string) --
ARN of a IAM role.
knowledgeBaseConfiguration (dict) --
Configures a bedrock knowledge base.
type (string) --
The type of a knowledge base.
vectorKnowledgeBaseConfiguration (dict) --
Configurations for a vector knowledge base.
embeddingModelArn (string) --
Arn of a Bedrock model.
storageConfiguration (dict) --
Configures the physical storage of ingested data in a knowledge base.
type (string) --
The storage type of a knowledge base.
opensearchServerlessConfiguration (dict) --
Contains the configurations to use OpenSearch Serverless to store knowledge base data.
collectionArn (string) --
Arn of an OpenSearch Serverless collection.
vectorIndexName (string) --
Arn of an OpenSearch Serverless index.
fieldMapping (dict) --
A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names
vectorField (string) --
Name of the field
textField (string) --
Name of the field
metadataField (string) --
Name of the field
pineconeConfiguration (dict) --
Contains the configurations to use Pinecone to store knowledge base data.
connectionString (string) --
Pinecone connection string
credentialsSecretArn (string) --
Arn of a SecretsManager Secret.
namespace (string) --
Pinecone namespace
fieldMapping (dict) --
A mapping of Bedrock Knowledge Base fields to Pinecone field names
textField (string) --
Name of the field
metadataField (string) --
Name of the field
redisEnterpriseCloudConfiguration (dict) --
Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.
endpoint (string) --
Redis enterprise cloud endpoint
vectorIndexName (string) --
Name of a redis enterprise cloud index
credentialsSecretArn (string) --
Arn of a SecretsManager Secret.
fieldMapping (dict) --
A mapping of Bedrock Knowledge Base fields to Redis Cloud field names
vectorField (string) --
Name of the field
textField (string) --
Name of the field
metadataField (string) --
Name of the field
rdsConfiguration (dict) --
Contains the configurations to use RDS to store knowledge base data.
resourceArn (string) --
Arn of a RDS Resource.
credentialsSecretArn (string) --
Arn of a SecretsManager Secret.
databaseName (string) --
Name of the database within RDS
tableName (string) --
Name of the table within RDS
fieldMapping (dict) --
A mapping of Bedrock Knowledge Base fields to RDS column names
primaryKeyField (string) --
Name of the column
vectorField (string) --
Name of the column
textField (string) --
Name of the column
metadataField (string) --
Name of the column
status (string) --
The status of a knowledge base.
createdAt (datetime) --
Time Stamp.
updatedAt (datetime) --
Time Stamp.
failureReasons (list) --
Failure Reasons for Error.
(string) --
Failure Reason for Error.
{'storageConfiguration': {'rdsConfiguration': {'credentialsSecretArn': 'string',
                                               'databaseName': 'string',
                                               'fieldMapping': {'metadataField': 'string',
                                                                'primaryKeyField': 'string',
                                                                'textField': 'string',
                                                                'vectorField': 'string'},
                                               'resourceArn': 'string',
                                               'tableName': 'string'},
                          'type': {'RDS'}}}
        Response {'knowledgeBase': {'storageConfiguration': {'rdsConfiguration': {'credentialsSecretArn': 'string',
                                                                 'databaseName': 'string',
                                                                 'fieldMapping': {'metadataField': 'string',
                                                                                  'primaryKeyField': 'string',
                                                                                  'textField': 'string',
                                                                                  'vectorField': 'string'},
                                                                 'resourceArn': 'string',
                                                                 'tableName': 'string'},
                                            'type': {'RDS'}}}}
      Update an existing knowledge base
See also: AWS API Documentation
Request Syntax
client.update_knowledge_base(
    knowledgeBaseId='string',
    name='string',
    description='string',
    roleArn='string',
    knowledgeBaseConfiguration={
        'type': 'VECTOR',
        'vectorKnowledgeBaseConfiguration': {
            'embeddingModelArn': 'string'
        }
    },
    storageConfiguration={
        'type': 'OPENSEARCH_SERVERLESS'|'PINECONE'|'REDIS_ENTERPRISE_CLOUD'|'RDS',
        'opensearchServerlessConfiguration': {
            'collectionArn': 'string',
            'vectorIndexName': 'string',
            'fieldMapping': {
                'vectorField': 'string',
                'textField': 'string',
                'metadataField': 'string'
            }
        },
        'pineconeConfiguration': {
            'connectionString': 'string',
            'credentialsSecretArn': 'string',
            'namespace': 'string',
            'fieldMapping': {
                'textField': 'string',
                'metadataField': 'string'
            }
        },
        'redisEnterpriseCloudConfiguration': {
            'endpoint': 'string',
            'vectorIndexName': 'string',
            'credentialsSecretArn': 'string',
            'fieldMapping': {
                'vectorField': 'string',
                'textField': 'string',
                'metadataField': 'string'
            }
        },
        'rdsConfiguration': {
            'resourceArn': 'string',
            'credentialsSecretArn': 'string',
            'databaseName': 'string',
            'tableName': 'string',
            'fieldMapping': {
                'primaryKeyField': 'string',
                'vectorField': 'string',
                'textField': 'string',
                'metadataField': 'string'
            }
        }
    }
)
string
[REQUIRED]
Identifier for a resource.
string
[REQUIRED]
Name for a resource.
string
Description of the Resource.
string
[REQUIRED]
ARN of a IAM role.
dict
[REQUIRED]
Configures a bedrock knowledge base.
type (string) -- [REQUIRED]
The type of a knowledge base.
vectorKnowledgeBaseConfiguration (dict) --
Configurations for a vector knowledge base.
embeddingModelArn (string) -- [REQUIRED]
Arn of a Bedrock model.
dict
[REQUIRED]
Configures the physical storage of ingested data in a knowledge base.
type (string) -- [REQUIRED]
The storage type of a knowledge base.
opensearchServerlessConfiguration (dict) --
Contains the configurations to use OpenSearch Serverless to store knowledge base data.
collectionArn (string) -- [REQUIRED]
Arn of an OpenSearch Serverless collection.
vectorIndexName (string) -- [REQUIRED]
Arn of an OpenSearch Serverless index.
fieldMapping (dict) -- [REQUIRED]
A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names
vectorField (string) -- [REQUIRED]
Name of the field
textField (string) -- [REQUIRED]
Name of the field
metadataField (string) -- [REQUIRED]
Name of the field
pineconeConfiguration (dict) --
Contains the configurations to use Pinecone to store knowledge base data.
connectionString (string) -- [REQUIRED]
Pinecone connection string
credentialsSecretArn (string) -- [REQUIRED]
Arn of a SecretsManager Secret.
namespace (string) --
Pinecone namespace
fieldMapping (dict) -- [REQUIRED]
A mapping of Bedrock Knowledge Base fields to Pinecone field names
textField (string) -- [REQUIRED]
Name of the field
metadataField (string) -- [REQUIRED]
Name of the field
redisEnterpriseCloudConfiguration (dict) --
Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.
endpoint (string) -- [REQUIRED]
Redis enterprise cloud endpoint
vectorIndexName (string) -- [REQUIRED]
Name of a redis enterprise cloud index
credentialsSecretArn (string) -- [REQUIRED]
Arn of a SecretsManager Secret.
fieldMapping (dict) -- [REQUIRED]
A mapping of Bedrock Knowledge Base fields to Redis Cloud field names
vectorField (string) -- [REQUIRED]
Name of the field
textField (string) -- [REQUIRED]
Name of the field
metadataField (string) -- [REQUIRED]
Name of the field
rdsConfiguration (dict) --
Contains the configurations to use RDS to store knowledge base data.
resourceArn (string) -- [REQUIRED]
Arn of a RDS Resource.
credentialsSecretArn (string) -- [REQUIRED]
Arn of a SecretsManager Secret.
databaseName (string) -- [REQUIRED]
Name of the database within RDS
tableName (string) -- [REQUIRED]
Name of the table within RDS
fieldMapping (dict) -- [REQUIRED]
A mapping of Bedrock Knowledge Base fields to RDS column names
primaryKeyField (string) -- [REQUIRED]
Name of the column
vectorField (string) -- [REQUIRED]
Name of the column
textField (string) -- [REQUIRED]
Name of the column
metadataField (string) -- [REQUIRED]
Name of the column
dict
Response Syntax
{
    'knowledgeBase': {
        'knowledgeBaseId': 'string',
        'name': 'string',
        'knowledgeBaseArn': 'string',
        'description': 'string',
        'roleArn': 'string',
        'knowledgeBaseConfiguration': {
            'type': 'VECTOR',
            'vectorKnowledgeBaseConfiguration': {
                'embeddingModelArn': 'string'
            }
        },
        'storageConfiguration': {
            'type': 'OPENSEARCH_SERVERLESS'|'PINECONE'|'REDIS_ENTERPRISE_CLOUD'|'RDS',
            'opensearchServerlessConfiguration': {
                'collectionArn': 'string',
                'vectorIndexName': 'string',
                'fieldMapping': {
                    'vectorField': 'string',
                    'textField': 'string',
                    'metadataField': 'string'
                }
            },
            'pineconeConfiguration': {
                'connectionString': 'string',
                'credentialsSecretArn': 'string',
                'namespace': 'string',
                'fieldMapping': {
                    'textField': 'string',
                    'metadataField': 'string'
                }
            },
            'redisEnterpriseCloudConfiguration': {
                'endpoint': 'string',
                'vectorIndexName': 'string',
                'credentialsSecretArn': 'string',
                'fieldMapping': {
                    'vectorField': 'string',
                    'textField': 'string',
                    'metadataField': 'string'
                }
            },
            'rdsConfiguration': {
                'resourceArn': 'string',
                'credentialsSecretArn': 'string',
                'databaseName': 'string',
                'tableName': 'string',
                'fieldMapping': {
                    'primaryKeyField': 'string',
                    'vectorField': 'string',
                    'textField': 'string',
                    'metadataField': 'string'
                }
            }
        },
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'FAILED',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'failureReasons': [
            'string',
        ]
    }
}
Response Structure
(dict) --
knowledgeBase (dict) --
Contains the information of a knowledge base.
knowledgeBaseId (string) --
Identifier for a resource.
name (string) --
Name for a resource.
knowledgeBaseArn (string) --
ARN of a KnowledgeBase
description (string) --
Description of the Resource.
roleArn (string) --
ARN of a IAM role.
knowledgeBaseConfiguration (dict) --
Configures a bedrock knowledge base.
type (string) --
The type of a knowledge base.
vectorKnowledgeBaseConfiguration (dict) --
Configurations for a vector knowledge base.
embeddingModelArn (string) --
Arn of a Bedrock model.
storageConfiguration (dict) --
Configures the physical storage of ingested data in a knowledge base.
type (string) --
The storage type of a knowledge base.
opensearchServerlessConfiguration (dict) --
Contains the configurations to use OpenSearch Serverless to store knowledge base data.
collectionArn (string) --
Arn of an OpenSearch Serverless collection.
vectorIndexName (string) --
Arn of an OpenSearch Serverless index.
fieldMapping (dict) --
A mapping of Bedrock Knowledge Base fields to OpenSearch Serverless field names
vectorField (string) --
Name of the field
textField (string) --
Name of the field
metadataField (string) --
Name of the field
pineconeConfiguration (dict) --
Contains the configurations to use Pinecone to store knowledge base data.
connectionString (string) --
Pinecone connection string
credentialsSecretArn (string) --
Arn of a SecretsManager Secret.
namespace (string) --
Pinecone namespace
fieldMapping (dict) --
A mapping of Bedrock Knowledge Base fields to Pinecone field names
textField (string) --
Name of the field
metadataField (string) --
Name of the field
redisEnterpriseCloudConfiguration (dict) --
Contains the configurations to use Redis Enterprise Cloud to store knowledge base data.
endpoint (string) --
Redis enterprise cloud endpoint
vectorIndexName (string) --
Name of a redis enterprise cloud index
credentialsSecretArn (string) --
Arn of a SecretsManager Secret.
fieldMapping (dict) --
A mapping of Bedrock Knowledge Base fields to Redis Cloud field names
vectorField (string) --
Name of the field
textField (string) --
Name of the field
metadataField (string) --
Name of the field
rdsConfiguration (dict) --
Contains the configurations to use RDS to store knowledge base data.
resourceArn (string) --
Arn of a RDS Resource.
credentialsSecretArn (string) --
Arn of a SecretsManager Secret.
databaseName (string) --
Name of the database within RDS
tableName (string) --
Name of the table within RDS
fieldMapping (dict) --
A mapping of Bedrock Knowledge Base fields to RDS column names
primaryKeyField (string) --
Name of the column
vectorField (string) --
Name of the column
textField (string) --
Name of the column
metadataField (string) --
Name of the column
status (string) --
The status of a knowledge base.
createdAt (datetime) --
Time Stamp.
updatedAt (datetime) --
Time Stamp.
failureReasons (list) --
Failure Reasons for Error.
(string) --
Failure Reason for Error.