Skip to content

MongoDbAtlasConfigurationDict

Dictionary Type

MongoDbAtlasConfigurationDict

Bases: TypedDict

Dictionary form of MongoDbAtlasConfiguration.

Attributes

collection_name instance-attribute
collection_name: Required[str]

The collection name of the knowledge base in MongoDB Atlas.

credentials_secret_arn instance-attribute
credentials_secret_arn: Required[str]

The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.

database_name instance-attribute
database_name: Required[str]

The database name in your MongoDB Atlas cluster for your knowledge base.

endpoint instance-attribute
endpoint: Required[str]

The endpoint URL of your MongoDB Atlas cluster for your knowledge base.

endpoint_service_name instance-attribute
endpoint_service_name: str | None

The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.

field_mapping instance-attribute

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

text_index_name instance-attribute
text_index_name: str | None

The name of the text search index in the MongoDB collection. This is required for using the hybrid search feature.

vector_index_name instance-attribute
vector_index_name: Required[str]

The name of the MongoDB Atlas vector search index.