Struct MongoDbAtlasConfiguration 

#[non_exhaustive]
pub struct MongoDbAtlasConfiguration {
    pub endpoint: String,
    pub database_name: String,
    pub collection_name: String,
    pub vector_index_name: String,
    pub credentials_secret_arn: String,
    pub field_mapping: Option<MongoDbAtlasFieldMapping>,
    pub endpoint_service_name: Option<String>,
    pub text_index_name: Option<String>,
}

Contains details about the storage configuration of the knowledge base in MongoDB Atlas.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

endpoint: String

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

database_name: String

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

collection_name: String

The collection name of the knowledge base in MongoDB Atlas.

vector_index_name: String

The name of the MongoDB Atlas vector search index.

credentials_secret_arn: String

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

field_mapping: Option<MongoDbAtlasFieldMapping>

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

endpoint_service_name: Option<String>

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

text_index_name: Option<String>

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

Implementations

impl MongoDbAtlasConfiguration

pub fn endpoint(&self) -> &str

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

pub fn database_name(&self) -> &str

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

pub fn collection_name(&self) -> &str

The collection name of the knowledge base in MongoDB Atlas.

pub fn vector_index_name(&self) -> &str

The name of the MongoDB Atlas vector search index.

pub fn credentials_secret_arn(&self) -> &str

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

pub fn field_mapping(&self) -> Option<&MongoDbAtlasFieldMapping>

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

pub fn endpoint_service_name(&self) -> Option<&str>

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

pub fn text_index_name(&self) -> Option<&str>

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

impl MongoDbAtlasConfiguration

pub fn builder() -> MongoDbAtlasConfigurationBuilder

Creates a new builder-style object to manufacture MongoDbAtlasConfiguration.

Trait Implementations

impl Clone for MongoDbAtlasConfiguration

fn clone(&self) -> MongoDbAtlasConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MongoDbAtlasConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for MongoDbAtlasConfiguration

fn eq(&self, other: &MongoDbAtlasConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MongoDbAtlasConfiguration