Interface MongoDbAtlasConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<MongoDbAtlasConfiguration.Builder,MongoDbAtlasConfiguration>, SdkBuilder<MongoDbAtlasConfiguration.Builder,MongoDbAtlasConfiguration>, SdkPojo
Enclosing class:
MongoDbAtlasConfiguration
@Mutable @NotThreadSafe public static interface MongoDbAtlasConfiguration.Builder extends SdkPojo, CopyableBuilder<MongoDbAtlasConfiguration.Builder,MongoDbAtlasConfiguration>

  • Method Details

    • collectionName

      MongoDbAtlasConfiguration.Builder collectionName(String collectionName)

      The collection name of the knowledge base in MongoDB Atlas.

      Parameters:
      collectionName - The collection name of the knowledge base in MongoDB Atlas.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • credentialsSecretArn

      MongoDbAtlasConfiguration.Builder credentialsSecretArn(String credentialsSecretArn)

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

      Parameters:
      credentialsSecretArn - The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • databaseName

      MongoDbAtlasConfiguration.Builder databaseName(String databaseName)

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

      Parameters:
      databaseName - The database name in your MongoDB Atlas cluster for your knowledge base.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpoint

      MongoDbAtlasConfiguration.Builder endpoint(String endpoint)

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

      Parameters:
      endpoint - The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointServiceName

      MongoDbAtlasConfiguration.Builder endpointServiceName(String endpointServiceName)

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

      Parameters:
      endpointServiceName - The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldMapping

      MongoDbAtlasConfiguration.Builder fieldMapping(MongoDbAtlasFieldMapping fieldMapping)

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

      Parameters:
      fieldMapping - Contains the names of the fields to which to map information about the vector store.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • fieldMapping

      default MongoDbAtlasConfiguration.Builder fieldMapping(Consumer<MongoDbAtlasFieldMapping.Builder> fieldMapping)

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

      This is a convenience method that creates an instance of the MongoDbAtlasFieldMapping.Builder avoiding the need to create one manually via MongoDbAtlasFieldMapping.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fieldMapping(MongoDbAtlasFieldMapping).

      Parameters:
      fieldMapping - a consumer that will call methods on MongoDbAtlasFieldMapping.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • textIndexName

      MongoDbAtlasConfiguration.Builder textIndexName(String textIndexName)

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

      Parameters:
      textIndexName - The name of the text search index in the MongoDB collection. This is required for using the hybrid search feature.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vectorIndexName

      MongoDbAtlasConfiguration.Builder vectorIndexName(String vectorIndexName)

      The name of the MongoDB Atlas vector search index.

      Parameters:
      vectorIndexName - The name of the MongoDB Atlas vector search index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.